proca 1.7.6 → 1.7.8

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,12 @@ 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 config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
64
64
  * [`proca config folder`](#proca-config-folder)
65
- * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-simplify)
65
+ * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-markdown-simplify)
66
66
  * [`proca config server`](#proca-config-server)
67
67
  * [`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)
68
+ * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-markdown-simplify)
69
69
  * [`proca config user`](#proca-config-user)
70
70
  * [`proca contact count`](#proca-contact-count)
71
71
  * [`proca contact list [TITLE]`](#proca-contact-list-title)
@@ -76,14 +76,13 @@ you should also use the local proca-api in your [widget generator](https://githu
76
76
  * [`proca org email`](#proca-org-email)
77
77
  * [`proca org get`](#proca-org-get)
78
78
  * [`proca plugins`](#proca-plugins)
79
- * [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
79
+ * [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
80
80
  * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
81
- * [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
82
- * [`proca plugins link PATH`](#proca-plugins-link-path)
83
- * [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
84
- * [`proca plugins reset`](#proca-plugins-reset)
85
- * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
86
- * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-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)
87
86
  * [`proca plugins update`](#proca-plugins-update)
88
87
  * [`proca service add`](#proca-service-add)
89
88
  * [`proca service list`](#proca-service-list)
@@ -107,8 +106,8 @@ you should also use the local proca-api in your [widget generator](https://githu
107
106
 
108
107
  ```
109
108
  USAGE
110
- $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
111
- [--json | --human | --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
109
+ $ proca action add -i <value> --firstname <value> --email <value> [--json | --human |
110
+ --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
112
111
  [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
113
112
  <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
114
113
 
@@ -137,6 +136,7 @@ OUTPUT FLAGS
137
136
  --csv Format output as csv
138
137
  --human Format output to be read on screen by a human [default]
139
138
  --json Format output as json
139
+ --markdown Format output as markdown table
140
140
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
141
141
 
142
142
  EXAMPLES
@@ -153,8 +153,8 @@ Should the supporter confirm the action? it can be set either for all the widget
153
153
 
154
154
  ```
155
155
  USAGE
156
- $ proca action confirm [--json | --human | --csv] [--env <value>] [--simplify] [--org
157
- <value>] [--campaign <value>] [--confirm] [--template <value>]
156
+ $ proca action confirm [--json | --human | --csv | --markdown] [--env <value>]
157
+ [--simplify] [--org <value>] [--campaign <value>] [--confirm] [--template <value>]
158
158
 
159
159
  FLAGS
160
160
  --campaign=<value> campaign collecting the action
@@ -167,6 +167,7 @@ OUTPUT FLAGS
167
167
  --csv Format output as csv
168
168
  --human Format output to be read on screen by a human [default]
169
169
  --json Format output as json
170
+ --markdown Format output as markdown table
170
171
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
171
172
 
172
173
  DESCRIPTION
@@ -180,7 +181,7 @@ counter of actions
180
181
 
181
182
  ```
182
183
  USAGE
183
- $ proca action count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
184
+ $ proca action count [--json | --human | --csv | --markdown] [--env <value>]
184
185
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
185
186
 
186
187
  FLAGS
@@ -193,6 +194,7 @@ OUTPUT FLAGS
193
194
  --csv Format output as csv
194
195
  --human Format output to be read on screen by a human [default]
195
196
  --json Format output as json
197
+ --markdown Format output as markdown table
196
198
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
197
199
 
198
200
  DESCRIPTION
@@ -208,12 +210,12 @@ EXAMPLES
208
210
 
209
211
  ```
210
212
  USAGE
211
- $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
212
- <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm
213
- | --simplify] [--comment | ]
213
+ $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv |
214
+ --markdown] [--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
215
+ [--testing] [--doi] [--utm | --simplify] [--comment | ]
214
216
 
215
217
  ARGUMENTS
216
- TITLE name of the campaign, % for wildchar
218
+ [TITLE] name of the campaign, % for wildchar
217
219
 
218
220
  FLAGS
219
221
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -232,6 +234,7 @@ OUTPUT FLAGS
232
234
  --csv Format output as csv
233
235
  --human Format output to be read on screen by a human [default]
234
236
  --json Format output as json
237
+ --markdown Format output as markdown table
235
238
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
236
239
 
237
240
  EXAMPLES
@@ -242,8 +245,8 @@ EXAMPLES
242
245
 
243
246
  ```
244
247
  USAGE
245
- $ proca action replay -o <organisation name> [--json | --human | --csv] [--env <value>]
246
- [--simplify] [-c <campaign title>]
248
+ $ proca action replay -o <organisation name> [--json | --human | --csv | --markdown]
249
+ [--env <value>] [--simplify] [-c <campaign title>]
247
250
 
248
251
  FLAGS
249
252
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -254,6 +257,7 @@ OUTPUT FLAGS
254
257
  --csv Format output as csv
255
258
  --human Format output to be read on screen by a human [default]
256
259
  --json Format output as json
260
+ --markdown Format output as markdown table
257
261
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
258
262
 
259
263
  EXAMPLES
@@ -268,8 +272,8 @@ requeue actions
268
272
  USAGE
269
273
  $ proca action requeue -o <org name> -q
270
274
  CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --human |
271
- --csv] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
272
- [--testing] [--doi]
275
+ --csv | --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after
276
+ 2025-04-09] [--optin] [--testing] [--doi]
273
277
 
274
278
  FLAGS
275
279
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -289,6 +293,7 @@ OUTPUT FLAGS
289
293
  --csv Format output as csv
290
294
  --human Format output to be read on screen by a human [default]
291
295
  --json Format output as json
296
+ --markdown Format output as markdown table
292
297
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
293
298
 
294
299
  DESCRIPTION
@@ -302,11 +307,11 @@ EXAMPLES
302
307
 
303
308
  ```
304
309
  USAGE
305
- $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human |
306
- --csv] [--env <value>] [--simplify]
310
+ $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human | --csv
311
+ | --markdown] [--env <value>] [--simplify]
307
312
 
308
313
  ARGUMENTS
309
- TITLE title of the campaign
314
+ [TITLE] title of the campaign
310
315
 
311
316
  FLAGS
312
317
  -n, --name=<campaign name> (required) name of the campaign
@@ -317,6 +322,7 @@ OUTPUT FLAGS
317
322
  --csv Format output as csv
318
323
  --human Format output to be read on screen by a human [default]
319
324
  --json Format output as json
325
+ --markdown Format output as markdown table
320
326
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
321
327
 
322
328
  EXAMPLES
@@ -327,18 +333,19 @@ EXAMPLES
327
333
 
328
334
  ```
329
335
  USAGE
330
- $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
331
- --human | --csv] [--env <value>] [--simplify]
336
+ $ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv |
337
+ --markdown] [--env <value>] [--simplify]
332
338
 
333
339
  FLAGS
334
340
  --env=<value> [default: default] allow to switch between configurations (server or users)
335
- --status=<option> (required) Status to set
341
+ --status=<option> (required) [env: [object Object]] Status to set
336
342
  <options: draft|live|closed|ignored>
337
343
 
338
344
  OUTPUT FLAGS
339
345
  --csv Format output as csv
340
346
  --human Format output to be read on screen by a human [default]
341
347
  --json Format output as json
348
+ --markdown Format output as markdown table
342
349
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
343
350
 
344
351
  ALIASES
@@ -356,8 +363,8 @@ delete a campaign
356
363
 
357
364
  ```
358
365
  USAGE
359
- $ proca campaign delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
360
- <organisation name>] [-n <campaign name>]
366
+ $ proca campaign delete [--json | --human | --csv | --markdown] [--env <value>]
367
+ [--simplify] [-i <organisation name>] [-n <campaign name>]
361
368
 
362
369
  FLAGS
363
370
  -i, --id=<organisation name> id of the campaign
@@ -368,6 +375,7 @@ OUTPUT FLAGS
368
375
  --csv Format output as csv
369
376
  --human Format output to be read on screen by a human [default]
370
377
  --json Format output as json
378
+ --markdown Format output as markdown table
371
379
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
372
380
 
373
381
  DESCRIPTION
@@ -383,7 +391,7 @@ view a campaign
383
391
 
384
392
  ```
385
393
  USAGE
386
- $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
394
+ $ proca campaign get [--json | --human | --csv | --markdown] [--env <value>]
387
395
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
388
396
 
389
397
  FLAGS
@@ -399,6 +407,7 @@ OUTPUT FLAGS
399
407
  --csv Format output as csv
400
408
  --human Format output to be read on screen by a human [default]
401
409
  --json Format output as json
410
+ --markdown Format output as markdown table
402
411
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
403
412
 
404
413
  DESCRIPTION
@@ -414,11 +423,11 @@ list all the campaigns
414
423
 
415
424
  ```
416
425
  USAGE
417
- $ proca campaign list [TITLE] [--json | --human | --csv] [--env <value>] [--simplify]
418
- [-o <organisation name>] [-t <campaign title>] [--stats]
426
+ $ proca campaign list [TITLE] [--json | --human | --csv | --markdown] [--env <value>]
427
+ [--simplify] [-o <organisation name>] [-t <campaign title>] [--stats]
419
428
 
420
429
  ARGUMENTS
421
- TITLE name of the campaign, % for wildchar
430
+ [TITLE] name of the campaign, % for wildchar
422
431
 
423
432
  FLAGS
424
433
  -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
@@ -430,6 +439,7 @@ OUTPUT FLAGS
430
439
  --csv Format output as csv
431
440
  --human Format output to be read on screen by a human [default]
432
441
  --json Format output as json
442
+ --markdown Format output as markdown table
433
443
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
434
444
 
435
445
  DESCRIPTION
@@ -445,7 +455,7 @@ set the mail to target (mtt) params
445
455
 
446
456
  ```
447
457
  USAGE
448
- $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
458
+ $ proca campaign mtt [--json | --human | --csv | --markdown] [--env <value>]
449
459
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
450
460
  [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
451
461
 
@@ -467,6 +477,7 @@ OUTPUT FLAGS
467
477
  --csv Format output as csv
468
478
  --human Format output to be read on screen by a human [default]
469
479
  --json Format output as json
480
+ --markdown Format output as markdown table
470
481
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
471
482
 
472
483
  DESCRIPTION
@@ -480,18 +491,19 @@ EXAMPLES
480
491
 
481
492
  ```
482
493
  USAGE
483
- $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
484
- --human | --csv] [--env <value>] [--simplify]
494
+ $ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv |
495
+ --markdown] [--env <value>] [--simplify]
485
496
 
486
497
  FLAGS
487
498
  --env=<value> [default: default] allow to switch between configurations (server or users)
488
- --status=<option> (required) Status to set
499
+ --status=<option> (required) [env: [object Object]] Status to set
489
500
  <options: draft|live|closed|ignored>
490
501
 
491
502
  OUTPUT FLAGS
492
503
  --csv Format output as csv
493
504
  --human Format output to be read on screen by a human [default]
494
505
  --json Format output as json
506
+ --markdown Format output as markdown table
495
507
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
496
508
 
497
509
  ALIASES
@@ -503,22 +515,23 @@ EXAMPLES
503
515
  $ proca campaign status -i <campaign_id>
504
516
  ```
505
517
 
506
- ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
518
+ ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
507
519
 
508
520
  create setting to access to a server
509
521
 
510
522
  ```
511
523
  USAGE
512
- $ proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
513
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
514
- /var/www/proca/config.example]
524
+ $ proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
525
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
526
+ you@example.org] [--folder /var/www/proca/config.example]
515
527
 
516
528
  ARGUMENTS
517
- ENV [default: default] allow to switch between configurations (server or users)
518
- HUMAN [default: true] Format output to be read on screen by a human [default]
519
- JSON Format output as json
520
- CSV Format output as csv
521
- SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
529
+ [ENV] [default: default] allow to switch between configurations (server or users)
530
+ [HUMAN] [default: true] Format output to be read on screen by a human [default]
531
+ [JSON] Format output as json
532
+ [CSV] Format output as csv
533
+ [MARKDOWN] Format output as markdown table
534
+ [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
522
535
 
523
536
  FLAGS
524
537
  --email=you@example.org user email on proca server
@@ -531,6 +544,7 @@ OUTPUT FLAGS
531
544
  --csv Format output as csv
532
545
  --human Format output to be read on screen by a human [default]
533
546
  --json Format output as json
547
+ --markdown Format output as markdown table
534
548
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
535
549
 
536
550
  DESCRIPTION
@@ -550,7 +564,8 @@ Check and create config folders
550
564
 
551
565
  ```
552
566
  USAGE
553
- $ proca config folder [--json | --human | --csv] [--env <value>] [--simplify]
567
+ $ proca config folder [--json | --human | --csv | --markdown] [--env <value>]
568
+ [--simplify]
554
569
 
555
570
  FLAGS
556
571
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -559,6 +574,7 @@ OUTPUT FLAGS
559
574
  --csv Format output as csv
560
575
  --human Format output to be read on screen by a human [default]
561
576
  --json Format output as json
577
+ --markdown Format output as markdown table
562
578
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
563
579
 
564
580
  DESCRIPTION
@@ -567,22 +583,23 @@ DESCRIPTION
567
583
  Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
568
584
  ```
569
585
 
570
- ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
586
+ ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
571
587
 
572
588
  create setting to access to a server
573
589
 
574
590
  ```
575
591
  USAGE
576
- $ proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
577
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
578
- /var/www/proca/config.example]
592
+ $ proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
593
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
594
+ you@example.org] [--folder /var/www/proca/config.example]
579
595
 
