proca 1.7.7 → 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 +144 -92
- package/package.json +1 -1
- package/src/commands/user/list.mjs +8 -2
- package/src/procaCommand.mjs +282 -240
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)
|
|
@@ -107,9 +107,9 @@ you should also use the local proca-api in your [widget generator](https://githu
|
|
|
107
107
|
```
|
|
108
108
|
USAGE
|
|
109
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]
|
|
111
|
-
[--
|
|
112
|
-
[--target <value>] [--subject <value>] [--body <value>]
|
|
110
|
+
--csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
|
|
111
|
+
[--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
|
|
112
|
+
<value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
|
|
113
113
|
|
|
114
114
|
FLAGS
|
|
115
115
|
-i, --id=<value> (required) widget's id
|
|
@@ -136,6 +136,7 @@ OUTPUT FLAGS
|
|
|
136
136
|
--csv Format output as csv
|
|
137
137
|
--human Format output to be read on screen by a human [default]
|
|
138
138
|
--json Format output as json
|
|
139
|
+
--markdown Format output as markdown table
|
|
139
140
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
140
141
|
|
|
141
142
|
EXAMPLES
|
|
@@ -152,8 +153,8 @@ Should the supporter confirm the action? it can be set either for all the widget
|
|
|
152
153
|
|
|
153
154
|
```
|
|
154
155
|
USAGE
|
|
155
|
-
$ proca action confirm [--json | --human | --csv] [--env <value>]
|
|
156
|
-
<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>]
|
|
157
158
|
|
|
158
159
|
FLAGS
|
|
159
160
|
--campaign=<value> campaign collecting the action
|
|
@@ -166,6 +167,7 @@ OUTPUT FLAGS
|
|
|
166
167
|
--csv Format output as csv
|
|
167
168
|
--human Format output to be read on screen by a human [default]
|
|
168
169
|
--json Format output as json
|
|
170
|
+
--markdown Format output as markdown table
|
|
169
171
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
170
172
|
|
|
171
173
|
DESCRIPTION
|
|
@@ -179,8 +181,8 @@ counter of actions
|
|
|
179
181
|
|
|
180
182
|
```
|
|
181
183
|
USAGE
|
|
182
|
-
$ proca action count [--json | --human | --csv] [--env <value>]
|
|
183
|
-
<value> | -n <the_short_name> | -x <value>]
|
|
184
|
+
$ proca action count [--json | --human | --csv | --markdown] [--env <value>]
|
|
185
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
184
186
|
|
|
185
187
|
FLAGS
|
|
186
188
|
-i, --id=<value>
|
|
@@ -192,6 +194,7 @@ OUTPUT FLAGS
|
|
|
192
194
|
--csv Format output as csv
|
|
193
195
|
--human Format output to be read on screen by a human [default]
|
|
194
196
|
--json Format output as json
|
|
197
|
+
--markdown Format output as markdown table
|
|
195
198
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
196
199
|
|
|
197
200
|
DESCRIPTION
|
|
@@ -207,9 +210,9 @@ EXAMPLES
|
|
|
207
210
|
|
|
208
211
|
```
|
|
209
212
|
USAGE
|
|
210
|
-
$ proca action list [TITLE] -o <organisation name> [--json | --human | --csv
|
|
211
|
-
<value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
|
|
212
|
-
| --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 | ]
|
|
213
216
|
|
|
214
217
|
ARGUMENTS
|
|
215
218
|
[TITLE] name of the campaign, % for wildchar
|
|
@@ -231,6 +234,7 @@ OUTPUT FLAGS
|
|
|
231
234
|
--csv Format output as csv
|
|
232
235
|
--human Format output to be read on screen by a human [default]
|
|
233
236
|
--json Format output as json
|
|
237
|
+
--markdown Format output as markdown table
|
|
234
238
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
235
239
|
|
|
236
240
|
EXAMPLES
|
|
@@ -241,8 +245,8 @@ EXAMPLES
|
|
|
241
245
|
|
|
242
246
|
```
|
|
243
247
|
USAGE
|
|
244
|
-
$ proca action replay -o <organisation name> [--json | --human | --csv
|
|
245
|
-
[--simplify] [-c <campaign title>]
|
|
248
|
+
$ proca action replay -o <organisation name> [--json | --human | --csv | --markdown]
|
|
249
|
+
[--env <value>] [--simplify] [-c <campaign title>]
|
|
246
250
|
|
|
247
251
|
FLAGS
|
|
248
252
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
@@ -253,6 +257,7 @@ OUTPUT FLAGS
|
|
|
253
257
|
--csv Format output as csv
|
|
254
258
|
--human Format output to be read on screen by a human [default]
|
|
255
259
|
--json Format output as json
|
|
260
|
+
--markdown Format output as markdown table
|
|
256
261
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
257
262
|
|
|
258
263
|
EXAMPLES
|
|
@@ -267,8 +272,8 @@ requeue actions
|
|
|
267
272
|
USAGE
|
|
268
273
|
$ proca action requeue -o <org name> -q
|
|
269
274
|
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
|
|
271
|
-
[--testing] [--doi]
|
|
275
|
+
--csv | --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after
|
|
276
|
+
2025-04-09] [--optin] [--testing] [--doi]
|
|
272
277
|
|
|
273
278
|
FLAGS
|
|
274
279
|
-c, --campaign=<campaign name> name of the campaign, % for wildchar
|
|
@@ -288,6 +293,7 @@ OUTPUT FLAGS
|
|
|
288
293
|
--csv Format output as csv
|
|
289
294
|
--human Format output to be read on screen by a human [default]
|
|
290
295
|
--json Format output as json
|
|
296
|
+
--markdown Format output as markdown table
|
|
291
297
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
292
298
|
|
|
293
299
|
DESCRIPTION
|
|
@@ -301,8 +307,8 @@ EXAMPLES
|
|
|
301
307
|
|
|
302
308
|
```
|
|
303
309
|
USAGE
|
|
304
|
-
$ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human |
|
|
305
|
-
--
|
|
310
|
+
$ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human | --csv
|
|
311
|
+
| --markdown] [--env <value>] [--simplify]
|
|
306
312
|
|
|
307
313
|
ARGUMENTS
|
|
308
314
|
[TITLE] title of the campaign
|
|
@@ -316,6 +322,7 @@ OUTPUT FLAGS
|
|
|
316
322
|
--csv Format output as csv
|
|
317
323
|
--human Format output to be read on screen by a human [default]
|
|
318
324
|
--json Format output as json
|
|
325
|
+
--markdown Format output as markdown table
|
|
319
326
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
320
327
|
|
|
321
328
|
EXAMPLES
|
|
@@ -326,8 +333,8 @@ EXAMPLES
|
|
|
326
333
|
|
|
327
334
|
```
|
|
328
335
|
USAGE
|
|
329
|
-
$ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv
|
|
330
|
-
[--env <value>] [--simplify]
|
|
336
|
+
$ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv |
|
|
337
|
+
--markdown] [--env <value>] [--simplify]
|
|
331
338
|
|
|
332
339
|
FLAGS
|
|
333
340
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -338,6 +345,7 @@ OUTPUT FLAGS
|
|
|
338
345
|
--csv Format output as csv
|
|
339
346
|
--human Format output to be read on screen by a human [default]
|
|
340
347
|
--json Format output as json
|
|
348
|
+
--markdown Format output as markdown table
|
|
341
349
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
342
350
|
|
|
343
351
|
ALIASES
|
|
@@ -355,8 +363,8 @@ delete a campaign
|
|
|
355
363
|
|
|
356
364
|
```
|
|
357
365
|
USAGE
|
|
358
|
-
$ proca campaign delete [--json | --human | --csv] [--env <value>]
|
|
359
|
-
<organisation name>] [-n <campaign name>]
|
|
366
|
+
$ proca campaign delete [--json | --human | --csv | --markdown] [--env <value>]
|
|
367
|
+
[--simplify] [-i <organisation name>] [-n <campaign name>]
|
|
360
368
|
|
|
361
369
|
FLAGS
|
|
362
370
|
-i, --id=<organisation name> id of the campaign
|
|
@@ -367,6 +375,7 @@ OUTPUT FLAGS
|
|
|
367
375
|
--csv Format output as csv
|
|
368
376
|
--human Format output to be read on screen by a human [default]
|
|
369
377
|
--json Format output as json
|
|
378
|
+
--markdown Format output as markdown table
|
|
370
379
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
371
380
|
|
|
372
381
|
DESCRIPTION
|
|
@@ -382,8 +391,8 @@ view a campaign
|
|
|
382
391
|
|
|
383
392
|
```
|
|
384
393
|
USAGE
|
|
385
|
-
$ proca campaign get [--json | --human | --csv] [--env <value>]
|
|
386
|
-
<value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
|
|
394
|
+
$ proca campaign get [--json | --human | --csv | --markdown] [--env <value>]
|
|
395
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
|
|
387
396
|
|
|
388
397
|
FLAGS
|
|
389
398
|
-i, --id=<value>
|
|
@@ -398,6 +407,7 @@ OUTPUT FLAGS
|
|
|
398
407
|
--csv Format output as csv
|
|
399
408
|
--human Format output to be read on screen by a human [default]
|
|
400
409
|
--json Format output as json
|
|
410
|
+
--markdown Format output as markdown table
|
|
401
411
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
402
412
|
|
|
403
413
|
DESCRIPTION
|
|
@@ -413,8 +423,8 @@ list all the campaigns
|
|
|
413
423
|
|
|
414
424
|
```
|
|
415
425
|
USAGE
|
|
416
|
-
$ proca campaign list [TITLE] [--json | --human | --csv] [--env <value>]
|
|
417
|
-
[-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]
|
|
418
428
|
|
|
419
429
|
ARGUMENTS
|
|
420
430
|
[TITLE] name of the campaign, % for wildchar
|
|
@@ -429,6 +439,7 @@ OUTPUT FLAGS
|
|
|
429
439
|
--csv Format output as csv
|
|
430
440
|
--human Format output to be read on screen by a human [default]
|
|
431
441
|
--json Format output as json
|
|
442
|
+
--markdown Format output as markdown table
|
|
432
443
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
433
444
|
|
|
434
445
|
DESCRIPTION
|
|
@@ -444,9 +455,9 @@ set the mail to target (mtt) params
|
|
|
444
455
|
|
|
445
456
|
```
|
|
446
457
|
USAGE
|
|
447
|
-
$ proca campaign mtt [--json | --human | --csv] [--env <value>]
|
|
448
|
-
<value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
|
|
449
|
-
[--email <value>] [--cc <value>] [--sender] [--drip]
|
|
458
|
+
$ proca campaign mtt [--json | --human | --csv | --markdown] [--env <value>]
|
|
459
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
|
|
460
|
+
[--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
|
|
450
461
|
|
|
451
462
|
FLAGS
|
|
452
463
|
-i, --id=<value>
|
|
@@ -466,6 +477,7 @@ OUTPUT FLAGS
|
|
|
466
477
|
--csv Format output as csv
|
|
467
478
|
--human Format output to be read on screen by a human [default]
|
|
468
479
|
--json Format output as json
|
|
480
|
+
--markdown Format output as markdown table
|
|
469
481
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
470
482
|
|
|
471
483
|
DESCRIPTION
|
|
@@ -479,8 +491,8 @@ EXAMPLES
|
|
|
479
491
|
|
|
480
492
|
```
|
|
481
493
|
USAGE
|
|
482
|
-
$ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv
|
|
483
|
-
[--env <value>] [--simplify]
|
|
494
|
+
$ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv |
|
|
495
|
+
--markdown] [--env <value>] [--simplify]
|
|
484
496
|
|
|
485
497
|
FLAGS
|
|
486
498
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -491,6 +503,7 @@ OUTPUT FLAGS
|
|
|
491
503
|
--csv Format output as csv
|
|
492
504
|
--human Format output to be read on screen by a human [default]
|
|
493
505
|
--json Format output as json
|
|
506
|
+
--markdown Format output as markdown table
|
|
494
507
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
495
508
|
|
|
496
509
|
ALIASES
|
|
@@ -502,21 +515,22 @@ EXAMPLES
|
|
|
502
515
|
$ proca campaign status -i <campaign_id>
|
|
503
516
|
```
|
|
504
517
|
|
|
505
|
-
## `proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
|
|
518
|
+
## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
506
519
|
|
|
507
520
|
create setting to access to a server
|
|
508
521
|
|
|
509
522
|
```
|
|
510
523
|
USAGE
|
|
511
|
-
$ proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human
|
|
512
|
-
[--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
513
|
-
/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]
|
|
514
527
|
|
|
515
528
|
ARGUMENTS
|
|
516
529
|
[ENV] [default: default] allow to switch between configurations (server or users)
|
|
517
530
|
[HUMAN] [default: true] Format output to be read on screen by a human [default]
|
|
518
531
|
[JSON] Format output as json
|
|
519
532
|
[CSV] Format output as csv
|
|
533
|
+
[MARKDOWN] Format output as markdown table
|
|
520
534
|
[SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
|
|
521
535
|
|
|
522
536
|
FLAGS
|
|
@@ -530,6 +544,7 @@ OUTPUT FLAGS
|
|
|
530
544
|
--csv Format output as csv
|
|
531
545
|
--human Format output to be read on screen by a human [default]
|
|
532
546
|
--json Format output as json
|
|
547
|
+
--markdown Format output as markdown table
|
|
533
548
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
534
549
|
|
|
535
550
|
DESCRIPTION
|
|
@@ -549,7 +564,8 @@ Check and create config folders
|
|
|
549
564
|
|
|
550
565
|
```
|
|
551
566
|
USAGE
|
|
552
|
-
$ proca config folder [--json | --human | --csv] [--env <value>]
|
|
567
|
+
$ proca config folder [--json | --human | --csv | --markdown] [--env <value>]
|
|
568
|
+
[--simplify]
|
|
553
569
|
|
|
554
570
|
FLAGS
|
|
555
571
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -558,6 +574,7 @@ OUTPUT FLAGS
|
|
|
558
574
|
--csv Format output as csv
|
|
559
575
|
--human Format output to be read on screen by a human [default]
|
|
560
576
|
--json Format output as json
|
|
577
|
+
--markdown Format output as markdown table
|
|
561
578
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
562
579
|
|
|
563
580
|
DESCRIPTION
|
|
@@ -566,21 +583,22 @@ DESCRIPTION
|
|
|
566
583
|
Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
|
|
567
584
|
```
|
|
568
585
|
|
|
569
|
-
## `proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
|
|
586
|
+
## `proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
570
587
|
|
|
571
588
|
create setting to access to a server
|
|
572
589
|
|
|
573
590
|
```
|
|
574
591
|
USAGE
|
|
575
|
-
$ proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human
|
|
576
|
-
[--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
577
|
-
/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]
|
|
578
595
|
|
|
579
596
|
ARGUMENTS
|
|
580
597
|
[ENV] [default: default] allow to switch between configurations (server or users)
|
|
581
598
|
[HUMAN] [default: true] Format output to be read on screen by a human [default]
|
|
582
599
|
[JSON] Format output as json
|
|
583
600
|
[CSV] Format output as csv
|
|
601
|
+
[MARKDOWN] Format output as markdown table
|
|
584
602
|
[SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
|
|
585
603
|
|
|
586
604
|
FLAGS
|
|
@@ -594,6 +612,7 @@ OUTPUT FLAGS
|
|
|
594
612
|
--csv Format output as csv
|
|
595
613
|
--human Format output to be read on screen by a human [default]
|
|
596
614
|
--json Format output as json
|
|
615
|
+
--markdown Format output as markdown table
|
|
597
616
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
598
617
|
|
|
599
618
|
DESCRIPTION
|
|
@@ -613,7 +632,8 @@ get the server config
|
|
|
613
632
|
|
|
614
633
|
```
|
|
615
634
|
USAGE
|
|
616
|
-
$ proca config server [--json | --human | --csv] [--env <value>]
|
|
635
|
+
$ proca config server [--json | --human | --csv | --markdown] [--env <value>]
|
|
636
|
+
[--simplify]
|
|
617
637
|
|
|
618
638
|
FLAGS
|
|
619
639
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -622,6 +642,7 @@ OUTPUT FLAGS
|
|
|
622
642
|
--csv Format output as csv
|
|
623
643
|
--human Format output to be read on screen by a human [default]
|
|
624
644
|
--json Format output as json
|
|
645
|
+
--markdown Format output as markdown table
|
|
625
646
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
626
647
|
|
|
627
648
|
DESCRIPTION
|
|
@@ -634,8 +655,8 @@ update the setting used to authenticate to the servers and services
|
|
|
634
655
|
|
|
635
656
|
```
|
|
636
657
|
USAGE
|
|
637
|
-
$ proca config set [KEY] [VALUE] [--json | --human | --csv] [--env
|
|
638
|
-
[--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>]
|
|
639
660
|
|
|
640
661
|
ARGUMENTS
|
|
641
662
|
[KEY] variable name
|
|
@@ -651,6 +672,7 @@ OUTPUT FLAGS
|
|
|
651
672
|
--csv Format output as csv
|
|
652
673
|
--human Format output to be read on screen by a human [default]
|
|
653
674
|
--json Format output as json
|
|
675
|
+
--markdown Format output as markdown table
|
|
654
676
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
655
677
|
|
|
656
678
|
DESCRIPTION
|
|
@@ -665,21 +687,22 @@ EXAMPLES
|
|
|
665
687
|
$ proca config set VAR1 VALUE
|
|
666
688
|
```
|
|
667
689
|
|
|
668
|
-
## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
|
|
690
|
+
## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
669
691
|
|
|
670
692
|
create setting to access to a server
|
|
671
693
|
|
|
672
694
|
```
|
|
673
695
|
USAGE
|
|
674
|
-
$ proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human
|
|
675
|
-
[--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
676
|
-
/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]
|
|
677
699
|
|
|
678
700
|
ARGUMENTS
|
|
679
701
|
[ENV] [default: default] allow to switch between configurations (server or users)
|
|
680
702
|
[HUMAN] [default: true] Format output to be read on screen by a human [default]
|
|
681
703
|
[JSON] Format output as json
|
|
682
704
|
[CSV] Format output as csv
|
|
705
|
+
[MARKDOWN] Format output as markdown table
|
|
683
706
|
[SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
|
|
684
707
|
|
|
685
708
|
FLAGS
|
|
@@ -693,6 +716,7 @@ OUTPUT FLAGS
|
|
|
693
716
|
--csv Format output as csv
|
|
694
717
|
--human Format output to be read on screen by a human [default]
|
|
695
718
|
--json Format output as json
|
|
719
|
+
--markdown Format output as markdown table
|
|
696
720
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
697
721
|
|
|
698
722
|
DESCRIPTION
|
|
@@ -712,7 +736,8 @@ fetch the information about the current user (based on the token)
|
|
|
712
736
|
|
|
713
737
|
```
|
|
714
738
|
USAGE
|
|
715
|
-
$ proca config user [--json | --human | --csv] [--env <value>]
|
|
739
|
+
$ proca config user [--json | --human | --csv | --markdown] [--env <value>]
|
|
740
|
+
[--simplify]
|
|
716
741
|
|
|
717
742
|
FLAGS
|
|
718
743
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -721,6 +746,7 @@ OUTPUT FLAGS
|
|
|
721
746
|
--csv Format output as csv
|
|
722
747
|
--human Format output to be read on screen by a human [default]
|
|
723
748
|
--json Format output as json
|
|
749
|
+
--markdown Format output as markdown table
|
|
724
750
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
725
751
|
|
|
726
752
|
DESCRIPTION
|
|
@@ -740,8 +766,8 @@ counter of supporters
|
|
|
740
766
|
|
|
741
767
|
```
|
|
742
768
|
USAGE
|
|
743
|
-
$ proca contact count [--json | --human | --csv] [--env <value>]
|
|
744
|
-
<value> | -n <the_short_name> | -x <value>]
|
|
769
|
+
$ proca contact count [--json | --human | --csv | --markdown] [--env <value>]
|
|
770
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
745
771
|
|
|
746
772
|
FLAGS
|
|
747
773
|
-i, --id=<value>
|
|
@@ -753,6 +779,7 @@ OUTPUT FLAGS
|
|
|
753
779
|
--csv Format output as csv
|
|
754
780
|
--human Format output to be read on screen by a human [default]
|
|
755
781
|
--json Format output as json
|
|
782
|
+
--markdown Format output as markdown table
|
|
756
783
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
757
784
|
|
|
758
785
|
DESCRIPTION
|
|
@@ -768,9 +795,9 @@ EXAMPLES
|
|
|
768
795
|
|
|
769
796
|
```
|
|
770
797
|
USAGE
|
|
771
|
-
$ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv
|
|
772
|
-
<value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing]
|
|
773
|
-
--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 | ]
|
|
774
801
|
|
|
775
802
|
ARGUMENTS
|
|
776
803
|
[TITLE] name of the campaign, % for wildchar
|
|
@@ -792,6 +819,7 @@ OUTPUT FLAGS
|
|
|
792
819
|
--csv Format output as csv
|
|
793
820
|
--human Format output to be read on screen by a human [default]
|
|
794
821
|
--json Format output as json
|
|
822
|
+
--markdown Format output as markdown table
|
|
795
823
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
796
824
|
|
|
797
825
|
EXAMPLES
|
|
@@ -822,8 +850,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
|
|
|
822
850
|
|
|
823
851
|
```
|
|
824
852
|
USAGE
|
|
825
|
-
$ proca org add [--json | --human | --csv] [--env <value>]
|
|
826
|
-
<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>]
|
|
827
855
|
|
|
828
856
|
FLAGS
|
|
829
857
|
-n, --name=<org acronym/name> short name of the org
|
|
@@ -835,6 +863,7 @@ OUTPUT FLAGS
|
|
|
835
863
|
--csv Format output as csv
|
|
836
864
|
--human Format output to be read on screen by a human [default]
|
|
837
865
|
--json Format output as json
|
|
866
|
+
--markdown Format output as markdown table
|
|
838
867
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
839
868
|
|
|
840
869
|
EXAMPLES
|
|
@@ -849,8 +878,8 @@ view a org crm synchroniser
|
|
|
849
878
|
|
|
850
879
|
```
|
|
851
880
|
USAGE
|
|
852
|
-
$ proca org crm -n <org name> [--json | --human | --csv] [--env
|
|
853
|
-
[--simplify] [--synchronize]
|
|
881
|
+
$ proca org crm -n <org name> [--json | --human | --csv | --markdown] [--env
|
|
882
|
+
<value>] [--simplify] [--synchronize]
|
|
854
883
|
|
|
855
884
|
FLAGS
|
|
856
885
|
-n, --name=<org name> (required) name of the org
|
|
@@ -861,6 +890,7 @@ OUTPUT FLAGS
|
|
|
861
890
|
--csv Format output as csv
|
|
862
891
|
--human Format output to be read on screen by a human [default]
|
|
863
892
|
--json Format output as json
|
|
893
|
+
--markdown Format output as markdown table
|
|
864
894
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
865
895
|
|
|
866
896
|
DESCRIPTION
|
|
@@ -871,8 +901,8 @@ DESCRIPTION
|
|
|
871
901
|
|
|
872
902
|
```
|
|
873
903
|
USAGE
|
|
874
|
-
$ proca org delete [--json | --human | --csv] [--env <value>]
|
|
875
|
-
<value> | -n <org name> | -x <value>]
|
|
904
|
+
$ proca org delete [--json | --human | --csv | --markdown] [--env <value>]
|
|
905
|
+
[--simplify] [-i <value> | -n <org name> | -x <value>]
|
|
876
906
|
|
|
877
907
|
FLAGS
|
|
878
908
|
-i, --id=<value>
|
|
@@ -884,6 +914,7 @@ OUTPUT FLAGS
|
|
|
884
914
|
--csv Format output as csv
|
|
885
915
|
--human Format output to be read on screen by a human [default]
|
|
886
916
|
--json Format output as json
|
|
917
|
+
--markdown Format output as markdown table
|
|
887
918
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
888
919
|
|
|
889
920
|
EXAMPLES
|
|
@@ -897,7 +928,7 @@ Set service, usually email backend for an org
|
|
|
897
928
|
```
|
|
898
929
|
USAGE
|
|
899
930
|
$ 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>]
|
|
931
|
+
preview webhook supabase smtp [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [--from <value>]
|
|
901
932
|
|
|
902
933
|
FLAGS
|
|
903
934
|
--env=<value> [default: default] allow to switch
|
|
@@ -913,6 +944,7 @@ OUTPUT FLAGS
|
|
|
913
944
|
--csv Format output as csv
|
|
914
945
|
--human Format output to be read on screen by a human [default]
|
|
915
946
|
--json Format output as json
|
|
947
|
+
--markdown Format output as markdown table
|
|
916
948
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
917
949
|
|
|
918
950
|
DESCRIPTION
|
|
@@ -925,8 +957,8 @@ view a org
|
|
|
925
957
|
|
|
926
958
|
```
|
|
927
959
|
USAGE
|
|
928
|
-
$ proca org get [--json | --human | --csv] [--env <value>]
|
|
929
|
-
name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
|
|
960
|
+
$ proca org get [--json | --human | --csv | --markdown] [--env <value>]
|
|
961
|
+
[--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
|
|
930
962
|
|
|
931
963
|
FLAGS
|
|
932
964
|
-n, --name=<org name> name of the org
|
|
@@ -942,6 +974,7 @@ OUTPUT FLAGS
|
|
|
942
974
|
--csv Format output as csv
|
|
943
975
|
--human Format output to be read on screen by a human [default]
|
|
944
976
|
--json Format output as json
|
|
977
|
+
--markdown Format output as markdown table
|
|
945
978
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
946
979
|
|
|
947
980
|
DESCRIPTION
|
|
@@ -1204,8 +1237,8 @@ Set service, usually email backend for an org, the specific meaning of each para
|
|
|
1204
1237
|
```
|
|
1205
1238
|
USAGE
|
|
1206
1239
|
$ proca service add -o <value> --type
|
|
1207
|
-
mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv] [--env <value>]
|
|
1208
|
-
[--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>]
|
|
1209
1242
|
|
|
1210
1243
|
FLAGS
|
|
1211
1244
|
-o, --org=<value> (required) organisation running the service
|
|
@@ -1221,6 +1254,7 @@ OUTPUT FLAGS
|
|
|
1221
1254
|
--csv Format output as csv
|
|
1222
1255
|
--human Format output to be read on screen by a human [default]
|
|
1223
1256
|
--json Format output as json
|
|
1257
|
+
--markdown Format output as markdown table
|
|
1224
1258
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1225
1259
|
|
|
1226
1260
|
DESCRIPTION
|
|
@@ -1233,7 +1267,7 @@ list services set for an organisation
|
|
|
1233
1267
|
|
|
1234
1268
|
```
|
|
1235
1269
|
USAGE
|
|
1236
|
-
$ proca service list -o <value> [--json | --human | --csv] [--env <value>]
|
|
1270
|
+
$ proca service list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
|
|
1237
1271
|
[--simplify]
|
|
1238
1272
|
|
|
1239
1273
|
FLAGS
|
|
@@ -1244,6 +1278,7 @@ OUTPUT FLAGS
|
|
|
1244
1278
|
--csv Format output as csv
|
|
1245
1279
|
--human Format output to be read on screen by a human [default]
|
|
1246
1280
|
--json Format output as json
|
|
1281
|
+
--markdown Format output as markdown table
|
|
1247
1282
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1248
1283
|
|
|
1249
1284
|
DESCRIPTION
|
|
@@ -1255,7 +1290,7 @@ DESCRIPTION
|
|
|
1255
1290
|
```
|
|
1256
1291
|
USAGE
|
|
1257
1292
|
$ proca target add -c <value> --name <value> --email <value> [--json | --human |
|
|
1258
|
-
--csv] [--env <value>] [--simplify] [--external_id <value>]
|
|
1293
|
+
--csv | --markdown] [--env <value>] [--simplify] [--external_id <value>]
|
|
1259
1294
|
|
|
1260
1295
|
FLAGS
|
|
1261
1296
|
-c, --campaign=<value> (required) mtt campaign to add the target
|
|
@@ -1268,6 +1303,7 @@ OUTPUT FLAGS
|
|
|
1268
1303
|
--csv Format output as csv
|
|
1269
1304
|
--human Format output to be read on screen by a human [default]
|
|
1270
1305
|
--json Format output as json
|
|
1306
|
+
--markdown Format output as markdown table
|
|
1271
1307
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1272
1308
|
```
|
|
1273
1309
|
|
|
@@ -1275,9 +1311,9 @@ OUTPUT FLAGS
|
|
|
1275
1311
|
|
|
1276
1312
|
```
|
|
1277
1313
|
USAGE
|
|
1278
|
-
$ proca template add -o <value> [--json | --human | --csv] [--env <value>]
|
|
1279
|
-
[--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
|
|
1280
|
-
+ 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]
|
|
1281
1317
|
|
|
1282
1318
|
FLAGS
|
|
1283
1319
|
-l, --lang=<locale> [default: en] language
|
|
@@ -1292,6 +1328,7 @@ OUTPUT FLAGS
|
|
|
1292
1328
|
--csv Format output as csv
|
|
1293
1329
|
--human Format output to be read on screen by a human [default]
|
|
1294
1330
|
--json Format output as json
|
|
1331
|
+
--markdown Format output as markdown table
|
|
1295
1332
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1296
1333
|
```
|
|
1297
1334
|
|
|
@@ -1301,7 +1338,7 @@ list services set for an organisation
|
|
|
1301
1338
|
|
|
1302
1339
|
```
|
|
1303
1340
|
USAGE
|
|
1304
|
-
$ proca template list -o <value> [--json | --human | --csv] [--env <value>]
|
|
1341
|
+
$ proca template list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
|
|
1305
1342
|
[--simplify]
|
|
1306
1343
|
|
|
1307
1344
|
FLAGS
|
|
@@ -1312,6 +1349,7 @@ OUTPUT FLAGS
|
|
|
1312
1349
|
--csv Format output as csv
|
|
1313
1350
|
--human Format output to be read on screen by a human [default]
|
|
1314
1351
|
--json Format output as json
|
|
1352
|
+
--markdown Format output as markdown table
|
|
1315
1353
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1316
1354
|
|
|
1317
1355
|
DESCRIPTION
|
|
@@ -1324,8 +1362,8 @@ fetch the information about a user
|
|
|
1324
1362
|
|
|
1325
1363
|
```
|
|
1326
1364
|
USAGE
|
|
1327
|
-
$ proca user get [--json | --human | --csv] [--env <value>]
|
|
1328
|
-
<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>]
|
|
1329
1367
|
|
|
1330
1368
|
FLAGS
|
|
1331
1369
|
-i, --id=<value> id of the user
|
|
@@ -1337,6 +1375,7 @@ OUTPUT FLAGS
|
|
|
1337
1375
|
--csv Format output as csv
|
|
1338
1376
|
--human Format output to be read on screen by a human [default]
|
|
1339
1377
|
--json Format output as json
|
|
1378
|
+
--markdown Format output as markdown table
|
|
1340
1379
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1341
1380
|
|
|
1342
1381
|
DESCRIPTION
|
|
@@ -1352,8 +1391,8 @@ invite a user to join an organisation with a role
|
|
|
1352
1391
|
|
|
1353
1392
|
```
|
|
1354
1393
|
USAGE
|
|
1355
|
-
$ proca user invite -o <org name> -u <user email> [--json | --human | --csv
|
|
1356
|
-
<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]
|
|
1357
1396
|
|
|
1358
1397
|
FLAGS
|
|
1359
1398
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1366,6 +1405,7 @@ OUTPUT FLAGS
|
|
|
1366
1405
|
--csv Format output as csv
|
|
1367
1406
|
--human Format output to be read on screen by a human [default]
|
|
1368
1407
|
--json Format output as json
|
|
1408
|
+
--markdown Format output as markdown table
|
|
1369
1409
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1370
1410
|
|
|
1371
1411
|
DESCRIPTION
|
|
@@ -1381,8 +1421,8 @@ let a user join an organisation with a role
|
|
|
1381
1421
|
|
|
1382
1422
|
```
|
|
1383
1423
|
USAGE
|
|
1384
|
-
$ proca user join -o <org name> [--json | --human | --csv] [--env
|
|
1385
|
-
[--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>]
|
|
1386
1426
|
|
|
1387
1427
|
FLAGS
|
|
1388
1428
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1395,6 +1435,7 @@ OUTPUT FLAGS
|
|
|
1395
1435
|
--csv Format output as csv
|
|
1396
1436
|
--human Format output to be read on screen by a human [default]
|
|
1397
1437
|
--json Format output as json
|
|
1438
|
+
--markdown Format output as markdown table
|
|
1398
1439
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1399
1440
|
|
|
1400
1441
|
DESCRIPTION
|
|
@@ -1410,8 +1451,8 @@ leave a org
|
|
|
1410
1451
|
|
|
1411
1452
|
```
|
|
1412
1453
|
USAGE
|
|
1413
|
-
$ proca user leave -o <org name> [--json | --human | --csv] [--env
|
|
1414
|
-
[--simplify] [-u <user email>]
|
|
1454
|
+
$ proca user leave -o <org name> [--json | --human | --csv | --markdown] [--env
|
|
1455
|
+
<value>] [--simplify] [-u <user email>]
|
|
1415
1456
|
|
|
1416
1457
|
FLAGS
|
|
1417
1458
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1422,6 +1463,7 @@ OUTPUT FLAGS
|
|
|
1422
1463
|
--csv Format output as csv
|
|
1423
1464
|
--human Format output to be read on screen by a human [default]
|
|
1424
1465
|
--json Format output as json
|
|
1466
|
+
--markdown Format output as markdown table
|
|
1425
1467
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1426
1468
|
|
|
1427
1469
|
DESCRIPTION
|
|
@@ -1437,7 +1479,7 @@ list all the users
|
|
|
1437
1479
|
|
|
1438
1480
|
```
|
|
1439
1481
|
USAGE
|
|
1440
|
-
$ proca user list -o <value> [--json | --human | --csv] [--env <value>]
|
|
1482
|
+
$ proca user list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
|
|
1441
1483
|
[--simplify]
|
|
1442
1484
|
|
|
1443
1485
|
FLAGS
|
|
@@ -1448,6 +1490,7 @@ OUTPUT FLAGS
|
|
|
1448
1490
|
--csv Format output as csv
|
|
1449
1491
|
--human Format output to be read on screen by a human [default]
|
|
1450
1492
|
--json Format output as json
|
|
1493
|
+
--markdown Format output as markdown table
|
|
1451
1494
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1452
1495
|
|
|
1453
1496
|
DESCRIPTION
|
|
@@ -1463,7 +1506,8 @@ fetch the information about the current user (based on the token)
|
|
|
1463
1506
|
|
|
1464
1507
|
```
|
|
1465
1508
|
USAGE
|
|
1466
|
-
$ proca user me [--json | --human | --csv] [--env <value>]
|
|
1509
|
+
$ proca user me [--json | --human | --csv | --markdown] [--env <value>]
|
|
1510
|
+
[--simplify]
|
|
1467
1511
|
|
|
1468
1512
|
FLAGS
|
|
1469
1513
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -1472,6 +1516,7 @@ OUTPUT FLAGS
|
|
|
1472
1516
|
--csv Format output as csv
|
|
1473
1517
|
--human Format output to be read on screen by a human [default]
|
|
1474
1518
|
--json Format output as json
|
|
1519
|
+
--markdown Format output as markdown table
|
|
1475
1520
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1476
1521
|
|
|
1477
1522
|
DESCRIPTION
|
|
@@ -1491,8 +1536,8 @@ Reset user API token
|
|
|
1491
1536
|
|
|
1492
1537
|
```
|
|
1493
1538
|
USAGE
|
|
1494
|
-
$ proca user reset [USER] [--json | --human | --csv] [--env <value>]
|
|
1495
|
-
[--password <value>] [--url <value>]
|
|
1539
|
+
$ proca user reset [USER] [--json | --human | --csv | --markdown] [--env <value>]
|
|
1540
|
+
[--simplify] [--password <value>] [--url <value>]
|
|
1496
1541
|
|
|
1497
1542
|
ARGUMENTS
|
|
1498
1543
|
[USER] Username (email)
|
|
@@ -1506,6 +1551,7 @@ OUTPUT FLAGS
|
|
|
1506
1551
|
--csv Format output as csv
|
|
1507
1552
|
--human Format output to be read on screen by a human [default]
|
|
1508
1553
|
--json Format output as json
|
|
1554
|
+
--markdown Format output as markdown table
|
|
1509
1555
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1510
1556
|
|
|
1511
1557
|
DESCRIPTION
|
|
@@ -1518,7 +1564,8 @@ fetch the information about the current user (based on the token)
|
|
|
1518
1564
|
|
|
1519
1565
|
```
|
|
1520
1566
|
USAGE
|
|
1521
|
-
$ proca user whoami [--json | --human | --csv] [--env <value>]
|
|
1567
|
+
$ proca user whoami [--json | --human | --csv | --markdown] [--env <value>]
|
|
1568
|
+
[--simplify]
|
|
1522
1569
|
|
|
1523
1570
|
FLAGS
|
|
1524
1571
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -1527,6 +1574,7 @@ OUTPUT FLAGS
|
|
|
1527
1574
|
--csv Format output as csv
|
|
1528
1575
|
--human Format output to be read on screen by a human [default]
|
|
1529
1576
|
--json Format output as json
|
|
1577
|
+
--markdown Format output as markdown table
|
|
1530
1578
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1531
1579
|
|
|
1532
1580
|
DESCRIPTION
|
|
@@ -1544,8 +1592,8 @@ EXAMPLES
|
|
|
1544
1592
|
|
|
1545
1593
|
```
|
|
1546
1594
|
USAGE
|
|
1547
|
-
$ proca widget add -c <campaign name> [--json | --human | --csv] [--env
|
|
1548
|
-
[--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>]
|
|
1549
1597
|
|
|
1550
1598
|
FLAGS
|
|
1551
1599
|
-c, --campaign=<campaign name> (required) name of the campaign
|
|
@@ -1559,6 +1607,7 @@ OUTPUT FLAGS
|
|
|
1559
1607
|
--csv Format output as csv
|
|
1560
1608
|
--human Format output to be read on screen by a human [default]
|
|
1561
1609
|
--json Format output as json
|
|
1610
|
+
--markdown Format output as markdown table
|
|
1562
1611
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1563
1612
|
```
|
|
1564
1613
|
|
|
@@ -1568,8 +1617,8 @@ Delete a widget
|
|
|
1568
1617
|
|
|
1569
1618
|
```
|
|
1570
1619
|
USAGE
|
|
1571
|
-
$ proca widget delete [--json | --human | --csv] [--env <value>]
|
|
1572
|
-
<value> | -n <the_short_name> | -x <value>]
|
|
1620
|
+
$ proca widget delete [--json | --human | --csv | --markdown] [--env <value>]
|
|
1621
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1573
1622
|
|
|
1574
1623
|
FLAGS
|
|
1575
1624
|
-i, --id=<value>
|
|
@@ -1581,6 +1630,7 @@ OUTPUT FLAGS
|
|
|
1581
1630
|
--csv Format output as csv
|
|
1582
1631
|
--human Format output to be read on screen by a human [default]
|
|
1583
1632
|
--json Format output as json
|
|
1633
|
+
--markdown Format output as markdown table
|
|
1584
1634
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1585
1635
|
|
|
1586
1636
|
DESCRIPTION
|
|
@@ -1593,8 +1643,8 @@ view a widget
|
|
|
1593
1643
|
|
|
1594
1644
|
```
|
|
1595
1645
|
USAGE
|
|
1596
|
-
$ proca widget get [--json | --human | --csv] [--env <value>]
|
|
1597
|
-
<value> | -n <the_short_name> | -x <value>] [--config]
|
|
1646
|
+
$ proca widget get [--json | --human | --csv | --markdown] [--env <value>]
|
|
1647
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
|
|
1598
1648
|
|
|
1599
1649
|
FLAGS
|
|
1600
1650
|
-i, --id=<value>
|
|
@@ -1607,6 +1657,7 @@ OUTPUT FLAGS
|
|
|
1607
1657
|
--csv Format output as csv
|
|
1608
1658
|
--human Format output to be read on screen by a human [default]
|
|
1609
1659
|
--json Format output as json
|
|
1660
|
+
--markdown Format output as markdown table
|
|
1610
1661
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1611
1662
|
|
|
1612
1663
|
DESCRIPTION
|
|
@@ -1622,8 +1673,8 @@ list all the widgets of an org or campaign
|
|
|
1622
1673
|
|
|
1623
1674
|
```
|
|
1624
1675
|
USAGE
|
|
1625
|
-
$ proca widget list [--json | --human | --csv] [--env <value>]
|
|
1626
|
-
<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]
|
|
1627
1678
|
|
|
1628
1679
|
FLAGS
|
|
1629
1680
|
-c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
|
|
@@ -1635,6 +1686,7 @@ OUTPUT FLAGS
|
|
|
1635
1686
|
--csv Format output as csv
|
|
1636
1687
|
--human Format output to be read on screen by a human [default]
|
|
1637
1688
|
--json Format output as json
|
|
1689
|
+
--markdown Format output as markdown table
|
|
1638
1690
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1639
1691
|
|
|
1640
1692
|
DESCRIPTION
|