proca 1.7.7 → 1.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -60,12 +60,14 @@ you should also use the local proca-api in your [widget generator](https://githu
60
60
  * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
61
61
  * [`proca campaign mtt`](#proca-campaign-mtt)
62
62
  * [`proca campaign status`](#proca-campaign-status)
63
- * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-simplify)
63
+ * [`proca campaign widget get`](#proca-campaign-widget-get)
64
+ * [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
65
+ * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
64
66
  * [`proca config folder`](#proca-config-folder)
65
- * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-simplify)
67
+ * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-markdown-simplify)
66
68
  * [`proca config server`](#proca-config-server)
67
69
  * [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
68
- * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-simplify)
70
+ * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-markdown-simplify)
69
71
  * [`proca config user`](#proca-config-user)
70
72
  * [`proca contact count`](#proca-contact-count)
71
73
  * [`proca contact list [TITLE]`](#proca-contact-list-title)
@@ -75,14 +77,16 @@ you should also use the local proca-api in your [widget generator](https://githu
75
77
  * [`proca org delete`](#proca-org-delete)
76
78
  * [`proca org email`](#proca-org-email)
77
79
  * [`proca org get`](#proca-org-get)
80
+ * [`proca org user get`](#proca-org-user-get)
78
81
  * [`proca plugins`](#proca-plugins)
79
- * [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
82
+ * [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
80
83
  * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
81
- * [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
82
- * [`proca plugins:link PLUGIN`](#proca-pluginslink-plugin)
83
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
84
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
85
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
84
+ * [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
85
+ * [`proca plugins link PATH`](#proca-plugins-link-path)
86
+ * [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
87
+ * [`proca plugins reset`](#proca-plugins-reset)
88
+ * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
89
+ * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
86
90
  * [`proca plugins update`](#proca-plugins-update)
87
91
  * [`proca service add`](#proca-service-add)
88
92
  * [`proca service list`](#proca-service-list)
@@ -101,15 +105,16 @@ you should also use the local proca-api in your [widget generator](https://githu
101
105
  * [`proca widget delete`](#proca-widget-delete)
102
106
  * [`proca widget get`](#proca-widget-get)
103
107
  * [`proca widget list`](#proca-widget-list)
108
+ * [`proca widget rebuild`](#proca-widget-rebuild)
104
109
 
105
110
  ## `proca action add`
106
111
 
107
112
  ```
108
113
  USAGE
109
- $ proca action add -i <value> --firstname <value> --email <value> [--json | --human |
110
- --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin] [--action_type <value>]
111
- [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country <value>] [--utm <value>]
112
- [--target <value>] [--subject <value>] [--body <value>]
114
+ $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
115
+ [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing]
116
+ [--optin] [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>]
117
+ [--country <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
113
118
 
114
119
  FLAGS
115
120
  -i, --id=<value> (required) widget's id
@@ -136,6 +141,7 @@ OUTPUT FLAGS
136
141
  --csv Format output as csv
137
142
  --human Format output to be read on screen by a human [default]
138
143
  --json Format output as json
144
+ --markdown Format output as markdown table
139
145
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
140
146
 
141
147
  EXAMPLES
@@ -152,8 +158,8 @@ Should the supporter confirm the action? it can be set either for all the widget
152
158
 
153
159
  ```
154
160
  USAGE
155
- $ proca action confirm [--json | --human | --csv] [--env <value>] [--simplify] [--org
156
- <value>] [--campaign <value>] [--confirm] [--template <value>]
161
+ $ proca action confirm [--json | --human | --csv | --markdown] [--env <value>]
162
+ [--simplify] [--org <value>] [--campaign <value>] [--confirm] [--template <value>]
157
163
 
158
164
  FLAGS
159
165
  --campaign=<value> campaign collecting the action
@@ -166,6 +172,7 @@ OUTPUT FLAGS
166
172
  --csv Format output as csv
167
173
  --human Format output to be read on screen by a human [default]
168
174
  --json Format output as json
175
+ --markdown Format output as markdown table
169
176
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
170
177
 
171
178
  DESCRIPTION
@@ -179,8 +186,8 @@ counter of actions
179
186
 
180
187
  ```
181
188
  USAGE
182
- $ proca action count [--json | --human | --csv] [--env <value>] [--simplify] [-i
183
- <value> | -n <the_short_name> | -x <value>]
189
+ $ proca action count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
190
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
184
191
 
185
192
  FLAGS
186
193
  -i, --id=<value>
@@ -192,6 +199,7 @@ OUTPUT FLAGS
192
199
  --csv Format output as csv
193
200
  --human Format output to be read on screen by a human [default]
194
201
  --json Format output as json
202
+ --markdown Format output as markdown table
195
203
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
196
204
 
197
205
  DESCRIPTION
@@ -207,12 +215,12 @@ EXAMPLES
207
215
 
208
216
  ```
209
217
  USAGE
210
- $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
211
- <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm
212
- | --simplify] [--comment | ]
218
+ $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv |
219
+ --markdown] [--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
220
+ [--testing] [--doi] [--utm | --simplify] [--comment | ]
213
221
 
214
222
  ARGUMENTS
215
- [TITLE] name of the campaign, % for wildchar
223
+ TITLE name of the campaign, % for wildchar
216
224
 
217
225
  FLAGS
218
226
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -231,6 +239,7 @@ OUTPUT FLAGS
231
239
  --csv Format output as csv
232
240
  --human Format output to be read on screen by a human [default]
233
241
  --json Format output as json
242
+ --markdown Format output as markdown table
234
243
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
235
244
 
236
245
  EXAMPLES
@@ -241,8 +250,8 @@ EXAMPLES
241
250
 
242
251
  ```
243
252
  USAGE
244
- $ proca action replay -o <organisation name> [--json | --human | --csv] [--env <value>]
245
- [--simplify] [-c <campaign title>]
253
+ $ proca action replay -o <organisation name> [--json | --human | --csv | --markdown]
254
+ [--env <value>] [--simplify] [-c <campaign title>]
246
255
 
247
256
  FLAGS
248
257
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -253,6 +262,7 @@ OUTPUT FLAGS
253
262
  --csv Format output as csv
254
263
  --human Format output to be read on screen by a human [default]
255
264
  --json Format output as json
265
+ --markdown Format output as markdown table
256
266
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
257
267
 
258
268
  EXAMPLES
@@ -267,8 +277,8 @@ requeue actions
267
277
  USAGE
268
278
  $ proca action requeue -o <org name> -q
269
279
  CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --human |
270
- --csv] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
271
- [--testing] [--doi]
280
+ --csv | --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after
281
+ 2025-04-09] [--optin] [--testing] [--doi]
272
282
 
273
283
  FLAGS
274
284
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -288,6 +298,7 @@ OUTPUT FLAGS
288
298
  --csv Format output as csv
289
299
  --human Format output to be read on screen by a human [default]
290
300
  --json Format output as json
301
+ --markdown Format output as markdown table
291
302
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
292
303
 
293
304
  DESCRIPTION
@@ -301,11 +312,11 @@ EXAMPLES
301
312
 
302
313
  ```
303
314
  USAGE
304
- $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human |
305
- --csv] [--env <value>] [--simplify]
315
+ $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human | --csv
316
+ | --markdown] [--env <value>] [--simplify]
306
317
 
307
318
  ARGUMENTS
308
- [TITLE] title of the campaign
319
+ TITLE title of the campaign
309
320
 
310
321
  FLAGS
311
322
  -n, --name=<campaign name> (required) name of the campaign
@@ -316,6 +327,7 @@ OUTPUT FLAGS
316
327
  --csv Format output as csv
317
328
  --human Format output to be read on screen by a human [default]
318
329
  --json Format output as json
330
+ --markdown Format output as markdown table
319
331
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
320
332
 
321
333
  EXAMPLES
@@ -326,18 +338,19 @@ EXAMPLES
326
338
 
327
339
  ```
328
340
  USAGE
329
- $ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv]
330
- [--env <value>] [--simplify]
341
+ $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
342
+ --human | --csv | --markdown] [--env <value>] [--simplify]
331
343
 
332
344
  FLAGS
333
345
  --env=<value> [default: default] allow to switch between configurations (server or users)
334
- --status=<option> (required) [env: [object Object]] Status to set
346
+ --status=<option> (required) Status to set
335
347
  <options: draft|live|closed|ignored>
336
348
 
337
349
  OUTPUT FLAGS
338
350
  --csv Format output as csv
339
351
  --human Format output to be read on screen by a human [default]
340
352
  --json Format output as json
353
+ --markdown Format output as markdown table
341
354
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
342
355
 
343
356
  ALIASES
@@ -355,8 +368,8 @@ delete a campaign
355
368
 
356
369
  ```
357
370
  USAGE
358
- $ proca campaign delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
359
- <organisation name>] [-n <campaign name>]
371
+ $ proca campaign delete [--json | --human | --csv | --markdown] [--env <value>]
372
+ [--simplify] [-i <organisation name>] [-n <campaign name>]
360
373
 
361
374
  FLAGS
362
375
  -i, --id=<organisation name> id of the campaign
@@ -367,6 +380,7 @@ OUTPUT FLAGS
367
380
  --csv Format output as csv
368
381
  --human Format output to be read on screen by a human [default]
369
382
  --json Format output as json
383
+ --markdown Format output as markdown table
370
384
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
371
385
 
372
386
  DESCRIPTION
@@ -382,8 +396,8 @@ view a campaign
382
396
 
383
397
  ```
384
398
  USAGE
385
- $ proca campaign get [--json | --human | --csv] [--env <value>] [--simplify] [-i
386
- <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
399
+ $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
400
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
387
401
 
388
402
  FLAGS
389
403
  -i, --id=<value>
@@ -398,6 +412,7 @@ OUTPUT FLAGS
398
412
  --csv Format output as csv
399
413
  --human Format output to be read on screen by a human [default]
400
414
  --json Format output as json
415
+ --markdown Format output as markdown table
401
416
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
402
417
 
403
418
  DESCRIPTION
@@ -413,11 +428,11 @@ list all the campaigns
413
428
 
414
429
  ```
415
430
  USAGE
416
- $ proca campaign list [TITLE] [--json | --human | --csv] [--env <value>] [--simplify]
417
- [-o <organisation name>] [-t <campaign title>] [--stats]
431
+ $ proca campaign list [TITLE] [--json | --human | --csv | --markdown] [--env <value>]
432
+ [--simplify] [-o <organisation name>] [-t <campaign title>] [--stats]
418
433
 
419
434
  ARGUMENTS
420
- [TITLE] name of the campaign, % for wildchar
435
+ TITLE name of the campaign, % for wildchar
421
436
 
422
437
  FLAGS
423
438
  -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
@@ -429,6 +444,7 @@ OUTPUT FLAGS
429
444
  --csv Format output as csv
430
445
  --human Format output to be read on screen by a human [default]
431
446
  --json Format output as json
447
+ --markdown Format output as markdown table
432
448
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
433
449
 
434
450
  DESCRIPTION
@@ -444,9 +460,9 @@ set the mail to target (mtt) params
444
460
 
445
461
  ```
446
462
  USAGE
447
- $ proca campaign mtt [--json | --human | --csv] [--env <value>] [--simplify] [-i
448
- <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>] [--period <value>]
449
- [--email <value>] [--cc <value>] [--sender] [--drip]
463
+ $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
464
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template
465
+ <value>] [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
450
466
 
451
467
  FLAGS
452
468
  -i, --id=<value>
@@ -466,6 +482,7 @@ OUTPUT FLAGS
466
482
  --csv Format output as csv
467
483
  --human Format output to be read on screen by a human [default]
468
484
  --json Format output as json
485
+ --markdown Format output as markdown table
469
486
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
470
487
 
471
488
  DESCRIPTION
@@ -479,18 +496,19 @@ EXAMPLES
479
496
 
480
497
  ```
481
498
  USAGE
482
- $ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv]
483
- [--env <value>] [--simplify]
499
+ $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
500
+ --human | --csv | --markdown] [--env <value>] [--simplify]
484
501
 
485
502
  FLAGS
486
503
  --env=<value> [default: default] allow to switch between configurations (server or users)
487
- --status=<option> (required) [env: [object Object]] Status to set
504
+ --status=<option> (required) Status to set
488
505
  <options: draft|live|closed|ignored>
489
506
 
490
507
  OUTPUT FLAGS
491
508
  --csv Format output as csv
492
509
  --human Format output to be read on screen by a human [default]
493
510
  --json Format output as json
511
+ --markdown Format output as markdown table
494
512
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
495
513
 
496
514
  ALIASES
@@ -502,22 +520,78 @@ EXAMPLES
502
520
  $ proca campaign status -i <campaign_id>
503
521
  ```
504
522
 
505
- ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
523
+ ## `proca campaign widget get`
524
+
525
+ List widgets in a campaign
526
+
527
+ ```
528
+ USAGE
529
+ $ proca campaign widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
530
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
531
+
532
+ FLAGS
533
+ -i, --id=<value>
534
+ -n, --name=<the_short_name> name
535
+ -x, --dxid=<value> dxid
536
+ --env=<value> [default: default] allow to switch between configurations (server or users)
537
+
538
+ OUTPUT FLAGS
539
+ --csv Format output as csv
540
+ --human Format output to be read on screen by a human [default]
541
+ --json Format output as json
542
+ --markdown Format output as markdown table
543
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
544
+
545
+ DESCRIPTION
546
+ List widgets in a campaign
547
+ ```
548
+
549
+ ## `proca campaign widget rebuild`
550
+
551
+ (re)build all the widgets of a campaign
552
+
553
+ ```
554
+ USAGE
555
+ $ proca campaign widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
556
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
557
+
558
+ FLAGS
559
+ -i, --id=<value>
560
+ -n, --name=<the_short_name> name
561
+ -x, --dxid=<value> dxid
562
+ --env=<value> [default: default] allow to switch between configurations (server or users)
563
+
564
+ OUTPUT FLAGS
565
+ --csv Format output as csv
566
+ --human Format output to be read on screen by a human [default]
567
+ --json Format output as json
568
+ --markdown Format output as markdown table
569
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
570
+
571
+ DESCRIPTION
572
+ (re)build all the widgets of a campaign
573
+
574
+ EXAMPLES
575
+ $ proca-cli campaign widget rebuild climate-action
576
+ ```
577
+
578
+ ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
506
579
 
507
580
  create setting to access to a server
508
581
 
509
582
  ```
510
583
  USAGE
511
- $ proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
512
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
513
- /var/www/proca/config.example]
584
+ $ proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
585
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
586
+ you@example.org] [--folder /var/www/proca/config.example]
514
587
 
515
588
  ARGUMENTS
516
- [ENV] [default: default] allow to switch between configurations (server or users)
517
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
518
- [JSON] Format output as json
519
- [CSV] Format output as csv
520
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
589
+ ENV [default: default] allow to switch between configurations (server or users)
590
+ HUMAN [default: true] Format output to be read on screen by a human [default]
591
+ JSON Format output as json
592
+ CSV Format output as csv
593
+ MARKDOWN Format output as markdown table
594
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
521
595
 
522
596
  FLAGS
523
597
  --email=you@example.org user email on proca server
@@ -530,6 +604,7 @@ OUTPUT FLAGS
530
604
  --csv Format output as csv
531
605
  --human Format output to be read on screen by a human [default]
532
606
  --json Format output as json
607
+ --markdown Format output as markdown table
533
608
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
534
609
 
535
610
  DESCRIPTION
@@ -549,7 +624,8 @@ Check and create config folders
549
624
 
550
625
  ```
551
626
  USAGE
552
- $ proca config folder [--json | --human | --csv] [--env <value>] [--simplify]
627
+ $ proca config folder [--json | --human | --csv | --markdown] [--env <value>]
628
+ [--simplify]
553
629
 
554
630
  FLAGS
555
631
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -558,6 +634,7 @@ OUTPUT FLAGS
558
634
  --csv Format output as csv
559
635
  --human Format output to be read on screen by a human [default]
560
636
  --json Format output as json
637
+ --markdown Format output as markdown table
561
638
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
562
639
 
563
640
  DESCRIPTION
@@ -566,22 +643,23 @@ DESCRIPTION
566
643
  Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
567
644
  ```
568
645
 
569
- ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
646
+ ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
570
647
 
571
648
  create setting to access to a server
572
649
 
573
650
  ```
574
651
  USAGE
575
- $ proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
576
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
577
- /var/www/proca/config.example]
652
+ $ proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
653
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
654
+ you@example.org] [--folder /var/www/proca/config.example]
578
655
 
579
656
  ARGUMENTS
580
- [ENV] [default: default] allow to switch between configurations (server or users)
581
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
582
- [JSON] Format output as json
583
- [CSV] Format output as csv
584
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
657
+ ENV [default: default] allow to switch between configurations (server or users)
658
+ HUMAN [default: true] Format output to be read on screen by a human [default]
659
+ JSON Format output as json
660
+ CSV Format output as csv
661
+ MARKDOWN Format output as markdown table
662
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
585
663
 
586
664
  FLAGS
587
665
  --email=you@example.org user email on proca server
@@ -594,6 +672,7 @@ OUTPUT FLAGS
594
672
  --csv Format output as csv
595
673
  --human Format output to be read on screen by a human [default]
596
674
  --json Format output as json
675
+ --markdown Format output as markdown table
597
676
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
598
677
 
599
678
  DESCRIPTION
@@ -613,7 +692,8 @@ get the server config
613
692
 
614
693
  ```
615
694
  USAGE
616
- $ proca config server [--json | --human | --csv] [--env <value>] [--simplify]
695
+ $ proca config server [--json | --human | --csv | --markdown] [--env <value>]
696
+ [--simplify]
617
697
 
618
698
  FLAGS
619
699
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -622,6 +702,7 @@ OUTPUT FLAGS
622
702
  --csv Format output as csv
623
703
  --human Format output to be read on screen by a human [default]
624
704
  --json Format output as json
705
+ --markdown Format output as markdown table
625
706
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
626
707
 
627
708
  DESCRIPTION
@@ -634,12 +715,12 @@ update the setting used to authenticate to the servers and services
634
715
 
635
716
  ```
636
717
  USAGE
637
- $ proca config set [KEY] [VALUE] [--json | --human | --csv] [--env <value>]
638
- [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
718
+ $ proca config set [KEY] [VALUE] [--json | --human | --csv | --markdown] [--env
719
+ <value>] [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
639
720
 
640
721
  ARGUMENTS
641
- [KEY] variable name
642
- [VALUE] value
722
+ KEY variable name
723
+ VALUE value
643
724
 
644
725
  FLAGS
645
726
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -651,6 +732,7 @@ OUTPUT FLAGS
651
732
  --csv Format output as csv
652
733
  --human Format output to be read on screen by a human [default]
653
734
  --json Format output as json
735
+ --markdown Format output as markdown table
654
736
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
655
737
 
656
738
  DESCRIPTION
@@ -665,22 +747,23 @@ EXAMPLES
665
747
  $ proca config set VAR1 VALUE
666
748
  ```
667
749
 
668
- ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
750
+ ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
669
751
 
670
752
  create setting to access to a server
671
753
 
672
754
  ```
673
755
  USAGE
674
- $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
675
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
676
- /var/www/proca/config.example]
756
+ $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
757
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
758
+ you@example.org] [--folder /var/www/proca/config.example]
677
759
 
678
760
  ARGUMENTS
679
- [ENV] [default: default] allow to switch between configurations (server or users)
680
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
681
- [JSON] Format output as json
682
- [CSV] Format output as csv
683
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
761
+ ENV [default: default] allow to switch between configurations (server or users)
762
+ HUMAN [default: true] Format output to be read on screen by a human [default]
763
+ JSON Format output as json
764
+ CSV Format output as csv
765
+ MARKDOWN Format output as markdown table
766
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
684
767
 
685
768
  FLAGS
686
769
  --email=you@example.org user email on proca server
@@ -693,6 +776,7 @@ OUTPUT FLAGS
693
776
  --csv Format output as csv
694
777
  --human Format output to be read on screen by a human [default]
695
778
  --json Format output as json
779
+ --markdown Format output as markdown table
696
780
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
697
781
 
698
782
  DESCRIPTION
@@ -712,7 +796,8 @@ fetch the information about the current user (based on the token)
712
796
 
713
797
  ```
714
798
  USAGE
715
- $ proca config user [--json | --human | --csv] [--env <value>] [--simplify]
799
+ $ proca config user [--json | --human | --csv | --markdown] [--env <value>]
800
+ [--simplify]
716
801
 
717
802
  FLAGS
718
803
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -721,6 +806,7 @@ OUTPUT FLAGS
721
806
  --csv Format output as csv
722
807
  --human Format output to be read on screen by a human [default]
723
808
  --json Format output as json
809
+ --markdown Format output as markdown table
724
810
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
725
811
 
726
812
  DESCRIPTION
@@ -740,8 +826,8 @@ counter of supporters
740
826
 
741
827
  ```
742
828
  USAGE
743
- $ proca contact count [--json | --human | --csv] [--env <value>] [--simplify] [-i
744
- <value> | -n <the_short_name> | -x <value>]
829
+ $ proca contact count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
830
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
745
831
 
746
832
  FLAGS
747
833
  -i, --id=<value>
@@ -753,6 +839,7 @@ OUTPUT FLAGS
753
839
  --csv Format output as csv
754
840
  --human Format output to be read on screen by a human [default]
755
841
  --json Format output as json
842
+ --markdown Format output as markdown table
756
843
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
757
844
 
758
845
  DESCRIPTION
@@ -768,12 +855,12 @@ EXAMPLES
768
855
 
769
856
  ```
770
857
  USAGE
771
- $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
772
- <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
773
- --simplify] [--comment | ]
858
+ $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv |
859
+ --markdown] [--env <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing]
860
+ [--doi] [--utm | --simplify] [--comment | ]
774
861
 
775
862
  ARGUMENTS
776
- [TITLE] name of the campaign, % for wildchar
863
+ TITLE name of the campaign, % for wildchar
777
864
 
778
865
  FLAGS
779
866
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -792,6 +879,7 @@ OUTPUT FLAGS
792
879
  --csv Format output as csv
793
880
  --human Format output to be read on screen by a human [default]
794
881
  --json Format output as json
882
+ --markdown Format output as markdown table
795
883
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
796
884
 
797
885
  EXAMPLES
@@ -807,7 +895,7 @@ USAGE
807
895
  $ proca help [COMMAND...] [-n]
808
896
 
809
897
  ARGUMENTS
810
- [COMMAND...] Command to show help for.
898
+ COMMAND... Command to show help for.
811
899
 
812
900
  FLAGS
813
901
  -n, --nested-commands Include all nested commands in the output.
@@ -822,8 +910,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
822
910
 
823
911
  ```
824
912
  USAGE
825
- $ proca org add [--json | --human | --csv] [--env <value>] [--simplify] [--twitter
826
- <screen name>] [-n <org acronym/name>] [-t <org full name>]
913
+ $ proca org add [--json | --human | --csv | --markdown] [--env <value>]
914
+ [--simplify] [--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
827
915
 
828
916
  FLAGS
829
917
  -n, --name=<org acronym/name> short name of the org
@@ -835,6 +923,7 @@ OUTPUT FLAGS
835
923
  --csv Format output as csv
836
924
  --human Format output to be read on screen by a human [default]
837
925
  --json Format output as json
926
+ --markdown Format output as markdown table
838
927
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
839
928
 
840
929
  EXAMPLES
@@ -849,8 +938,8 @@ view a org crm synchroniser
849
938
 
850
939
  ```
851
940
  USAGE
852
- $ proca org crm -n <org name> [--json | --human | --csv] [--env <value>]
853
- [--simplify] [--synchronize]
941
+ $ proca org crm -n <org name> [--json | --human | --csv | --markdown] [--env
942
+ <value>] [--simplify] [--synchronize]
854
943
 
855
944
  FLAGS
856
945
  -n, --name=<org name> (required) name of the org
@@ -861,6 +950,7 @@ OUTPUT FLAGS
861
950
  --csv Format output as csv
862
951
  --human Format output to be read on screen by a human [default]
863
952
  --json Format output as json
953
+ --markdown Format output as markdown table
864
954
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
865
955
 
866
956
  DESCRIPTION
@@ -871,8 +961,8 @@ DESCRIPTION
871
961
 
872
962
  ```
873
963
  USAGE
874
- $ proca org delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
875
- <value> | -n <org name> | -x <value>]
964
+ $ proca org delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
965
+ <value>] [--simplify] [-i <value> | -n <org name> | -x <value>]
876
966
 
877
967
  FLAGS
878
968
  -i, --id=<value>
@@ -884,6 +974,7 @@ OUTPUT FLAGS
884
974
  --csv Format output as csv
885
975
  --human Format output to be read on screen by a human [default]
886
976
  --json Format output as json
977
+ --markdown Format output as markdown table
887
978
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
888
979
 
889
980
  EXAMPLES
@@ -896,8 +987,9 @@ Set service, usually email backend for an org
896
987
 
897
988
  ```
898
989
  USAGE
899
- $ proca org email --org <value> --mailer mailjet ses stripe test_stripe system
900
- preview webhook supabase smtp [--json | --human | --csv] [--env <value>] [--simplify] [--from <value>]
990
+ $ proca org email [ID_NAME_DXID] --org <value> --mailer mailjet ses stripe
991
+ test_stripe system preview webhook supabase smtp [--json | --human | --csv | --markdown] [--env <value>]
992
+ [--simplify] [--from <value>]
901
993
 
902
994
  FLAGS
903
995
  --env=<value> [default: default] allow to switch
@@ -913,6 +1005,7 @@ OUTPUT FLAGS
913
1005
  --csv Format output as csv
914
1006
  --human Format output to be read on screen by a human [default]
915
1007
  --json Format output as json
1008
+ --markdown Format output as markdown table
916
1009
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
917
1010
 
918
1011
  DESCRIPTION
@@ -925,8 +1018,8 @@ view a org
925
1018
 
926
1019
  ```
927
1020
  USAGE
928
- $ proca org get [--json | --human | --csv] [--env <value>] [--simplify] [-n <org
929
- name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
1021
+ $ proca org get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1022
+ <value>] [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
930
1023
 
931
1024
  FLAGS
932
1025
  -n, --name=<org name> name of the org
@@ -942,6 +1035,7 @@ OUTPUT FLAGS
942
1035
  --csv Format output as csv
943
1036
  --human Format output to be read on screen by a human [default]
944
1037
  --json Format output as json
1038
+ --markdown Format output as markdown table
945
1039
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
946
1040
 
947
1041
  DESCRIPTION
@@ -951,6 +1045,36 @@ EXAMPLES
951
1045
  $ proca org get <name of the ngo>
952
1046
  ```
953
1047
 
1048
+ ## `proca org user get`
1049
+
1050
+ list all the users
1051
+
1052
+ ```
1053
+ USAGE
1054
+ $ proca org user get -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1055
+ [--simplify]
1056
+
1057
+ FLAGS
1058
+ -o, --org=<value> (required) organisation
1059
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1060
+
1061
+ OUTPUT FLAGS
1062
+ --csv Format output as csv
1063
+ --human Format output to be read on screen by a human [default]
1064
+ --json Format output as json
1065
+ --markdown Format output as markdown table
1066
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1067
+
1068
+ DESCRIPTION
1069
+ list all the users
1070
+
1071
+ ALIASES
1072
+ $ proca org user get
1073
+
1074
+ EXAMPLES
1075
+ $ proca org user get %pizza%
1076
+ ```
1077
+
954
1078
  ## `proca plugins`
955
1079
 
956
1080
  List installed plugins.
@@ -972,44 +1096,53 @@ EXAMPLES
972
1096
  $ proca plugins
973
1097
  ```
974
1098
 
975
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/index.ts)_
1099
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
976
1100
 
977
- ## `proca plugins:install PLUGIN...`
1101
+ ## `proca plugins add PLUGIN`
978
1102
 
979
- Installs a plugin into the CLI.
1103
+ Installs a plugin into proca.
980
1104
 
981
1105
  ```
982
1106
  USAGE
983
- $ proca plugins add plugins:install PLUGIN...
1107
+ $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
984
1108
 
985
1109
  ARGUMENTS
986
1110
  PLUGIN... Plugin to install.
987
1111
 
988
1112
  FLAGS
989
- -f, --force Run yarn install with force flag.
1113
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
990
1114
  -h, --help Show CLI help.
991
- -v, --verbose
1115
+ -s, --silent Silences npm output.
1116
+ -v, --verbose Show verbose npm output.
1117
+
1118
+ GLOBAL FLAGS
1119
+ --json Format output as json.
992
1120
 
993
1121
  DESCRIPTION
994
- Installs a plugin into the CLI.
995
- Can be installed from npm or a git url.
1122
+ Installs a plugin into proca.
996
1123
 
997
- Installation of a user-installed plugin will override a core plugin.
1124
+ Uses npm to install plugins.
998
1125
 
999
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1000
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1001
- the CLI without the need to patch and update the whole CLI.
1126
+ Installation of a user-installed plugin will override a core plugin.
1002
1127
 
1128
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1129
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1003
1130
 
1004
1131
  ALIASES
1005
1132
  $ proca plugins add
1006
1133
 
1007
1134
  EXAMPLES
1008
- $ proca plugins:install myplugin
1135
+ Install a plugin from npm registry.
1136
+
1137
+ $ proca plugins add myplugin
1009
1138
 
1010
- $ proca plugins:install https://github.com/someuser/someplugin
1139
+ Install a plugin from a github url.
1011
1140
 
1012
- $ proca plugins:install someuser/someplugin
1141
+ $ proca plugins add https://github.com/someuser/someplugin
1142
+
1143
+ Install a plugin from a github slug.
1144
+
1145
+ $ proca plugins add someuser/someplugin
1013
1146
  ```
1014
1147
 
1015
1148
  ## `proca plugins:inspect PLUGIN...`
@@ -1034,68 +1167,79 @@ DESCRIPTION
1034
1167
  Displays installation properties of a plugin.
1035
1168
 
1036
1169
  EXAMPLES
1037
- $ proca plugins:inspect myplugin
1170
+ $ proca plugins inspect myplugin
1038
1171
  ```
1039
1172
 
1040
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/inspect.ts)_
1173
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
1041
1174
 
1042
- ## `proca plugins:install PLUGIN...`
1175
+ ## `proca plugins install PLUGIN`
1043
1176
 
1044
- Installs a plugin into the CLI.
1177
+ Installs a plugin into proca.
1045
1178
 
1046
1179
  ```
1047
1180
  USAGE
1048
- $ proca plugins install PLUGIN...
1181
+ $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
1049
1182
 
1050
1183
  ARGUMENTS
1051
1184
  PLUGIN... Plugin to install.
1052
1185
 
1053
1186
  FLAGS
1054
- -f, --force Run yarn install with force flag.
1187
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1055
1188
  -h, --help Show CLI help.
1056
- -v, --verbose
1189
+ -s, --silent Silences npm output.
1190
+ -v, --verbose Show verbose npm output.
1191
+
1192
+ GLOBAL FLAGS
1193
+ --json Format output as json.
1057
1194
 
1058
1195
  DESCRIPTION
1059
- Installs a plugin into the CLI.
1060
- Can be installed from npm or a git url.
1196
+ Installs a plugin into proca.
1061
1197
 
1062
- Installation of a user-installed plugin will override a core plugin.
1198
+ Uses npm to install plugins.
1063
1199
 
1064
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1065
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1066
- the CLI without the need to patch and update the whole CLI.
1200
+ Installation of a user-installed plugin will override a core plugin.
1067
1201
 
1202
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1203
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1068
1204
 
1069
1205
  ALIASES
1070
1206
  $ proca plugins add
1071
1207
 
1072
1208
  EXAMPLES
1073
- $ proca plugins:install myplugin
1209
+ Install a plugin from npm registry.
1074
1210
 
1075
- $ proca plugins:install https://github.com/someuser/someplugin
1211
+ $ proca plugins install myplugin
1076
1212
 
1077
- $ proca plugins:install someuser/someplugin
1213
+ Install a plugin from a github url.
1214
+
1215
+ $ proca plugins install https://github.com/someuser/someplugin
1216
+
1217
+ Install a plugin from a github slug.
1218
+
1219
+ $ proca plugins install someuser/someplugin
1078
1220
  ```
1079
1221
 
1080
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/install.ts)_
1222
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
1081
1223
 
1082
- ## `proca plugins:link PLUGIN`
1224
+ ## `proca plugins link PATH`
1083
1225
 
1084
1226
  Links a plugin into the CLI for development.
1085
1227
 
1086
1228
  ```
1087
1229
  USAGE
1088
- $ proca plugins link PLUGIN
1230
+ $ proca plugins link PATH [-h] [--install] [-v]
1089
1231
 
1090
1232
  ARGUMENTS
1091
1233
  PATH [default: .] path to plugin
1092
1234
 
1093
1235
  FLAGS
1094
- -h, --help Show CLI help.
1236
+ -h, --help Show CLI help.
1095
1237
  -v, --verbose
1238
+ --[no-]install Install dependencies after linking the plugin.
1096
1239
 
1097
1240
  DESCRIPTION
1098
1241
  Links a plugin into the CLI for development.
1242
+
1099
1243
  Installation of a linked plugin will override a user-installed or core plugin.
1100
1244
 
1101
1245
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -1103,21 +1247,21 @@ DESCRIPTION
1103
1247
 
1104
1248
 
1105
1249
  EXAMPLES
1106
- $ proca plugins:link myplugin
1250
+ $ proca plugins link myplugin
1107
1251
  ```
1108
1252
 
1109
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/link.ts)_
1253
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
1110
1254
 
1111
- ## `proca plugins:uninstall PLUGIN...`
1255
+ ## `proca plugins remove [PLUGIN]`
1112
1256
 
1113
1257
  Removes a plugin from the CLI.
1114
1258
 
1115
1259
  ```
1116
1260
  USAGE
1117
- $ proca plugins remove plugins:uninstall PLUGIN...
1261
+ $ proca plugins remove [PLUGIN...] [-h] [-v]
1118
1262
 
1119
1263
  ARGUMENTS
1120
- [PLUGIN] plugin to uninstall
1264
+ PLUGIN... plugin to uninstall
1121
1265
 
1122
1266
  FLAGS
1123
1267
  -h, --help Show CLI help.
@@ -1129,18 +1273,36 @@ DESCRIPTION
1129
1273
  ALIASES
1130
1274
  $ proca plugins unlink
1131
1275
  $ proca plugins remove
1276
+
1277
+ EXAMPLES
1278
+ $ proca plugins remove myplugin
1132
1279
  ```
1133
1280
 
1134
- ## `proca plugins:uninstall PLUGIN...`
1281
+ ## `proca plugins reset`
1282
+
1283
+ Remove all user-installed and linked plugins.
1284
+
1285
+ ```
1286
+ USAGE
1287
+ $ proca plugins reset [--hard] [--reinstall]
1288
+
1289
+ FLAGS
1290
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1291
+ --reinstall Reinstall all plugins after uninstalling.
1292
+ ```
1293
+
1294
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
1295
+
1296
+ ## `proca plugins uninstall [PLUGIN]`
1135
1297
 
1136
1298
  Removes a plugin from the CLI.
1137
1299
 
1138
1300
  ```
1139
1301
  USAGE
1140
- $ proca plugins uninstall PLUGIN...
1302
+ $ proca plugins uninstall [PLUGIN...] [-h] [-v]
1141
1303
 
1142
1304
  ARGUMENTS
1143
- [PLUGIN] plugin to uninstall
1305
+ PLUGIN... plugin to uninstall
1144
1306
 
1145
1307
  FLAGS
1146
1308
  -h, --help Show CLI help.
@@ -1152,20 +1314,23 @@ DESCRIPTION
1152
1314
  ALIASES
1153
1315
  $ proca plugins unlink
1154
1316
  $ proca plugins remove
1317
+
1318
+ EXAMPLES
1319
+ $ proca plugins uninstall myplugin
1155
1320
  ```
1156
1321
 
1157
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/uninstall.ts)_
1322
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
1158
1323
 
1159
- ## `proca plugins:uninstall PLUGIN...`
1324
+ ## `proca plugins unlink [PLUGIN]`
1160
1325
 
1161
1326
  Removes a plugin from the CLI.
1162
1327
 
1163
1328
  ```
1164
1329
  USAGE
1165
- $ proca plugins unlink plugins:uninstall PLUGIN...
1330
+ $ proca plugins unlink [PLUGIN...] [-h] [-v]
1166
1331
 
1167
1332
  ARGUMENTS
1168
- [PLUGIN] plugin to uninstall
1333
+ PLUGIN... plugin to uninstall
1169
1334
 
1170
1335
  FLAGS
1171
1336
  -h, --help Show CLI help.
@@ -1177,6 +1342,9 @@ DESCRIPTION
1177
1342
  ALIASES
1178
1343
  $ proca plugins unlink
1179
1344
  $ proca plugins remove
1345
+
1346
+ EXAMPLES
1347
+ $ proca plugins unlink myplugin
1180
1348
  ```
1181
1349
 
1182
1350
  ## `proca plugins update`
@@ -1195,7 +1363,7 @@ DESCRIPTION
1195
1363
  Update installed plugins.
1196
1364
  ```
1197
1365
 
1198
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/update.ts)_
1366
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
1199
1367
 
1200
1368
  ## `proca service add`
1201
1369
 
@@ -1204,8 +1372,8 @@ Set service, usually email backend for an org, the specific meaning of each para
1204
1372
  ```
1205
1373
  USAGE
1206
1374
  $ proca service add -o <value> --type
1207
- mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv] [--env <value>] [--simplify]
1208
- [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1375
+ mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv | --markdown] [--env <value>]
1376
+ [--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1209
1377
 
1210
1378
  FLAGS
1211
1379
  -o, --org=<value> (required) organisation running the service
@@ -1221,6 +1389,7 @@ OUTPUT FLAGS
1221
1389
  --csv Format output as csv
1222
1390
  --human Format output to be read on screen by a human [default]
1223
1391
  --json Format output as json
1392
+ --markdown Format output as markdown table
1224
1393
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1225
1394
 
1226
1395
  DESCRIPTION
@@ -1233,7 +1402,7 @@ list services set for an organisation
1233
1402
 
1234
1403
  ```
1235
1404
  USAGE
1236
- $ proca service list -o <value> [--json | --human | --csv] [--env <value>]
1405
+ $ proca service list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1237
1406
  [--simplify]
1238
1407
 
1239
1408
  FLAGS
@@ -1244,6 +1413,7 @@ OUTPUT FLAGS
1244
1413
  --csv Format output as csv
1245
1414
  --human Format output to be read on screen by a human [default]
1246
1415
  --json Format output as json
1416
+ --markdown Format output as markdown table
1247
1417
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1248
1418
 
1249
1419
  DESCRIPTION
@@ -1255,7 +1425,7 @@ DESCRIPTION
1255
1425
  ```
1256
1426
  USAGE
1257
1427
  $ proca target add -c <value> --name <value> --email <value> [--json | --human |
1258
- --csv] [--env <value>] [--simplify] [--external_id <value>]
1428
+ --csv | --markdown] [--env <value>] [--simplify] [--external_id <value>]
1259
1429
 
1260
1430
  FLAGS
1261
1431
  -c, --campaign=<value> (required) mtt campaign to add the target
@@ -1268,6 +1438,7 @@ OUTPUT FLAGS
1268
1438
  --csv Format output as csv
1269
1439
  --human Format output to be read on screen by a human [default]
1270
1440
  --json Format output as json
1441
+ --markdown Format output as markdown table
1271
1442
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1272
1443
  ```
1273
1444
 
@@ -1275,9 +1446,9 @@ OUTPUT FLAGS
1275
1446
 
1276
1447
  ```
1277
1448
  USAGE
1278
- $ proca template add -o <value> [--json | --human | --csv] [--env <value>] [--simplify]
1279
- [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s 'template:'
1280
- + type]
1449
+ $ proca template add -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1450
+ [--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
1451
+ 'template:' + type]
1281
1452
 
1282
1453
  FLAGS
1283
1454
  -l, --lang=<locale> [default: en] language
@@ -1292,6 +1463,7 @@ OUTPUT FLAGS
1292
1463
  --csv Format output as csv
1293
1464
  --human Format output to be read on screen by a human [default]
1294
1465
  --json Format output as json
1466
+ --markdown Format output as markdown table
1295
1467
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1296
1468
  ```
1297
1469
 
@@ -1301,7 +1473,7 @@ list services set for an organisation
1301
1473
 
1302
1474
  ```
1303
1475
  USAGE
1304
- $ proca template list -o <value> [--json | --human | --csv] [--env <value>]
1476
+ $ proca template list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1305
1477
  [--simplify]
1306
1478
 
1307
1479
  FLAGS
@@ -1312,6 +1484,7 @@ OUTPUT FLAGS
1312
1484
  --csv Format output as csv
1313
1485
  --human Format output to be read on screen by a human [default]
1314
1486
  --json Format output as json
1487
+ --markdown Format output as markdown table
1315
1488
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1316
1489
 
1317
1490
  DESCRIPTION
@@ -1324,8 +1497,8 @@ fetch the information about a user
1324
1497
 
1325
1498
  ```
1326
1499
  USAGE
1327
- $ proca user get [--json | --human | --csv] [--env <value>] [--simplify] [--email
1328
- <value>] [-o <org name>] [-i <value>]
1500
+ $ proca user get [--json | --human | --csv | --markdown] [--env <value>]
1501
+ [--simplify] [--email <value>] [-o <org name>] [-i <value>]
1329
1502
 
1330
1503
  FLAGS
1331
1504
  -i, --id=<value> id of the user
@@ -1337,6 +1510,7 @@ OUTPUT FLAGS
1337
1510
  --csv Format output as csv
1338
1511
  --human Format output to be read on screen by a human [default]
1339
1512
  --json Format output as json
1513
+ --markdown Format output as markdown table
1340
1514
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1341
1515
 
1342
1516
  DESCRIPTION
@@ -1352,8 +1526,8 @@ invite a user to join an organisation with a role
1352
1526
 
1353
1527
  ```
1354
1528
  USAGE
1355
- $ proca user invite -o <org name> -u <user email> [--json | --human | --csv] [--env
1356
- <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1529
+ $ proca user invite -o <org name> -u <user email> [--json | --human | --csv |
1530
+ --markdown] [--env <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1357
1531
 
1358
1532
  FLAGS
1359
1533
  -o, --org=<org name> (required) name of the org
@@ -1366,6 +1540,7 @@ OUTPUT FLAGS
1366
1540
  --csv Format output as csv
1367
1541
  --human Format output to be read on screen by a human [default]
1368
1542
  --json Format output as json
1543
+ --markdown Format output as markdown table
1369
1544
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1370
1545
 
1371
1546
  DESCRIPTION
@@ -1381,8 +1556,8 @@ let a user join an organisation with a role
1381
1556
 
1382
1557
  ```
1383
1558
  USAGE
1384
- $ proca user join -o <org name> [--json | --human | --csv] [--env <value>]
1385
- [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1559
+ $ proca user join -o <org name> [--json | --human | --csv | --markdown] [--env
1560
+ <value>] [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1386
1561
 
1387
1562
  FLAGS
1388
1563
  -o, --org=<org name> (required) name of the org
@@ -1395,6 +1570,7 @@ OUTPUT FLAGS
1395
1570
  --csv Format output as csv
1396
1571
  --human Format output to be read on screen by a human [default]
1397
1572
  --json Format output as json
1573
+ --markdown Format output as markdown table
1398
1574
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1399
1575
 
1400
1576
  DESCRIPTION
@@ -1410,8 +1586,8 @@ leave a org
1410
1586
 
1411
1587
  ```
1412
1588
  USAGE
1413
- $ proca user leave -o <org name> [--json | --human | --csv] [--env <value>]
1414
- [--simplify] [-u <user email>]
1589
+ $ proca user leave -o <org name> [--json | --human | --csv | --markdown] [--env
1590
+ <value>] [--simplify] [-u <user email>]
1415
1591
 
1416
1592
  FLAGS
1417
1593
  -o, --org=<org name> (required) name of the org
@@ -1422,6 +1598,7 @@ OUTPUT FLAGS
1422
1598
  --csv Format output as csv
1423
1599
  --human Format output to be read on screen by a human [default]
1424
1600
  --json Format output as json
1601
+ --markdown Format output as markdown table
1425
1602
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1426
1603
 
1427
1604
  DESCRIPTION
@@ -1437,7 +1614,7 @@ list all the users
1437
1614
 
1438
1615
  ```
1439
1616
  USAGE
1440
- $ proca user list -o <value> [--json | --human | --csv] [--env <value>]
1617
+ $ proca user list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1441
1618
  [--simplify]
1442
1619
 
1443
1620
  FLAGS
@@ -1448,11 +1625,15 @@ OUTPUT FLAGS
1448
1625
  --csv Format output as csv
1449
1626
  --human Format output to be read on screen by a human [default]
1450
1627
  --json Format output as json
1628
+ --markdown Format output as markdown table
1451
1629
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1452
1630
 
1453
1631
  DESCRIPTION
1454
1632
  list all the users
1455
1633
 
1634
+ ALIASES
1635
+ $ proca org user get
1636
+
1456
1637
  EXAMPLES
1457
1638
  $ proca user list %pizza%
1458
1639
  ```
@@ -1463,7 +1644,8 @@ fetch the information about the current user (based on the token)
1463
1644
 
1464
1645
  ```
1465
1646
  USAGE
1466
- $ proca user me [--json | --human | --csv] [--env <value>] [--simplify]
1647
+ $ proca user me [--json | --human | --csv | --markdown] [--env <value>]
1648
+ [--simplify]
1467
1649
 
1468
1650
  FLAGS
1469
1651
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1472,6 +1654,7 @@ OUTPUT FLAGS
1472
1654
  --csv Format output as csv
1473
1655
  --human Format output to be read on screen by a human [default]
1474
1656
  --json Format output as json
1657
+ --markdown Format output as markdown table
1475
1658
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1476
1659
 
1477
1660
  DESCRIPTION
@@ -1491,11 +1674,11 @@ Reset user API token
1491
1674
 
1492
1675
  ```
1493
1676
  USAGE
1494
- $ proca user reset [USER] [--json | --human | --csv] [--env <value>] [--simplify]
1495
- [--password <value>] [--url <value>]
1677
+ $ proca user reset [USER] [--json | --human | --csv | --markdown] [--env <value>]
1678
+ [--simplify] [--password <value>] [--url <value>]
1496
1679
 
1497
1680
  ARGUMENTS
1498
- [USER] Username (email)
1681
+ USER Username (email)
1499
1682
 
1500
1683
  FLAGS
1501
1684
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1506,6 +1689,7 @@ OUTPUT FLAGS
1506
1689
  --csv Format output as csv
1507
1690
  --human Format output to be read on screen by a human [default]
1508
1691
  --json Format output as json
1692
+ --markdown Format output as markdown table
1509
1693
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1510
1694
 
1511
1695
  DESCRIPTION
@@ -1518,7 +1702,8 @@ fetch the information about the current user (based on the token)
1518
1702
 
1519
1703
  ```
1520
1704
  USAGE
1521
- $ proca user whoami [--json | --human | --csv] [--env <value>] [--simplify]
1705
+ $ proca user whoami [--json | --human | --csv | --markdown] [--env <value>]
1706
+ [--simplify]
1522
1707
 
1523
1708
  FLAGS
1524
1709
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1527,6 +1712,7 @@ OUTPUT FLAGS
1527
1712
  --csv Format output as csv
1528
1713
  --human Format output to be read on screen by a human [default]
1529
1714
  --json Format output as json
1715
+ --markdown Format output as markdown table
1530
1716
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1531
1717
 
1532
1718
  DESCRIPTION
@@ -1544,8 +1730,8 @@ EXAMPLES
1544
1730
 
1545
1731
  ```
1546
1732
  USAGE
1547
- $ proca widget add -c <campaign name> [--json | --human | --csv] [--env <value>]
1548
- [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1733
+ $ proca widget add -c <campaign name> [--json | --human | --csv | --markdown] [--env
1734
+ <value>] [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1549
1735
 
1550
1736
  FLAGS
1551
1737
  -c, --campaign=<campaign name> (required) name of the campaign
@@ -1559,6 +1745,7 @@ OUTPUT FLAGS
1559
1745
  --csv Format output as csv
1560
1746
  --human Format output to be read on screen by a human [default]
1561
1747
  --json Format output as json
1748
+ --markdown Format output as markdown table
1562
1749
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1563
1750
  ```
1564
1751
 
@@ -1568,8 +1755,8 @@ Delete a widget
1568
1755
 
1569
1756
  ```
1570
1757
  USAGE
1571
- $ proca widget delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
1572
- <value> | -n <the_short_name> | -x <value>]
1758
+ $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1759
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1573
1760
 
1574
1761
  FLAGS
1575
1762
  -i, --id=<value>
@@ -1581,6 +1768,7 @@ OUTPUT FLAGS
1581
1768
  --csv Format output as csv
1582
1769
  --human Format output to be read on screen by a human [default]
1583
1770
  --json Format output as json
1771
+ --markdown Format output as markdown table
1584
1772
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1585
1773
 
1586
1774
  DESCRIPTION
@@ -1593,8 +1781,8 @@ view a widget
1593
1781
 
1594
1782
  ```
1595
1783
  USAGE
1596
- $ proca widget get [--json | --human | --csv] [--env <value>] [--simplify] [-i
1597
- <value> | -n <the_short_name> | -x <value>] [--config]
1784
+ $ proca widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1785
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1598
1786
 
1599
1787
  FLAGS
1600
1788
  -i, --id=<value>
@@ -1607,13 +1795,11 @@ OUTPUT FLAGS
1607
1795
  --csv Format output as csv
1608
1796
  --human Format output to be read on screen by a human [default]
1609
1797
  --json Format output as json
1798
+ --markdown Format output as markdown table
1610
1799
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1611
1800
 
1612
1801
  DESCRIPTION
1613
1802
  view a widget
1614
-
1615
- EXAMPLES
1616
- $ proca widget get <path of the widget>
1617
1803
  ```
1618
1804
 
1619
1805
  ## `proca widget list`
@@ -1622,8 +1808,8 @@ list all the widgets of an org or campaign
1622
1808
 
1623
1809
  ```
1624
1810
  USAGE
1625
- $ proca widget list [--json | --human | --csv] [--env <value>] [--simplify] [-o
1626
- <organisation name>] [-c <campaign name>] [--config]
1811
+ $ proca widget list [--json | --human | --csv | --markdown] [--env <value>]
1812
+ [--simplify] [-o <organisation name>] [-c <campaign name>] [--config]
1627
1813
 
1628
1814
  FLAGS
1629
1815
  -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
@@ -1635,6 +1821,7 @@ OUTPUT FLAGS
1635
1821
  --csv Format output as csv
1636
1822
  --human Format output to be read on screen by a human [default]
1637
1823
  --json Format output as json
1824
+ --markdown Format output as markdown table
1638
1825
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1639
1826
 
1640
1827
  DESCRIPTION
@@ -1643,4 +1830,39 @@ DESCRIPTION
1643
1830
  EXAMPLES
1644
1831
  $ proca widget list -o <organisation>
1645
1832
  ```
1833
+
1834
+ ## `proca widget rebuild`
1835
+
1836
+ (re)build a widget
1837
+
1838
+ ```
1839
+ USAGE
1840
+ $ proca widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1841
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1842
+
1843
+ FLAGS
1844
+ -i, --id=<value>
1845
+ -n, --name=<the_short_name> name
1846
+ -x, --dxid=<value> dxid
1847
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1848
+
1849
+ OUTPUT FLAGS
1850
+ --csv Format output as csv
1851
+ --human Format output to be read on screen by a human [default]
1852
+ --json Format output as json
1853
+ --markdown Format output as markdown table
1854
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1855
+
1856
+ DESCRIPTION
1857
+ (re)build a widget
1858
+
1859
+ EXAMPLES
1860
+ $ proca widget rebuild 42
1861
+
1862
+ $ proca widget rebuild climate-action/my-org/en
1863
+
1864
+ SEE ALSO:
1865
+
1866
+ $ proca campaign widget rebuild Rebuild all the widgets of a campaign
1867
+ ```
1646
1868
  <!-- commandsstop -->