580
596
  ARGUMENTS
581
- ENV [default: default] allow to switch between configurations (server or users)
582
- HUMAN [default: true] Format output to be read on screen by a human [default]
583
- JSON Format output as json
584
- CSV Format output as csv
585
- SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
597
+ [ENV] [default: default] allow to switch between configurations (server or users)
598
+ [HUMAN] [default: true] Format output to be read on screen by a human [default]
599
+ [JSON] Format output as json
600
+ [CSV] Format output as csv
601
+ [MARKDOWN] Format output as markdown table
602
+ [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
586
603
 
587
604
  FLAGS
588
605
  --email=you@example.org user email on proca server
@@ -595,6 +612,7 @@ OUTPUT FLAGS
595
612
  --csv Format output as csv
596
613
  --human Format output to be read on screen by a human [default]
597
614
  --json Format output as json
615
+ --markdown Format output as markdown table
598
616
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
599
617
 
600
618
  DESCRIPTION
@@ -614,7 +632,8 @@ get the server config
614
632
 
615
633
  ```
616
634
  USAGE
617
- $ proca config server [--json | --human | --csv] [--env <value>] [--simplify]
635
+ $ proca config server [--json | --human | --csv | --markdown] [--env <value>]
636
+ [--simplify]
618
637
 
619
638
  FLAGS
620
639
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -623,6 +642,7 @@ OUTPUT FLAGS
623
642
  --csv Format output as csv
624
643
  --human Format output to be read on screen by a human [default]
625
644
  --json Format output as json
645
+ --markdown Format output as markdown table
626
646
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
627
647
 
628
648
  DESCRIPTION
@@ -635,12 +655,12 @@ update the setting used to authenticate to the servers and services
635
655
 
636
656
  ```
637
657
  USAGE
638
- $ proca config set [KEY] [VALUE] [--json | --human | --csv] [--env <value>]
639
- [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
658
+ $ proca config set [KEY] [VALUE] [--json | --human | --csv | --markdown] [--env
659
+ <value>] [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
640
660
 
641
661
  ARGUMENTS
642
- KEY variable name
643
- VALUE value
662
+ [KEY] variable name
663
+ [VALUE] value
644
664
 
645
665
  FLAGS
646
666
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -652,6 +672,7 @@ OUTPUT FLAGS
652
672
  --csv Format output as csv
653
673
  --human Format output to be read on screen by a human [default]
654
674
  --json Format output as json
675
+ --markdown Format output as markdown table
655
676
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
656
677
 
657
678
  DESCRIPTION
@@ -666,22 +687,23 @@ EXAMPLES
666
687
  $ proca config set VAR1 VALUE
667
688
  ```
668
689
 
669
- ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
690
+ ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
670
691
 
671
692
  create setting to access to a server
672
693
 
673
694
  ```
674
695
  USAGE
675
- $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
676
- [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
677
- /var/www/proca/config.example]
696
+ $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
697
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
698
+ you@example.org] [--folder /var/www/proca/config.example]
678
699
 
679
700
  ARGUMENTS
680
- ENV [default: default] allow to switch between configurations (server or users)
681
- HUMAN [default: true] Format output to be read on screen by a human [default]
682
- JSON Format output as json
683
- CSV Format output as csv
684
- SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
701
+ [ENV] [default: default] allow to switch between configurations (server or users)
702
+ [HUMAN] [default: true] Format output to be read on screen by a human [default]
703
+ [JSON] Format output as json
704
+ [CSV] Format output as csv
705
+ [MARKDOWN] Format output as markdown table
706
+ [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
685
707
 
686
708
  FLAGS
687
709
  --email=you@example.org user email on proca server
@@ -694,6 +716,7 @@ OUTPUT FLAGS
694
716
  --csv Format output as csv
695
717
  --human Format output to be read on screen by a human [default]
696
718
  --json Format output as json
719
+ --markdown Format output as markdown table
697
720
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
698
721
 
699
722
  DESCRIPTION
@@ -713,7 +736,8 @@ fetch the information about the current user (based on the token)
713
736
 
714
737
  ```
715
738
  USAGE
716
- $ proca config user [--json | --human | --csv] [--env <value>] [--simplify]
739
+ $ proca config user [--json | --human | --csv | --markdown] [--env <value>]
740
+ [--simplify]
717
741
 
718
742
  FLAGS
719
743
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -722,6 +746,7 @@ OUTPUT FLAGS
722
746
  --csv Format output as csv
723
747
  --human Format output to be read on screen by a human [default]
724
748
  --json Format output as json
749
+ --markdown Format output as markdown table
725
750
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
726
751
 
727
752
  DESCRIPTION
@@ -741,7 +766,7 @@ counter of supporters
741
766
 
742
767
  ```
743
768
  USAGE
744
- $ proca contact count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
769
+ $ proca contact count [--json | --human | --csv | --markdown] [--env <value>]
745
770
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
746
771
 
747
772
  FLAGS
@@ -754,6 +779,7 @@ OUTPUT FLAGS
754
779
  --csv Format output as csv
755
780
  --human Format output to be read on screen by a human [default]
756
781
  --json Format output as json
782
+ --markdown Format output as markdown table
757
783
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
758
784
 
759
785
  DESCRIPTION
@@ -769,12 +795,12 @@ EXAMPLES
769
795
 
770
796
  ```
771
797
  USAGE
772
- $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
773
- <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
774
- --simplify] [--comment | ]
798
+ $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv |
799
+ --markdown] [--env <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing]
800
+ [--doi] [--utm | --simplify] [--comment | ]
775
801
 
776
802
  ARGUMENTS
777
- TITLE name of the campaign, % for wildchar
803
+ [TITLE] name of the campaign, % for wildchar
778
804
 
779
805
  FLAGS
780
806
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -793,6 +819,7 @@ OUTPUT FLAGS
793
819
  --csv Format output as csv
794
820
  --human Format output to be read on screen by a human [default]
795
821
  --json Format output as json
822
+ --markdown Format output as markdown table
796
823
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
797
824
 
798
825
  EXAMPLES
@@ -808,7 +835,7 @@ USAGE
808
835
  $ proca help [COMMAND...] [-n]
809
836
 
810
837
  ARGUMENTS
811
- COMMAND... Command to show help for.
838
+ [COMMAND...] Command to show help for.
812
839
 
813
840
  FLAGS
814
841
  -n, --nested-commands Include all nested commands in the output.
@@ -823,8 +850,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
823
850
 
824
851
  ```
825
852
  USAGE
826
- $ proca org add [--json | --human | --csv] [--env <value>] [--simplify] [--twitter
827
- <screen name>] [-n <org acronym/name>] [-t <org full name>]
853
+ $ proca org add [--json | --human | --csv | --markdown] [--env <value>]
854
+ [--simplify] [--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
828
855
 
829
856
  FLAGS
830
857
  -n, --name=<org acronym/name> short name of the org
@@ -836,6 +863,7 @@ OUTPUT FLAGS
836
863
  --csv Format output as csv
837
864
  --human Format output to be read on screen by a human [default]
838
865
  --json Format output as json
866
+ --markdown Format output as markdown table
839
867
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
840
868
 
841
869
  EXAMPLES
@@ -850,8 +878,8 @@ view a org crm synchroniser
850
878
 
851
879
  ```
852
880
  USAGE
853
- $ proca org crm -n <org name> [--json | --human | --csv] [--env <value>]
854
- [--simplify] [--synchronize]
881
+ $ proca org crm -n <org name> [--json | --human | --csv | --markdown] [--env
882
+ <value>] [--simplify] [--synchronize]
855
883
 
856
884
  FLAGS
857
885
  -n, --name=<org name> (required) name of the org
@@ -862,6 +890,7 @@ OUTPUT FLAGS
862
890
  --csv Format output as csv
863
891
  --human Format output to be read on screen by a human [default]
864
892
  --json Format output as json
893
+ --markdown Format output as markdown table
865
894
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
866
895
 
867
896
  DESCRIPTION
@@ -872,7 +901,7 @@ DESCRIPTION
872
901
 
873
902
  ```
874
903
  USAGE
875
- $ proca org delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
904
+ $ proca org delete [--json | --human | --csv | --markdown] [--env <value>]
876
905
  [--simplify] [-i <value> | -n <org name> | -x <value>]
877
906
 
878
907
  FLAGS
@@ -885,6 +914,7 @@ OUTPUT FLAGS
885
914
  --csv Format output as csv
886
915
  --human Format output to be read on screen by a human [default]
887
916
  --json Format output as json
917
+ --markdown Format output as markdown table
888
918
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
889
919
 
890
920
  EXAMPLES
@@ -897,9 +927,8 @@ Set service, usually email backend for an org
897
927
 
898
928
  ```
899
929
  USAGE
900
- $ proca org email [ID_NAME_DXID] --org <value> --mailer mailjet ses stripe
901
- test_stripe system preview webhook supabase smtp [--json | --human | --csv] [--env <value>] [--simplify] [--from
902
- <value>]
930
+ $ proca org email --org <value> --mailer mailjet ses stripe test_stripe system
931
+ preview webhook supabase smtp [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [--from <value>]
903
932
 
904
933
  FLAGS
905
934
  --env=<value> [default: default] allow to switch
@@ -915,6 +944,7 @@ OUTPUT FLAGS
915
944
  --csv Format output as csv
916
945
  --human Format output to be read on screen by a human [default]
917
946
  --json Format output as json
947
+ --markdown Format output as markdown table
918
948
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
919
949
 
920
950
  DESCRIPTION
@@ -927,7 +957,7 @@ view a org
927
957
 
928
958
  ```
929
959
  USAGE
930
- $ proca org get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
960
+ $ proca org get [--json | --human | --csv | --markdown] [--env <value>]
931
961
  [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
932
962
 
933
963
  FLAGS
@@ -944,6 +974,7 @@ OUTPUT FLAGS
944
974
  --csv Format output as csv
945
975
  --human Format output to be read on screen by a human [default]
946
976
  --json Format output as json
977
+ --markdown Format output as markdown table
947
978
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
948
979
 
949
980
  DESCRIPTION
@@ -974,53 +1005,44 @@ EXAMPLES
974
1005
  $ proca plugins
975
1006
  ```
976
1007
 
977
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
1008
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/index.ts)_
978
1009
 
979
- ## `proca plugins add PLUGIN`
1010
+ ## `proca plugins:install PLUGIN...`
980
1011
 
981
- Installs a plugin into proca.
1012
+ Installs a plugin into the CLI.
982
1013
 
983
1014
  ```
984
1015
  USAGE
985
- $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
1016
+ $ proca plugins add plugins:install PLUGIN...
986
1017
 
987
1018
  ARGUMENTS
988
1019
  PLUGIN... Plugin to install.
989
1020
 
990
1021
  FLAGS
991
- -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1022
+ -f, --force Run yarn install with force flag.
992
1023
  -h, --help Show CLI help.
993
- -s, --silent Silences npm output.
994
- -v, --verbose Show verbose npm output.
995
-
996
- GLOBAL FLAGS
997
- --json Format output as json.
1024
+ -v, --verbose
998
1025
 
999
1026
  DESCRIPTION
1000
- Installs a plugin into proca.
1001
-
1002
- Uses npm to install plugins.
1027
+ Installs a plugin into the CLI.
1028
+ Can be installed from npm or a git url.
1003
1029
 
1004
1030
  Installation of a user-installed plugin will override a core plugin.
1005
1031
 
1006
- Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1007
- Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1032
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1033
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1034
+ the CLI without the need to patch and update the whole CLI.
1035
+
1008
1036
 
1009
1037
  ALIASES
1010
1038
  $ proca plugins add
1011
1039
 
1012
1040
  EXAMPLES
1013
- Install a plugin from npm registry.
1014
-
1015
- $ proca plugins add myplugin
1041
+ $ proca plugins:install myplugin
1016
1042
 
1017
- Install a plugin from a github url.
1043
+ $ proca plugins:install https://github.com/someuser/someplugin
1018
1044
 
1019
- $ proca plugins add https://github.com/someuser/someplugin
1020
-
1021
- Install a plugin from a github slug.
1022
-
1023
- $ proca plugins add someuser/someplugin
1045
+ $ proca plugins:install someuser/someplugin
1024
1046
  ```
1025
1047
 
1026
1048
  ## `proca plugins:inspect PLUGIN...`
@@ -1045,79 +1067,68 @@ DESCRIPTION
1045
1067
  Displays installation properties of a plugin.
1046
1068
 
1047
1069
  EXAMPLES
1048
- $ proca plugins inspect myplugin
1070
+ $ proca plugins:inspect myplugin
1049
1071
  ```
1050
1072
 
1051
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
1073
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/inspect.ts)_
1052
1074
 
1053
- ## `proca plugins install PLUGIN`
1075
+ ## `proca plugins:install PLUGIN...`
1054
1076
 
1055
- Installs a plugin into proca.
1077
+ Installs a plugin into the CLI.
1056
1078
 
1057
1079
  ```
1058
1080
  USAGE
1059
- $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
1081
+ $ proca plugins install PLUGIN...
1060
1082
 
1061
1083
  ARGUMENTS
1062
1084
  PLUGIN... Plugin to install.
1063
1085
 
1064
1086
  FLAGS
1065
- -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1087
+ -f, --force Run yarn install with force flag.
1066
1088
  -h, --help Show CLI help.
1067
- -s, --silent Silences npm output.
1068
- -v, --verbose Show verbose npm output.
1069
-
1070
- GLOBAL FLAGS
1071
- --json Format output as json.
1089
+ -v, --verbose
1072
1090
 
1073
1091
  DESCRIPTION
1074
- Installs a plugin into proca.
1075
-
1076
- Uses npm to install plugins.
1092
+ Installs a plugin into the CLI.
1093
+ Can be installed from npm or a git url.
1077
1094
 
1078
1095
  Installation of a user-installed plugin will override a core plugin.
1079
1096
 
1080
- Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1081
- Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1097
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1098
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1099
+ the CLI without the need to patch and update the whole CLI.
1100
+
1082
1101
 
1083
1102
  ALIASES
1084
1103
  $ proca plugins add
1085
1104
 
1086
1105
  EXAMPLES
1087
- Install a plugin from npm registry.
1088
-
1089
- $ proca plugins install myplugin
1090
-
1091
- Install a plugin from a github url.
1106
+ $ proca plugins:install myplugin
1092
1107
 
1093
- $ proca plugins install https://github.com/someuser/someplugin
1108
+ $ proca plugins:install https://github.com/someuser/someplugin
1094
1109
 
1095
- Install a plugin from a github slug.
1096
-
1097
- $ proca plugins install someuser/someplugin
1110
+ $ proca plugins:install someuser/someplugin
1098
1111
  ```
1099
1112
 
1100
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
1113
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/install.ts)_
1101
1114
 
1102
- ## `proca plugins link PATH`
1115
+ ## `proca plugins:link PLUGIN`
1103
1116
 
1104
1117
  Links a plugin into the CLI for development.
1105
1118
 
1106
1119
  ```
1107
1120
  USAGE
1108
- $ proca plugins link PATH [-h] [--install] [-v]
1121
+ $ proca plugins link PLUGIN
1109
1122
 
1110
1123
  ARGUMENTS
1111
1124
  PATH [default: .] path to plugin
1112
1125
 
1113
1126
  FLAGS
1114
- -h, --help Show CLI help.
1127
+ -h, --help Show CLI help.
1115
1128
  -v, --verbose
1116
- --[no-]install Install dependencies after linking the plugin.
1117
1129
 
1118
1130
  DESCRIPTION
1119
1131
  Links a plugin into the CLI for development.
1120
-
1121
1132
  Installation of a linked plugin will override a user-installed or core plugin.
1122
1133
 
1123
1134
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -1125,21 +1136,21 @@ DESCRIPTION
1125
1136
 
1126
1137
 
1127
1138
  EXAMPLES
1128
- $ proca plugins link myplugin
1139
+ $ proca plugins:link myplugin
1129
1140
  ```
1130
1141
 
1131
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
1142
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/link.ts)_
1132
1143
 
1133
- ## `proca plugins remove [PLUGIN]`
1144
+ ## `proca plugins:uninstall PLUGIN...`
1134
1145
 
1135
1146
  Removes a plugin from the CLI.
1136
1147
 
1137
1148
  ```
1138
1149
  USAGE
1139
- $ proca plugins remove [PLUGIN...] [-h] [-v]
1150
+ $ proca plugins remove plugins:uninstall PLUGIN...
1140
1151
 
1141
1152
  ARGUMENTS
1142
- PLUGIN... plugin to uninstall
1153
+ [PLUGIN] plugin to uninstall
1143
1154
 
1144
1155
  FLAGS
1145
1156
  -h, --help Show CLI help.
@@ -1151,36 +1162,18 @@ DESCRIPTION
1151
1162
  ALIASES
1152
1163
  $ proca plugins unlink
1153
1164
  $ proca plugins remove
1154
-
1155
- EXAMPLES
1156
- $ proca plugins remove myplugin
1157
- ```
1158
-
1159
- ## `proca plugins reset`
1160
-
1161
- Remove all user-installed and linked plugins.
1162
-
1163
- ```
1164
- USAGE
1165
- $ proca plugins reset [--hard] [--reinstall]
1166
-
1167
- FLAGS
1168
- --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1169
- --reinstall Reinstall all plugins after uninstalling.
1170
1165
  ```
1171
1166
 
1172
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
1173
-
1174
- ## `proca plugins uninstall [PLUGIN]`
1167
+ ## `proca plugins:uninstall PLUGIN...`
1175
1168
 
1176
1169
  Removes a plugin from the CLI.
1177
1170
 
1178
1171
  ```
1179
1172
  USAGE
1180
- $ proca plugins uninstall [PLUGIN...] [-h] [-v]
1173
+ $ proca plugins uninstall PLUGIN...
1181
1174
 
1182
1175
  ARGUMENTS
1183
- PLUGIN... plugin to uninstall
1176
+ [PLUGIN] plugin to uninstall
1184
1177
 
1185
1178
  FLAGS
1186
1179
  -h, --help Show CLI help.
@@ -1192,23 +1185,20 @@ DESCRIPTION
1192
1185
  ALIASES
1193
1186
  $ proca plugins unlink
1194
1187
  $ proca plugins remove
1195
-
1196
- EXAMPLES
1197
- $ proca plugins uninstall myplugin
1198
1188
  ```
1199
1189
 
1200
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
1190
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/uninstall.ts)_
1201
1191
 
1202
- ## `proca plugins unlink [PLUGIN]`
1192
+ ## `proca plugins:uninstall PLUGIN...`
1203
1193
 
1204
1194
  Removes a plugin from the CLI.
1205
1195
 
1206
1196
  ```
1207
1197
  USAGE
1208
- $ proca plugins unlink [PLUGIN...] [-h] [-v]
1198
+ $ proca plugins unlink plugins:uninstall PLUGIN...
1209
1199
 
1210
1200
  ARGUMENTS
1211
- PLUGIN... plugin to uninstall
1201
+ [PLUGIN] plugin to uninstall
1212
1202
 
1213
1203
  FLAGS
1214
1204
  -h, --help Show CLI help.
@@ -1220,9 +1210,6 @@ DESCRIPTION
1220
1210
  ALIASES
1221
1211
  $ proca plugins unlink
1222
1212
  $ proca plugins remove
1223
-
1224
- EXAMPLES
1225
- $ proca plugins unlink myplugin
1226
1213
  ```
1227
1214
 
1228
1215
  ## `proca plugins update`
@@ -1241,7 +1228,7 @@ DESCRIPTION
1241
1228
  Update installed plugins.
1242
1229
  ```
1243
1230
 
1244
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
1231
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/update.ts)_
1245
1232
 
1246
1233
  ## `proca service add`
1247
1234
 
@@ -1250,8 +1237,8 @@ Set service, usually email backend for an org, the specific meaning of each para
1250
1237
  ```
1251
1238
  USAGE
1252
1239
  $ proca service add -o <value> --type
1253
- mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv] [--env <value>] [--simplify]
1254
- [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1240
+ mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv | --markdown] [--env <value>]
1241
+ [--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1255
1242
 
1256
1243
  FLAGS
1257
1244
  -o, --org=<value> (required) organisation running the service
@@ -1267,6 +1254,7 @@ OUTPUT FLAGS
1267
1254
  --csv Format output as csv
1268
1255
  --human Format output to be read on screen by a human [default]
1269
1256
  --json Format output as json
1257
+ --markdown Format output as markdown table
1270
1258
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1271
1259
 
1272
1260
  DESCRIPTION
@@ -1279,7 +1267,7 @@ list services set for an organisation
1279
1267
 
1280
1268
  ```
1281
1269
  USAGE
1282
- $ proca service list -o <value> [--json | --human | --csv] [--env <value>]
1270
+ $ proca service list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1283
1271
  [--simplify]
1284
1272
 
1285
1273
  FLAGS
@@ -1290,6 +1278,7 @@ OUTPUT FLAGS
1290
1278
  --csv Format output as csv
1291
1279
  --human Format output to be read on screen by a human [default]
1292
1280
  --json Format output as json
1281
+ --markdown Format output as markdown table
1293
1282
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1294
1283
 
1295
1284
  DESCRIPTION
@@ -1301,7 +1290,7 @@ DESCRIPTION
1301
1290
  ```
1302
1291
  USAGE
1303
1292
  $ proca target add -c <value> --name <value> --email <value> [--json | --human |
1304
- --csv] [--env <value>] [--simplify] [--external_id <value>]
1293
+ --csv | --markdown] [--env <value>] [--simplify] [--external_id <value>]
1305
1294
 
1306
1295
  FLAGS
1307
1296
  -c, --campaign=<value> (required) mtt campaign to add the target
@@ -1314,6 +1303,7 @@ OUTPUT FLAGS
1314
1303
  --csv Format output as csv
1315
1304
  --human Format output to be read on screen by a human [default]
1316
1305
  --json Format output as json
1306
+ --markdown Format output as markdown table
1317
1307
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1318
1308
  ```
1319
1309
 
@@ -1321,9 +1311,9 @@ OUTPUT FLAGS
1321
1311
 
1322
1312
  ```
1323
1313
  USAGE
1324
- $ proca template add -o <value> [--json | --human | --csv] [--env <value>] [--simplify]
1325
- [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s 'template:'
1326
- + type]
1314
+ $ proca template add -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1315
+ [--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
1316
+ 'template:' + type]
1327
1317
 
1328
1318
  FLAGS
1329
1319
  -l, --lang=<locale> [default: en] language
@@ -1338,6 +1328,7 @@ OUTPUT FLAGS
1338
1328
  --csv Format output as csv
1339
1329
  --human Format output to be read on screen by a human [default]
1340
1330
  --json Format output as json
1331
+ --markdown Format output as markdown table
1341
1332
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1342
1333
  ```
1343
1334
 
@@ -1347,7 +1338,7 @@ list services set for an organisation
1347
1338
 
1348
1339
  ```
1349
1340
  USAGE
1350
- $ proca template list -o <value> [--json | --human | --csv] [--env <value>]
1341
+ $ proca template list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1351
1342
  [--simplify]
1352
1343
 
1353
1344
  FLAGS
@@ -1358,6 +1349,7 @@ OUTPUT FLAGS
1358
1349
  --csv Format output as csv
1359
1350
  --human Format output to be read on screen by a human [default]
1360
1351
  --json Format output as json
1352
+ --markdown Format output as markdown table
1361
1353
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1362
1354
 
1363
1355
  DESCRIPTION
@@ -1370,8 +1362,8 @@ fetch the information about a user
1370
1362
 
1371
1363
  ```
1372
1364
  USAGE
1373
- $ proca user get [--json | --human | --csv] [--env <value>] [--simplify] [--email
1374
- <value>] [-o <org name>] [-i <value>]
1365
+ $ proca user get [--json | --human | --csv | --markdown] [--env <value>]
1366
+ [--simplify] [--email <value>] [-o <org name>] [-i <value>]
1375
1367
 
1376
1368
  FLAGS
1377
1369
  -i, --id=<value> id of the user
@@ -1383,6 +1375,7 @@ OUTPUT FLAGS
1383
1375
  --csv Format output as csv
1384
1376
  --human Format output to be read on screen by a human [default]
1385
1377
  --json Format output as json
1378
+ --markdown Format output as markdown table
1386
1379
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1387
1380
 
1388
1381
  DESCRIPTION
@@ -1398,8 +1391,8 @@ invite a user to join an organisation with a role
1398
1391
 
1399
1392
  ```
1400
1393
  USAGE
1401
- $ proca user invite -o <org name> -u <user email> [--json | --human | --csv] [--env
1402
- <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1394
+ $ proca user invite -o <org name> -u <user email> [--json | --human | --csv |
1395
+ --markdown] [--env <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1403
1396
 
1404
1397
  FLAGS
1405
1398
  -o, --org=<org name> (required) name of the org
@@ -1412,6 +1405,7 @@ OUTPUT FLAGS
1412
1405
  --csv Format output as csv
1413
1406
  --human Format output to be read on screen by a human [default]
1414
1407
  --json Format output as json
1408
+ --markdown Format output as markdown table
1415
1409
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1416
1410
 
1417
1411
  DESCRIPTION
@@ -1427,8 +1421,8 @@ let a user join an organisation with a role
1427
1421
 
1428
1422
  ```
1429
1423
  USAGE
1430
- $ proca user join -o <org name> [--json | --human | --csv] [--env <value>]
1431
- [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1424
+ $ proca user join -o <org name> [--json | --human | --csv | --markdown] [--env
1425
+ <value>] [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1432
1426
 
1433
1427
  FLAGS
1434
1428
  -o, --org=<org name> (required) name of the org
@@ -1441,6 +1435,7 @@ OUTPUT FLAGS
1441
1435
  --csv Format output as csv
1442
1436
  --human Format output to be read on screen by a human [default]
1443
1437
  --json Format output as json
1438
+ --markdown Format output as markdown table
1444
1439
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1445
1440
 
1446
1441
  DESCRIPTION
@@ -1456,8 +1451,8 @@ leave a org
1456
1451
 
1457
1452
  ```
1458
1453
  USAGE
1459
- $ proca user leave -o <org name> [--json | --human | --csv] [--env <value>]
1460
- [--simplify] [-u <user email>]
1454
+ $ proca user leave -o <org name> [--json | --human | --csv | --markdown] [--env
1455
+ <value>] [--simplify] [-u <user email>]
1461
1456
 
1462
1457
  FLAGS
1463
1458
  -o, --org=<org name> (required) name of the org
@@ -1468,6 +1463,7 @@ OUTPUT FLAGS
1468
1463
  --csv Format output as csv
1469
1464
  --human Format output to be read on screen by a human [default]
1470
1465
  --json Format output as json
1466
+ --markdown Format output as markdown table
1471
1467
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1472
1468
 
1473
1469
  DESCRIPTION
@@ -1483,7 +1479,7 @@ list all the users
1483
1479
 
1484
1480
  ```
1485
1481
  USAGE
1486
- $ proca user list -o <value> [--json | --human | --csv] [--env <value>]
1482
+ $ proca user list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1487
1483
  [--simplify]
1488
1484
 
1489
1485
  FLAGS
@@ -1494,6 +1490,7 @@ OUTPUT FLAGS
1494
1490
  --csv Format output as csv
1495
1491
  --human Format output to be read on screen by a human [default]
1496
1492
  --json Format output as json
1493
+ --markdown Format output as markdown table
1497
1494
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1498
1495
 
1499
1496
  DESCRIPTION
@@ -1509,7 +1506,8 @@ fetch the information about the current user (based on the token)
1509
1506
 
1510
1507
  ```
1511
1508
  USAGE
1512
- $ proca user me [--json | --human | --csv] [--env <value>] [--simplify]
1509
+ $ proca user me [--json | --human | --csv | --markdown] [--env <value>]
1510
+ [--simplify]
1513
1511
 
1514
1512
  FLAGS
1515
1513
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1518,6 +1516,7 @@ OUTPUT FLAGS
1518
1516
  --csv Format output as csv
1519
1517
  --human Format output to be read on screen by a human [default]
1520
1518
  --json Format output as json
1519
+ --markdown Format output as markdown table
1521
1520
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1522
1521
 
1523
1522
  DESCRIPTION
@@ -1537,11 +1536,11 @@ Reset user API token
1537
1536
 
1538
1537
  ```
1539
1538
  USAGE
1540
- $ proca user reset [USER] [--json | --human | --csv] [--env <value>] [--simplify]
1541
- [--password <value>] [--url <value>]
1539
+ $ proca user reset [USER] [--json | --human | --csv | --markdown] [--env <value>]
1540
+ [--simplify] [--password <value>] [--url <value>]
1542
1541
 
1543
1542
  ARGUMENTS
1544
- USER Username (email)
1543
+ [USER] Username (email)
1545
1544
 
1546
1545
  FLAGS
1547
1546
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1552,6 +1551,7 @@ OUTPUT FLAGS
1552
1551
  --csv Format output as csv
1553
1552
  --human Format output to be read on screen by a human [default]
1554
1553
  --json Format output as json
1554
+ --markdown Format output as markdown table
1555
1555
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1556
1556
 
1557
1557
  DESCRIPTION
@@ -1564,7 +1564,8 @@ fetch the information about the current user (based on the token)
1564
1564
 
1565
1565
  ```
1566
1566
  USAGE
1567
- $ proca user whoami [--json | --human | --csv] [--env <value>] [--simplify]
1567
+ $ proca user whoami [--json | --human | --csv | --markdown] [--env <value>]
1568
+ [--simplify]
1568
1569
 
1569
1570
  FLAGS
1570
1571
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1573,6 +1574,7 @@ OUTPUT FLAGS
1573
1574
  --csv Format output as csv
1574
1575
  --human Format output to be read on screen by a human [default]
1575
1576
  --json Format output as json
1577
+ --markdown Format output as markdown table
1576
1578
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1577
1579
 
1578
1580
  DESCRIPTION
@@ -1590,8 +1592,8 @@ EXAMPLES
1590
1592
 
1591
1593
  ```
1592
1594
  USAGE
1593
- $ proca widget add -c <campaign name> [--json | --human | --csv] [--env <value>]
1594
- [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1595
+ $ proca widget add -c <campaign name> [--json | --human | --csv | --markdown] [--env
1596
+ <value>] [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1595
1597
 
1596
1598
  FLAGS
1597
1599
  -c, --campaign=<campaign name> (required) name of the campaign
@@ -1605,6 +1607,7 @@ OUTPUT FLAGS
1605
1607
  --csv Format output as csv
1606
1608
  --human Format output to be read on screen by a human [default]
1607
1609
  --json Format output as json
1610
+ --markdown Format output as markdown table
1608
1611
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1609
1612
  ```
1610
1613
 
@@ -1614,7 +1617,7 @@ Delete a widget
1614
1617
 
1615
1618
  ```
1616
1619
  USAGE
1617
- $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
1620
+ $ proca widget delete [--json | --human | --csv | --markdown] [--env <value>]
1618
1621
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1619
1622
 
1620
1623
  FLAGS
@@ -1627,6 +1630,7 @@ OUTPUT FLAGS
1627
1630
  --csv Format output as csv
1628
1631
  --human Format output to be read on screen by a human [default]
1629
1632
  --json Format output as json
1633
+ --markdown Format output as markdown table
1630
1634
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1631
1635
 
1632
1636
  DESCRIPTION
@@ -1639,7 +1643,7 @@ view a widget
1639
1643
 
1640
1644
  ```
1641
1645
  USAGE
1642
- $ proca widget get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
1646
+ $ proca widget get [--json | --human | --csv | --markdown] [--env <value>]
1643
1647
  [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1644
1648
 
1645
1649
  FLAGS
@@ -1653,6 +1657,7 @@ OUTPUT FLAGS
1653
1657
  --csv Format output as csv
1654
1658
  --human Format output to be read on screen by a human [default]
1655
1659
  --json Format output as json
1660
+ --markdown Format output as markdown table
1656
1661
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1657
1662
 
1658
1663
  DESCRIPTION
@@ -1668,8 +1673,8 @@ list all the widgets of an org or campaign
1668
1673
 
1669
1674
  ```
1670
1675
  USAGE
1671
- $ proca widget list [--json | --human | --csv] [--env <value>] [--simplify] [-o
1672
- <organisation name>] [-c <campaign name>] [--config]
1676
+ $ proca widget list [--json | --human | --csv | --markdown] [--env <value>]
1677
+ [--simplify] [-o <organisation name>] [-c <campaign name>] [--config]
1673
1678
 
1674
1679
  FLAGS
1675
1680
  -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
@@ -1681,6 +1686,7 @@ OUTPUT FLAGS
1681
1686
  --csv Format output as csv
1682
1687
  --human Format output to be read on screen by a human [default]
1683
1688
  --json Format output as json
1689
+ --markdown Format output as markdown table
1684
1690
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1685
1691
 
1686
1692
  DESCRIPTION