proca 1.8.3 → 2.0.1
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 +177 -190
- package/package.json +1 -1
- package/src/commands/campaign/add.mjs +7 -10
- package/src/commands/campaign/list.mjs +10 -28
- package/src/commands/contact/area/count.mjs +38 -0
- package/src/commands/contact/list.mjs +1 -5
- package/src/commands/widget/external/update.mjs +52 -0
- package/src/procaCommand.mjs +11 -9
package/README.md
CHANGED
|
@@ -53,27 +53,28 @@ you should also use the local proca-api in your [widget generator](https://githu
|
|
|
53
53
|
* [`proca action list [TITLE]`](#proca-action-list-title)
|
|
54
54
|
* [`proca action replay`](#proca-action-replay)
|
|
55
55
|
* [`proca action requeue`](#proca-action-requeue)
|
|
56
|
-
* [`proca campaign add
|
|
56
|
+
* [`proca campaign add`](#proca-campaign-add)
|
|
57
57
|
* [`proca campaign close`](#proca-campaign-close)
|
|
58
58
|
* [`proca campaign copy`](#proca-campaign-copy)
|
|
59
59
|
* [`proca campaign delete`](#proca-campaign-delete)
|
|
60
60
|
* [`proca campaign get`](#proca-campaign-get)
|
|
61
|
-
* [`proca campaign list
|
|
61
|
+
* [`proca campaign list`](#proca-campaign-list)
|
|
62
62
|
* [`proca campaign mtt`](#proca-campaign-mtt)
|
|
63
63
|
* [`proca campaign status`](#proca-campaign-status)
|
|
64
64
|
* [`proca campaign widget archive`](#proca-campaign-widget-archive)
|
|
65
65
|
* [`proca campaign widget copy`](#proca-campaign-widget-copy)
|
|
66
66
|
* [`proca campaign widget get`](#proca-campaign-widget-get)
|
|
67
67
|
* [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
|
|
68
|
-
* [`proca config add [ENV] [
|
|
68
|
+
* [`proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-json-csv-markdown-simplify)
|
|
69
69
|
* [`proca config folder`](#proca-config-folder)
|
|
70
|
-
* [`proca config init [ENV] [
|
|
70
|
+
* [`proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-json-csv-markdown-simplify)
|
|
71
71
|
* [`proca config server`](#proca-config-server)
|
|
72
72
|
* [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
|
|
73
|
-
* [`proca config setup [ENV] [
|
|
73
|
+
* [`proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-json-csv-markdown-simplify)
|
|
74
74
|
* [`proca config user`](#proca-config-user)
|
|
75
|
+
* [`proca contact area count`](#proca-contact-area-count)
|
|
75
76
|
* [`proca contact count`](#proca-contact-count)
|
|
76
|
-
* [`proca contact list
|
|
77
|
+
* [`proca contact list`](#proca-contact-list)
|
|
77
78
|
* [`proca help [COMMAND]`](#proca-help-command)
|
|
78
79
|
* [`proca org add`](#proca-org-add)
|
|
79
80
|
* [`proca org crm`](#proca-org-crm)
|
|
@@ -106,6 +107,7 @@ you should also use the local proca-api in your [widget generator](https://githu
|
|
|
106
107
|
* [`proca user whoami`](#proca-user-whoami)
|
|
107
108
|
* [`proca widget add`](#proca-widget-add)
|
|
108
109
|
* [`proca widget delete`](#proca-widget-delete)
|
|
110
|
+
* [`proca widget external update`](#proca-widget-external-update)
|
|
109
111
|
* [`proca widget get`](#proca-widget-get)
|
|
110
112
|
* [`proca widget list`](#proca-widget-list)
|
|
111
113
|
* [`proca widget rebuild`](#proca-widget-rebuild)
|
|
@@ -116,9 +118,9 @@ you should also use the local proca-api in your [widget generator](https://githu
|
|
|
116
118
|
```
|
|
117
119
|
USAGE
|
|
118
120
|
$ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
|
|
119
|
-
[--json | --
|
|
120
|
-
[--
|
|
121
|
-
|
|
121
|
+
[--json | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
|
|
122
|
+
[--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
|
|
123
|
+
<value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
|
|
122
124
|
|
|
123
125
|
FLAGS
|
|
124
126
|
-i, --id=<value> (required) widget's id
|
|
@@ -143,7 +145,6 @@ FLAGS
|
|
|
143
145
|
|
|
144
146
|
OUTPUT FLAGS
|
|
145
147
|
--csv Format output as csv
|
|
146
|
-
--human Format output to be read on screen by a human [default]
|
|
147
148
|
--json Format output as json
|
|
148
149
|
--markdown Format output as markdown table
|
|
149
150
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -162,8 +163,8 @@ Should the supporter confirm the action? it can be set either for all the widget
|
|
|
162
163
|
|
|
163
164
|
```
|
|
164
165
|
USAGE
|
|
165
|
-
$ proca action confirm [--json | --
|
|
166
|
-
|
|
166
|
+
$ proca action confirm [--json | --csv | --markdown] [--env <value>] [--simplify] [--org
|
|
167
|
+
<value>] [--campaign <value>] [--confirm] [--template <value>]
|
|
167
168
|
|
|
168
169
|
FLAGS
|
|
169
170
|
--campaign=<value> campaign collecting the action
|
|
@@ -174,7 +175,6 @@ FLAGS
|
|
|
174
175
|
|
|
175
176
|
OUTPUT FLAGS
|
|
176
177
|
--csv Format output as csv
|
|
177
|
-
--human Format output to be read on screen by a human [default]
|
|
178
178
|
--json Format output as json
|
|
179
179
|
--markdown Format output as markdown table
|
|
180
180
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -190,8 +190,8 @@ counter of actions
|
|
|
190
190
|
|
|
191
191
|
```
|
|
192
192
|
USAGE
|
|
193
|
-
$ proca action count [ID_NAME_DXID] [--json | --
|
|
194
|
-
|
|
193
|
+
$ proca action count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
194
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
195
195
|
|
|
196
196
|
FLAGS
|
|
197
197
|
-i, --id=<value>
|
|
@@ -201,7 +201,6 @@ FLAGS
|
|
|
201
201
|
|
|
202
202
|
OUTPUT FLAGS
|
|
203
203
|
--csv Format output as csv
|
|
204
|
-
--human Format output to be read on screen by a human [default]
|
|
205
204
|
--json Format output as json
|
|
206
205
|
--markdown Format output as markdown table
|
|
207
206
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -219,9 +218,9 @@ EXAMPLES
|
|
|
219
218
|
|
|
220
219
|
```
|
|
221
220
|
USAGE
|
|
222
|
-
$ proca action list [TITLE] -o <organisation name> [--json | --
|
|
223
|
-
|
|
224
|
-
[--
|
|
221
|
+
$ proca action list [TITLE] -o <organisation name> [--json | --csv | --markdown]
|
|
222
|
+
[--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi]
|
|
223
|
+
[--utm | --simplify] [--comment | ]
|
|
225
224
|
|
|
226
225
|
ARGUMENTS
|
|
227
226
|
TITLE name of the campaign, % for wildchar
|
|
@@ -241,7 +240,6 @@ FLAGS
|
|
|
241
240
|
|
|
242
241
|
OUTPUT FLAGS
|
|
243
242
|
--csv Format output as csv
|
|
244
|
-
--human Format output to be read on screen by a human [default]
|
|
245
243
|
--json Format output as json
|
|
246
244
|
--markdown Format output as markdown table
|
|
247
245
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -254,8 +252,8 @@ EXAMPLES
|
|
|
254
252
|
|
|
255
253
|
```
|
|
256
254
|
USAGE
|
|
257
|
-
$ proca action replay -o <organisation name> [--json | --
|
|
258
|
-
|
|
255
|
+
$ proca action replay -o <organisation name> [--json | --csv | --markdown] [--env
|
|
256
|
+
<value>] [--simplify] [-c <campaign title>]
|
|
259
257
|
|
|
260
258
|
FLAGS
|
|
261
259
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
@@ -264,7 +262,6 @@ FLAGS
|
|
|
264
262
|
|
|
265
263
|
OUTPUT FLAGS
|
|
266
264
|
--csv Format output as csv
|
|
267
|
-
--human Format output to be read on screen by a human [default]
|
|
268
265
|
--json Format output as json
|
|
269
266
|
--markdown Format output as markdown table
|
|
270
267
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -280,9 +277,9 @@ requeue actions
|
|
|
280
277
|
```
|
|
281
278
|
USAGE
|
|
282
279
|
$ proca action requeue -o <org name> -q
|
|
283
|
-
CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --
|
|
284
|
-
--
|
|
285
|
-
|
|
280
|
+
CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --csv |
|
|
281
|
+
--markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09]
|
|
282
|
+
[--optin] [--testing] [--doi]
|
|
286
283
|
|
|
287
284
|
FLAGS
|
|
288
285
|
-c, --campaign=<campaign name> name of the campaign, % for wildchar
|
|
@@ -300,7 +297,6 @@ FLAGS
|
|
|
300
297
|
|
|
301
298
|
OUTPUT FLAGS
|
|
302
299
|
--csv Format output as csv
|
|
303
|
-
--human Format output to be read on screen by a human [default]
|
|
304
300
|
--json Format output as json
|
|
305
301
|
--markdown Format output as markdown table
|
|
306
302
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -312,24 +308,21 @@ EXAMPLES
|
|
|
312
308
|
$ proca action requeue
|
|
313
309
|
```
|
|
314
310
|
|
|
315
|
-
## `proca campaign add
|
|
311
|
+
## `proca campaign add`
|
|
316
312
|
|
|
317
313
|
```
|
|
318
314
|
USAGE
|
|
319
|
-
$ proca campaign add
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
ARGUMENTS
|
|
323
|
-
TITLE title of the campaign
|
|
315
|
+
$ proca campaign add -n <campaign name> -o <org name> [--json | --csv | --markdown]
|
|
316
|
+
[--env <value>] [--simplify] [--title <value>...]
|
|
324
317
|
|
|
325
318
|
FLAGS
|
|
326
319
|
-n, --name=<campaign name> (required) name of the campaign
|
|
327
320
|
-o, --org=<org name> (required) name of the coordinator
|
|
328
321
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
322
|
+
--title=<value>... title of the campaign
|
|
329
323
|
|
|
330
324
|
OUTPUT FLAGS
|
|
331
325
|
--csv Format output as csv
|
|
332
|
-
--human Format output to be read on screen by a human [default]
|
|
333
326
|
--json Format output as json
|
|
334
327
|
--markdown Format output as markdown table
|
|
335
328
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -342,8 +335,8 @@ EXAMPLES
|
|
|
342
335
|
|
|
343
336
|
```
|
|
344
337
|
USAGE
|
|
345
|
-
$ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
|
|
346
|
-
|
|
338
|
+
$ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
|
|
339
|
+
| --markdown] [--env <value>] [--simplify]
|
|
347
340
|
|
|
348
341
|
FLAGS
|
|
349
342
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -352,7 +345,6 @@ FLAGS
|
|
|
352
345
|
|
|
353
346
|
OUTPUT FLAGS
|
|
354
347
|
--csv Format output as csv
|
|
355
|
-
--human Format output to be read on screen by a human [default]
|
|
356
348
|
--json Format output as json
|
|
357
349
|
--markdown Format output as markdown table
|
|
358
350
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -372,9 +364,9 @@ Copy campaign settings to a new campaign
|
|
|
372
364
|
|
|
373
365
|
```
|
|
374
366
|
USAGE
|
|
375
|
-
$ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --
|
|
376
|
-
|
|
377
|
-
|
|
367
|
+
$ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --csv | --markdown]
|
|
368
|
+
[--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title <campaign
|
|
369
|
+
title>] [--dry-run]
|
|
378
370
|
|
|
379
371
|
FLAGS
|
|
380
372
|
-i, --id=<value>
|
|
@@ -388,7 +380,6 @@ FLAGS
|
|
|
388
380
|
|
|
389
381
|
OUTPUT FLAGS
|
|
390
382
|
--csv Format output as csv
|
|
391
|
-
--human Format output to be read on screen by a human [default]
|
|
392
383
|
--json Format output as json
|
|
393
384
|
--markdown Format output as markdown table
|
|
394
385
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -408,8 +399,8 @@ delete a campaign
|
|
|
408
399
|
|
|
409
400
|
```
|
|
410
401
|
USAGE
|
|
411
|
-
$ proca campaign delete [ID_NAME_DXID] [--json | --
|
|
412
|
-
|
|
402
|
+
$ proca campaign delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
403
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
413
404
|
|
|
414
405
|
FLAGS
|
|
415
406
|
-i, --id=<value>
|
|
@@ -419,7 +410,6 @@ FLAGS
|
|
|
419
410
|
|
|
420
411
|
OUTPUT FLAGS
|
|
421
412
|
--csv Format output as csv
|
|
422
|
-
--human Format output to be read on screen by a human [default]
|
|
423
413
|
--json Format output as json
|
|
424
414
|
--markdown Format output as markdown table
|
|
425
415
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -443,8 +433,8 @@ view a campaign
|
|
|
443
433
|
|
|
444
434
|
```
|
|
445
435
|
USAGE
|
|
446
|
-
$ proca campaign get [ID_NAME_DXID] [--json | --
|
|
447
|
-
|
|
436
|
+
$ proca campaign get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
437
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
|
|
448
438
|
|
|
449
439
|
FLAGS
|
|
450
440
|
-i, --id=<value>
|
|
@@ -457,7 +447,6 @@ FLAGS
|
|
|
457
447
|
|
|
458
448
|
OUTPUT FLAGS
|
|
459
449
|
--csv Format output as csv
|
|
460
|
-
--human Format output to be read on screen by a human [default]
|
|
461
450
|
--json Format output as json
|
|
462
451
|
--markdown Format output as markdown table
|
|
463
452
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -469,36 +458,29 @@ EXAMPLES
|
|
|
469
458
|
$ proca campaign get -i 42
|
|
470
459
|
```
|
|
471
460
|
|
|
472
|
-
## `proca campaign list
|
|
461
|
+
## `proca campaign list`
|
|
473
462
|
|
|
474
463
|
list all the campaigns
|
|
475
464
|
|
|
476
465
|
```
|
|
477
466
|
USAGE
|
|
478
|
-
$ proca campaign list [
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
ARGUMENTS
|
|
482
|
-
TITLE name of the campaign, % for wildchar
|
|
467
|
+
$ proca campaign list [--json | --csv | --markdown] [--env <value>] [--simplify] [-n
|
|
468
|
+
<the_short_name>] [-t <campaign title>...] [--stats]
|
|
483
469
|
|
|
484
470
|
FLAGS
|
|
485
|
-
-
|
|
486
|
-
-t, --title=<campaign title
|
|
487
|
-
--env=<value>
|
|
488
|
-
--[no-]stats
|
|
471
|
+
-n, --name=<the_short_name> name of the organisation
|
|
472
|
+
-t, --title=<campaign title>... name of the campaign
|
|
473
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
474
|
+
--[no-]stats display the stats
|
|
489
475
|
|
|
490
476
|
OUTPUT FLAGS
|
|
491
477
|
--csv Format output as csv
|
|
492
|
-
--human Format output to be read on screen by a human [default]
|
|
493
478
|
--json Format output as json
|
|
494
479
|
--markdown Format output as markdown table
|
|
495
480
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
496
481
|
|
|
497
482
|
DESCRIPTION
|
|
498
483
|
list all the campaigns
|
|
499
|
-
|
|
500
|
-
EXAMPLES
|
|
501
|
-
$ proca campaign list %pizza%
|
|
502
484
|
```
|
|
503
485
|
|
|
504
486
|
## `proca campaign mtt`
|
|
@@ -507,9 +489,9 @@ set the mail to target (mtt) params
|
|
|
507
489
|
|
|
508
490
|
```
|
|
509
491
|
USAGE
|
|
510
|
-
$ proca campaign mtt [ID_NAME_DXID] [--json | --
|
|
511
|
-
|
|
512
|
-
|
|
492
|
+
$ proca campaign mtt [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
493
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template <value>]
|
|
494
|
+
[--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
|
|
513
495
|
|
|
514
496
|
FLAGS
|
|
515
497
|
-i, --id=<value>
|
|
@@ -527,7 +509,6 @@ FLAGS
|
|
|
527
509
|
|
|
528
510
|
OUTPUT FLAGS
|
|
529
511
|
--csv Format output as csv
|
|
530
|
-
--human Format output to be read on screen by a human [default]
|
|
531
512
|
--json Format output as json
|
|
532
513
|
--markdown Format output as markdown table
|
|
533
514
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -543,8 +524,8 @@ EXAMPLES
|
|
|
543
524
|
|
|
544
525
|
```
|
|
545
526
|
USAGE
|
|
546
|
-
$ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
|
|
547
|
-
|
|
527
|
+
$ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
|
|
528
|
+
| --markdown] [--env <value>] [--simplify]
|
|
548
529
|
|
|
549
530
|
FLAGS
|
|
550
531
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -553,7 +534,6 @@ FLAGS
|
|
|
553
534
|
|
|
554
535
|
OUTPUT FLAGS
|
|
555
536
|
--csv Format output as csv
|
|
556
|
-
--human Format output to be read on screen by a human [default]
|
|
557
537
|
--json Format output as json
|
|
558
538
|
--markdown Format output as markdown table
|
|
559
539
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -573,8 +553,8 @@ Archive all widgets in the campaign by adding suffix
|
|
|
573
553
|
|
|
574
554
|
```
|
|
575
555
|
USAGE
|
|
576
|
-
$ proca campaign widget archive [ID_NAME_DXID] [--json | --
|
|
577
|
-
|
|
556
|
+
$ proca campaign widget archive [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
557
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
|
|
578
558
|
|
|
579
559
|
FLAGS
|
|
580
560
|
-i, --id=<value>
|
|
@@ -586,7 +566,6 @@ FLAGS
|
|
|
586
566
|
|
|
587
567
|
OUTPUT FLAGS
|
|
588
568
|
--csv Format output as csv
|
|
589
|
-
--human Format output to be read on screen by a human [default]
|
|
590
569
|
--json Format output as json
|
|
591
570
|
--markdown Format output as markdown table
|
|
592
571
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -608,8 +587,8 @@ Copy widgets from one campaign to another
|
|
|
608
587
|
|
|
609
588
|
```
|
|
610
589
|
USAGE
|
|
611
|
-
$ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --
|
|
612
|
-
|
|
590
|
+
$ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --csv | --markdown]
|
|
591
|
+
[--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
|
|
613
592
|
|
|
614
593
|
FLAGS
|
|
615
594
|
-i, --id=<value>
|
|
@@ -622,7 +601,6 @@ FLAGS
|
|
|
622
601
|
|
|
623
602
|
OUTPUT FLAGS
|
|
624
603
|
--csv Format output as csv
|
|
625
|
-
--human Format output to be read on screen by a human [default]
|
|
626
604
|
--json Format output as json
|
|
627
605
|
--markdown Format output as markdown table
|
|
628
606
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -646,8 +624,8 @@ List widgets in a campaign
|
|
|
646
624
|
|
|
647
625
|
```
|
|
648
626
|
USAGE
|
|
649
|
-
$ proca campaign widget get [ID_NAME_DXID] [--json | --
|
|
650
|
-
|
|
627
|
+
$ proca campaign widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
628
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
651
629
|
|
|
652
630
|
FLAGS
|
|
653
631
|
-i, --id=<value>
|
|
@@ -657,7 +635,6 @@ FLAGS
|
|
|
657
635
|
|
|
658
636
|
OUTPUT FLAGS
|
|
659
637
|
--csv Format output as csv
|
|
660
|
-
--human Format output to be read on screen by a human [default]
|
|
661
638
|
--json Format output as json
|
|
662
639
|
--markdown Format output as markdown table
|
|
663
640
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -672,8 +649,8 @@ DESCRIPTION
|
|
|
672
649
|
|
|
673
650
|
```
|
|
674
651
|
USAGE
|
|
675
|
-
$ proca campaign widget rebuild [ID_NAME_DXID] [--json | --
|
|
676
|
-
|
|
652
|
+
$ proca campaign widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
653
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
677
654
|
|
|
678
655
|
FLAGS
|
|
679
656
|
-i, --id=<value>
|
|
@@ -683,7 +660,6 @@ FLAGS
|
|
|
683
660
|
|
|
684
661
|
OUTPUT FLAGS
|
|
685
662
|
--csv Format output as csv
|
|
686
|
-
--human Format output to be read on screen by a human [default]
|
|
687
663
|
--json Format output as json
|
|
688
664
|
--markdown Format output as markdown table
|
|
689
665
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -695,19 +671,18 @@ EXAMPLES
|
|
|
695
671
|
$ proca-cli campaign widget rebuild climate-action
|
|
696
672
|
```
|
|
697
673
|
|
|
698
|
-
## `proca config add [ENV] [
|
|
674
|
+
## `proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
699
675
|
|
|
700
676
|
create setting to access to a server
|
|
701
677
|
|
|
702
678
|
```
|
|
703
679
|
USAGE
|
|
704
|
-
$ proca config add [ENV] [
|
|
705
|
-
|
|
680
|
+
$ proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
681
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
706
682
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
707
683
|
|
|
708
684
|
ARGUMENTS
|
|
709
685
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
710
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
711
686
|
JSON Format output as json
|
|
712
687
|
CSV Format output as csv
|
|
713
688
|
MARKDOWN Format output as markdown table
|
|
@@ -722,7 +697,6 @@ FLAGS
|
|
|
722
697
|
|
|
723
698
|
OUTPUT FLAGS
|
|
724
699
|
--csv Format output as csv
|
|
725
|
-
--human Format output to be read on screen by a human [default]
|
|
726
700
|
--json Format output as json
|
|
727
701
|
--markdown Format output as markdown table
|
|
728
702
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -744,15 +718,13 @@ Check and create config folders
|
|
|
744
718
|
|
|
745
719
|
```
|
|
746
720
|
USAGE
|
|
747
|
-
$ proca config folder [--json | --
|
|
748
|
-
[--simplify]
|
|
721
|
+
$ proca config folder [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
749
722
|
|
|
750
723
|
FLAGS
|
|
751
724
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
752
725
|
|
|
753
726
|
OUTPUT FLAGS
|
|
754
727
|
--csv Format output as csv
|
|
755
|
-
--human Format output to be read on screen by a human [default]
|
|
756
728
|
--json Format output as json
|
|
757
729
|
--markdown Format output as markdown table
|
|
758
730
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -763,19 +735,18 @@ DESCRIPTION
|
|
|
763
735
|
Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
|
|
764
736
|
```
|
|
765
737
|
|
|
766
|
-
## `proca config init [ENV] [
|
|
738
|
+
## `proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
767
739
|
|
|
768
740
|
create setting to access to a server
|
|
769
741
|
|
|
770
742
|
```
|
|
771
743
|
USAGE
|
|
772
|
-
$ proca config init [ENV] [
|
|
773
|
-
|
|
744
|
+
$ proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
745
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
774
746
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
775
747
|
|
|
776
748
|
ARGUMENTS
|
|
777
749
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
778
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
779
750
|
JSON Format output as json
|
|
780
751
|
CSV Format output as csv
|
|
781
752
|
MARKDOWN Format output as markdown table
|
|
@@ -790,7 +761,6 @@ FLAGS
|
|
|
790
761
|
|
|
791
762
|
OUTPUT FLAGS
|
|
792
763
|
--csv Format output as csv
|
|
793
|
-
--human Format output to be read on screen by a human [default]
|
|
794
764
|
--json Format output as json
|
|
795
765
|
--markdown Format output as markdown table
|
|
796
766
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -812,15 +782,13 @@ get the server config
|
|
|
812
782
|
|
|
813
783
|
```
|
|
814
784
|
USAGE
|
|
815
|
-
$ proca config server [--json | --
|
|
816
|
-
[--simplify]
|
|
785
|
+
$ proca config server [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
817
786
|
|
|
818
787
|
FLAGS
|
|
819
788
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
820
789
|
|
|
821
790
|
OUTPUT FLAGS
|
|
822
791
|
--csv Format output as csv
|
|
823
|
-
--human Format output to be read on screen by a human [default]
|
|
824
792
|
--json Format output as json
|
|
825
793
|
--markdown Format output as markdown table
|
|
826
794
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -835,8 +803,8 @@ update the setting used to authenticate to the servers and services
|
|
|
835
803
|
|
|
836
804
|
```
|
|
837
805
|
USAGE
|
|
838
|
-
$ proca config set [KEY] [VALUE] [--json | --
|
|
839
|
-
|
|
806
|
+
$ proca config set [KEY] [VALUE] [--json | --csv | --markdown] [--env <value>]
|
|
807
|
+
[--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
|
|
840
808
|
|
|
841
809
|
ARGUMENTS
|
|
842
810
|
KEY variable name
|
|
@@ -850,7 +818,6 @@ FLAGS
|
|
|
850
818
|
|
|
851
819
|
OUTPUT FLAGS
|
|
852
820
|
--csv Format output as csv
|
|
853
|
-
--human Format output to be read on screen by a human [default]
|
|
854
821
|
--json Format output as json
|
|
855
822
|
--markdown Format output as markdown table
|
|
856
823
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -867,19 +834,18 @@ EXAMPLES
|
|
|
867
834
|
$ proca config set VAR1 VALUE
|
|
868
835
|
```
|
|
869
836
|
|
|
870
|
-
## `proca config setup [ENV] [
|
|
837
|
+
## `proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
871
838
|
|
|
872
839
|
create setting to access to a server
|
|
873
840
|
|
|
874
841
|
```
|
|
875
842
|
USAGE
|
|
876
|
-
$ proca config setup [ENV] [
|
|
877
|
-
|
|
843
|
+
$ proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
844
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
878
845
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
879
846
|
|
|
880
847
|
ARGUMENTS
|
|
881
848
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
882
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
883
849
|
JSON Format output as json
|
|
884
850
|
CSV Format output as csv
|
|
885
851
|
MARKDOWN Format output as markdown table
|
|
@@ -894,7 +860,6 @@ FLAGS
|
|
|
894
860
|
|
|
895
861
|
OUTPUT FLAGS
|
|
896
862
|
--csv Format output as csv
|
|
897
|
-
--human Format output to be read on screen by a human [default]
|
|
898
863
|
--json Format output as json
|
|
899
864
|
--markdown Format output as markdown table
|
|
900
865
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -916,15 +881,13 @@ fetch the information about the current user (based on the token)
|
|
|
916
881
|
|
|
917
882
|
```
|
|
918
883
|
USAGE
|
|
919
|
-
$ proca config user [--json | --
|
|
920
|
-
[--simplify]
|
|
884
|
+
$ proca config user [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
921
885
|
|
|
922
886
|
FLAGS
|
|
923
887
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
924
888
|
|
|
925
889
|
OUTPUT FLAGS
|
|
926
890
|
--csv Format output as csv
|
|
927
|
-
--human Format output to be read on screen by a human [default]
|
|
928
891
|
--json Format output as json
|
|
929
892
|
--markdown Format output as markdown table
|
|
930
893
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -940,14 +903,42 @@ EXAMPLES
|
|
|
940
903
|
$ proca config user
|
|
941
904
|
```
|
|
942
905
|
|
|
906
|
+
## `proca contact area count`
|
|
907
|
+
|
|
908
|
+
counter of supporters by area (country), disabled for performance reasons
|
|
909
|
+
|
|
910
|
+
```
|
|
911
|
+
USAGE
|
|
912
|
+
$ proca contact area count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
913
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
914
|
+
|
|
915
|
+
FLAGS
|
|
916
|
+
-i, --id=<value>
|
|
917
|
+
-n, --name=<the_short_name> name
|
|
918
|
+
-x, --dxid=<value> dxid
|
|
919
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
920
|
+
|
|
921
|
+
OUTPUT FLAGS
|
|
922
|
+
--csv Format output as csv
|
|
923
|
+
--json Format output as json
|
|
924
|
+
--markdown Format output as markdown table
|
|
925
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
926
|
+
|
|
927
|
+
DESCRIPTION
|
|
928
|
+
counter of supporters by area (country), disabled for performance reasons
|
|
929
|
+
|
|
930
|
+
EXAMPLES
|
|
931
|
+
$ proca contact area count --name <name of the campaign>
|
|
932
|
+
```
|
|
933
|
+
|
|
943
934
|
## `proca contact count`
|
|
944
935
|
|
|
945
936
|
counter of supporters
|
|
946
937
|
|
|
947
938
|
```
|
|
948
939
|
USAGE
|
|
949
|
-
$ proca contact count [ID_NAME_DXID] [--json | --
|
|
950
|
-
|
|
940
|
+
$ proca contact count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
941
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
951
942
|
|
|
952
943
|
FLAGS
|
|
953
944
|
-i, --id=<value>
|
|
@@ -957,7 +948,6 @@ FLAGS
|
|
|
957
948
|
|
|
958
949
|
OUTPUT FLAGS
|
|
959
950
|
--csv Format output as csv
|
|
960
|
-
--human Format output to be read on screen by a human [default]
|
|
961
951
|
--json Format output as json
|
|
962
952
|
--markdown Format output as markdown table
|
|
963
953
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -969,16 +959,13 @@ EXAMPLES
|
|
|
969
959
|
$ proca contact count --name <name of the campaign>
|
|
970
960
|
```
|
|
971
961
|
|
|
972
|
-
## `proca contact list
|
|
962
|
+
## `proca contact list`
|
|
973
963
|
|
|
974
964
|
```
|
|
975
965
|
USAGE
|
|
976
|
-
$ proca contact list
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
ARGUMENTS
|
|
981
|
-
TITLE name of the campaign, % for wildchar
|
|
966
|
+
$ proca contact list -o <organisation name> [--json | --csv | --markdown] [--env
|
|
967
|
+
<value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
|
|
968
|
+
--simplify] [--comment | ]
|
|
982
969
|
|
|
983
970
|
FLAGS
|
|
984
971
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
@@ -995,7 +982,6 @@ FLAGS
|
|
|
995
982
|
|
|
996
983
|
OUTPUT FLAGS
|
|
997
984
|
--csv Format output as csv
|
|
998
|
-
--human Format output to be read on screen by a human [default]
|
|
999
985
|
--json Format output as json
|
|
1000
986
|
--markdown Format output as markdown table
|
|
1001
987
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1028,8 +1014,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
|
|
|
1028
1014
|
|
|
1029
1015
|
```
|
|
1030
1016
|
USAGE
|
|
1031
|
-
$ proca org add [--json | --
|
|
1032
|
-
[--
|
|
1017
|
+
$ proca org add [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1018
|
+
[--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
|
|
1033
1019
|
|
|
1034
1020
|
FLAGS
|
|
1035
1021
|
-n, --name=<org acronym/name> short name of the org
|
|
@@ -1039,7 +1025,6 @@ FLAGS
|
|
|
1039
1025
|
|
|
1040
1026
|
OUTPUT FLAGS
|
|
1041
1027
|
--csv Format output as csv
|
|
1042
|
-
--human Format output to be read on screen by a human [default]
|
|
1043
1028
|
--json Format output as json
|
|
1044
1029
|
--markdown Format output as markdown table
|
|
1045
1030
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1056,8 +1041,8 @@ view a org crm synchroniser
|
|
|
1056
1041
|
|
|
1057
1042
|
```
|
|
1058
1043
|
USAGE
|
|
1059
|
-
$ proca org crm -n <org name> [--json | --
|
|
1060
|
-
|
|
1044
|
+
$ proca org crm -n <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1045
|
+
[--simplify] [--synchronize]
|
|
1061
1046
|
|
|
1062
1047
|
FLAGS
|
|
1063
1048
|
-n, --name=<org name> (required) name of the org
|
|
@@ -1066,7 +1051,6 @@ FLAGS
|
|
|
1066
1051
|
|
|
1067
1052
|
OUTPUT FLAGS
|
|
1068
1053
|
--csv Format output as csv
|
|
1069
|
-
--human Format output to be read on screen by a human [default]
|
|
1070
1054
|
--json Format output as json
|
|
1071
1055
|
--markdown Format output as markdown table
|
|
1072
1056
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1079,8 +1063,8 @@ DESCRIPTION
|
|
|
1079
1063
|
|
|
1080
1064
|
```
|
|
1081
1065
|
USAGE
|
|
1082
|
-
$ proca org delete [ID_NAME_DXID] [--json | --
|
|
1083
|
-
|
|
1066
|
+
$ proca org delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1067
|
+
[--simplify] [-i <value> | -n <org name> | -x <value>]
|
|
1084
1068
|
|
|
1085
1069
|
FLAGS
|
|
1086
1070
|
-i, --id=<value>
|
|
@@ -1090,7 +1074,6 @@ FLAGS
|
|
|
1090
1074
|
|
|
1091
1075
|
OUTPUT FLAGS
|
|
1092
1076
|
--csv Format output as csv
|
|
1093
|
-
--human Format output to be read on screen by a human [default]
|
|
1094
1077
|
--json Format output as json
|
|
1095
1078
|
--markdown Format output as markdown table
|
|
1096
1079
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1105,10 +1088,9 @@ Set email service and supporter confirmation for an org
|
|
|
1105
1088
|
|
|
1106
1089
|
```
|
|
1107
1090
|
USAGE
|
|
1108
|
-
$ proca org email [ID_NAME_DXID] [--json | --
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
[--supporter-confirm-template <value>]
|
|
1091
|
+
$ proca org email [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1092
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe system preview
|
|
1093
|
+
webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm] [--supporter-confirm-template <value>]
|
|
1112
1094
|
|
|
1113
1095
|
FLAGS
|
|
1114
1096
|
-i, --id=<value>
|
|
@@ -1126,7 +1108,6 @@ FLAGS
|
|
|
1126
1108
|
|
|
1127
1109
|
OUTPUT FLAGS
|
|
1128
1110
|
--csv Format output as csv
|
|
1129
|
-
--human Format output to be read on screen by a human [default]
|
|
1130
1111
|
--json Format output as json
|
|
1131
1112
|
--markdown Format output as markdown table
|
|
1132
1113
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1141,8 +1122,8 @@ view a org
|
|
|
1141
1122
|
|
|
1142
1123
|
```
|
|
1143
1124
|
USAGE
|
|
1144
|
-
$ proca org get [ID_NAME_DXID] [--json | --
|
|
1145
|
-
|
|
1125
|
+
$ proca org get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1126
|
+
[--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
|
|
1146
1127
|
|
|
1147
1128
|
FLAGS
|
|
1148
1129
|
-n, --name=<org name> name of the org
|
|
@@ -1156,7 +1137,6 @@ FLAGS
|
|
|
1156
1137
|
|
|
1157
1138
|
OUTPUT FLAGS
|
|
1158
1139
|
--csv Format output as csv
|
|
1159
|
-
--human Format output to be read on screen by a human [default]
|
|
1160
1140
|
--json Format output as json
|
|
1161
1141
|
--markdown Format output as markdown table
|
|
1162
1142
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1174,7 +1154,7 @@ list all the users
|
|
|
1174
1154
|
|
|
1175
1155
|
```
|
|
1176
1156
|
USAGE
|
|
1177
|
-
$ proca org user get -o <value> [--json | --
|
|
1157
|
+
$ proca org user get -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1178
1158
|
[--simplify]
|
|
1179
1159
|
|
|
1180
1160
|
FLAGS
|
|
@@ -1183,7 +1163,6 @@ FLAGS
|
|
|
1183
1163
|
|
|
1184
1164
|
OUTPUT FLAGS
|
|
1185
1165
|
--csv Format output as csv
|
|
1186
|
-
--human Format output to be read on screen by a human [default]
|
|
1187
1166
|
--json Format output as json
|
|
1188
1167
|
--markdown Format output as markdown table
|
|
1189
1168
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1495,7 +1474,7 @@ Set service, usually email backend for an org, the specific meaning of each para
|
|
|
1495
1474
|
```
|
|
1496
1475
|
USAGE
|
|
1497
1476
|
$ proca service add -o <value> --type
|
|
1498
|
-
mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --
|
|
1477
|
+
mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --csv | --markdown] [--env <value>]
|
|
1499
1478
|
[--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
|
|
1500
1479
|
|
|
1501
1480
|
FLAGS
|
|
@@ -1510,7 +1489,6 @@ FLAGS
|
|
|
1510
1489
|
|
|
1511
1490
|
OUTPUT FLAGS
|
|
1512
1491
|
--csv Format output as csv
|
|
1513
|
-
--human Format output to be read on screen by a human [default]
|
|
1514
1492
|
--json Format output as json
|
|
1515
1493
|
--markdown Format output as markdown table
|
|
1516
1494
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1525,7 +1503,7 @@ list services set for an organisation
|
|
|
1525
1503
|
|
|
1526
1504
|
```
|
|
1527
1505
|
USAGE
|
|
1528
|
-
$ proca service list -o <value> [--json | --
|
|
1506
|
+
$ proca service list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1529
1507
|
[--simplify]
|
|
1530
1508
|
|
|
1531
1509
|
FLAGS
|
|
@@ -1534,7 +1512,6 @@ FLAGS
|
|
|
1534
1512
|
|
|
1535
1513
|
OUTPUT FLAGS
|
|
1536
1514
|
--csv Format output as csv
|
|
1537
|
-
--human Format output to be read on screen by a human [default]
|
|
1538
1515
|
--json Format output as json
|
|
1539
1516
|
--markdown Format output as markdown table
|
|
1540
1517
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1547,8 +1524,8 @@ DESCRIPTION
|
|
|
1547
1524
|
|
|
1548
1525
|
```
|
|
1549
1526
|
USAGE
|
|
1550
|
-
$ proca target add -c <value> --name <value> --email <value> [--json | --
|
|
1551
|
-
--
|
|
1527
|
+
$ proca target add -c <value> --name <value> --email <value> [--json | --csv |
|
|
1528
|
+
--markdown] [--env <value>] [--simplify] [--external_id <value>]
|
|
1552
1529
|
|
|
1553
1530
|
FLAGS
|
|
1554
1531
|
-c, --campaign=<value> (required) mtt campaign to add the target
|
|
@@ -1559,7 +1536,6 @@ FLAGS
|
|
|
1559
1536
|
|
|
1560
1537
|
OUTPUT FLAGS
|
|
1561
1538
|
--csv Format output as csv
|
|
1562
|
-
--human Format output to be read on screen by a human [default]
|
|
1563
1539
|
--json Format output as json
|
|
1564
1540
|
--markdown Format output as markdown table
|
|
1565
1541
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1569,7 +1545,7 @@ OUTPUT FLAGS
|
|
|
1569
1545
|
|
|
1570
1546
|
```
|
|
1571
1547
|
USAGE
|
|
1572
|
-
$ proca template add -o <value> [--json | --
|
|
1548
|
+
$ proca template add -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1573
1549
|
[--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
|
|
1574
1550
|
'template:' + type]
|
|
1575
1551
|
|
|
@@ -1584,7 +1560,6 @@ FLAGS
|
|
|
1584
1560
|
|
|
1585
1561
|
OUTPUT FLAGS
|
|
1586
1562
|
--csv Format output as csv
|
|
1587
|
-
--human Format output to be read on screen by a human [default]
|
|
1588
1563
|
--json Format output as json
|
|
1589
1564
|
--markdown Format output as markdown table
|
|
1590
1565
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1596,7 +1571,7 @@ list services set for an organisation
|
|
|
1596
1571
|
|
|
1597
1572
|
```
|
|
1598
1573
|
USAGE
|
|
1599
|
-
$ proca template list -o <value> [--json | --
|
|
1574
|
+
$ proca template list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1600
1575
|
[--simplify]
|
|
1601
1576
|
|
|
1602
1577
|
FLAGS
|
|
@@ -1605,7 +1580,6 @@ FLAGS
|
|
|
1605
1580
|
|
|
1606
1581
|
OUTPUT FLAGS
|
|
1607
1582
|
--csv Format output as csv
|
|
1608
|
-
--human Format output to be read on screen by a human [default]
|
|
1609
1583
|
--json Format output as json
|
|
1610
1584
|
--markdown Format output as markdown table
|
|
1611
1585
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1620,8 +1594,8 @@ fetch the information about a user
|
|
|
1620
1594
|
|
|
1621
1595
|
```
|
|
1622
1596
|
USAGE
|
|
1623
|
-
$ proca user get [--json | --
|
|
1624
|
-
[--
|
|
1597
|
+
$ proca user get [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1598
|
+
[--email <value>] [-o <org name>] [-i <value>]
|
|
1625
1599
|
|
|
1626
1600
|
FLAGS
|
|
1627
1601
|
-i, --id=<value> id of the user
|
|
@@ -1631,7 +1605,6 @@ FLAGS
|
|
|
1631
1605
|
|
|
1632
1606
|
OUTPUT FLAGS
|
|
1633
1607
|
--csv Format output as csv
|
|
1634
|
-
--human Format output to be read on screen by a human [default]
|
|
1635
1608
|
--json Format output as json
|
|
1636
1609
|
--markdown Format output as markdown table
|
|
1637
1610
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1649,8 +1622,8 @@ invite a user to join an organisation with a role
|
|
|
1649
1622
|
|
|
1650
1623
|
```
|
|
1651
1624
|
USAGE
|
|
1652
|
-
$ proca user invite -o <org name> -u <user email> [--json | --
|
|
1653
|
-
|
|
1625
|
+
$ proca user invite -o <org name> -u <user email> [--json | --csv | --markdown] [--env
|
|
1626
|
+
<value>] [--simplify] [--role owner|campaigner|coordinator|translator]
|
|
1654
1627
|
|
|
1655
1628
|
FLAGS
|
|
1656
1629
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1661,7 +1634,6 @@ FLAGS
|
|
|
1661
1634
|
|
|
1662
1635
|
OUTPUT FLAGS
|
|
1663
1636
|
--csv Format output as csv
|
|
1664
|
-
--human Format output to be read on screen by a human [default]
|
|
1665
1637
|
--json Format output as json
|
|
1666
1638
|
--markdown Format output as markdown table
|
|
1667
1639
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1679,8 +1651,8 @@ let a user join an organisation with a role
|
|
|
1679
1651
|
|
|
1680
1652
|
```
|
|
1681
1653
|
USAGE
|
|
1682
|
-
$ proca user join -o <org name> [--json | --
|
|
1683
|
-
|
|
1654
|
+
$ proca user join -o <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1655
|
+
[--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
|
|
1684
1656
|
|
|
1685
1657
|
FLAGS
|
|
1686
1658
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1691,7 +1663,6 @@ FLAGS
|
|
|
1691
1663
|
|
|
1692
1664
|
OUTPUT FLAGS
|
|
1693
1665
|
--csv Format output as csv
|
|
1694
|
-
--human Format output to be read on screen by a human [default]
|
|
1695
1666
|
--json Format output as json
|
|
1696
1667
|
--markdown Format output as markdown table
|
|
1697
1668
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1709,8 +1680,8 @@ leave a org
|
|
|
1709
1680
|
|
|
1710
1681
|
```
|
|
1711
1682
|
USAGE
|
|
1712
|
-
$ proca user leave -o <org name> [--json | --
|
|
1713
|
-
|
|
1683
|
+
$ proca user leave -o <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1684
|
+
[--simplify] [-u <user email>]
|
|
1714
1685
|
|
|
1715
1686
|
FLAGS
|
|
1716
1687
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1719,7 +1690,6 @@ FLAGS
|
|
|
1719
1690
|
|
|
1720
1691
|
OUTPUT FLAGS
|
|
1721
1692
|
--csv Format output as csv
|
|
1722
|
-
--human Format output to be read on screen by a human [default]
|
|
1723
1693
|
--json Format output as json
|
|
1724
1694
|
--markdown Format output as markdown table
|
|
1725
1695
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1737,7 +1707,7 @@ list all the users
|
|
|
1737
1707
|
|
|
1738
1708
|
```
|
|
1739
1709
|
USAGE
|
|
1740
|
-
$ proca user list -o <value> [--json | --
|
|
1710
|
+
$ proca user list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1741
1711
|
[--simplify]
|
|
1742
1712
|
|
|
1743
1713
|
FLAGS
|
|
@@ -1746,7 +1716,6 @@ FLAGS
|
|
|
1746
1716
|
|
|
1747
1717
|
OUTPUT FLAGS
|
|
1748
1718
|
--csv Format output as csv
|
|
1749
|
-
--human Format output to be read on screen by a human [default]
|
|
1750
1719
|
--json Format output as json
|
|
1751
1720
|
--markdown Format output as markdown table
|
|
1752
1721
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1767,15 +1736,13 @@ fetch the information about the current user (based on the token)
|
|
|
1767
1736
|
|
|
1768
1737
|
```
|
|
1769
1738
|
USAGE
|
|
1770
|
-
$ proca user me [--json | --
|
|
1771
|
-
[--simplify]
|
|
1739
|
+
$ proca user me [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1772
1740
|
|
|
1773
1741
|
FLAGS
|
|
1774
1742
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
1775
1743
|
|
|
1776
1744
|
OUTPUT FLAGS
|
|
1777
1745
|
--csv Format output as csv
|
|
1778
|
-
--human Format output to be read on screen by a human [default]
|
|
1779
1746
|
--json Format output as json
|
|
1780
1747
|
--markdown Format output as markdown table
|
|
1781
1748
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1797,8 +1764,8 @@ Reset user API token
|
|
|
1797
1764
|
|
|
1798
1765
|
```
|
|
1799
1766
|
USAGE
|
|
1800
|
-
$ proca user reset [USER] [--json | --
|
|
1801
|
-
[--
|
|
1767
|
+
$ proca user reset [USER] [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1768
|
+
[--password <value>] [--url <value>]
|
|
1802
1769
|
|
|
1803
1770
|
ARGUMENTS
|
|
1804
1771
|
USER Username (email)
|
|
@@ -1810,7 +1777,6 @@ FLAGS
|
|
|
1810
1777
|
|
|
1811
1778
|
OUTPUT FLAGS
|
|
1812
1779
|
--csv Format output as csv
|
|
1813
|
-
--human Format output to be read on screen by a human [default]
|
|
1814
1780
|
--json Format output as json
|
|
1815
1781
|
--markdown Format output as markdown table
|
|
1816
1782
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1825,15 +1791,13 @@ fetch the information about the current user (based on the token)
|
|
|
1825
1791
|
|
|
1826
1792
|
```
|
|
1827
1793
|
USAGE
|
|
1828
|
-
$ proca user whoami [--json | --
|
|
1829
|
-
[--simplify]
|
|
1794
|
+
$ proca user whoami [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1830
1795
|
|
|
1831
1796
|
FLAGS
|
|
1832
1797
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
1833
1798
|
|
|
1834
1799
|
OUTPUT FLAGS
|
|
1835
1800
|
--csv Format output as csv
|
|
1836
|
-
--human Format output to be read on screen by a human [default]
|
|
1837
1801
|
--json Format output as json
|
|
1838
1802
|
--markdown Format output as markdown table
|
|
1839
1803
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1853,8 +1817,8 @@ EXAMPLES
|
|
|
1853
1817
|
|
|
1854
1818
|
```
|
|
1855
1819
|
USAGE
|
|
1856
|
-
$ proca widget add -c <campaign name> [--json | --
|
|
1857
|
-
|
|
1820
|
+
$ proca widget add -c <campaign name> [--json | --csv | --markdown] [--env <value>]
|
|
1821
|
+
[--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
|
|
1858
1822
|
|
|
1859
1823
|
FLAGS
|
|
1860
1824
|
-c, --campaign=<campaign name> (required) name of the campaign
|
|
@@ -1866,7 +1830,6 @@ FLAGS
|
|
|
1866
1830
|
|
|
1867
1831
|
OUTPUT FLAGS
|
|
1868
1832
|
--csv Format output as csv
|
|
1869
|
-
--human Format output to be read on screen by a human [default]
|
|
1870
1833
|
--json Format output as json
|
|
1871
1834
|
--markdown Format output as markdown table
|
|
1872
1835
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1878,8 +1841,8 @@ Delete a widget
|
|
|
1878
1841
|
|
|
1879
1842
|
```
|
|
1880
1843
|
USAGE
|
|
1881
|
-
$ proca widget delete [ID_NAME_DXID] [--json | --
|
|
1882
|
-
|
|
1844
|
+
$ proca widget delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1845
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1883
1846
|
|
|
1884
1847
|
FLAGS
|
|
1885
1848
|
-i, --id=<value>
|
|
@@ -1889,7 +1852,6 @@ FLAGS
|
|
|
1889
1852
|
|
|
1890
1853
|
OUTPUT FLAGS
|
|
1891
1854
|
--csv Format output as csv
|
|
1892
|
-
--human Format output to be read on screen by a human [default]
|
|
1893
1855
|
--json Format output as json
|
|
1894
1856
|
--markdown Format output as markdown table
|
|
1895
1857
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1898,14 +1860,43 @@ DESCRIPTION
|
|
|
1898
1860
|
Delete a widget
|
|
1899
1861
|
```
|
|
1900
1862
|
|
|
1863
|
+
## `proca widget external update`
|
|
1864
|
+
|
|
1865
|
+
Update the global counter to add the actions collected elsewhere
|
|
1866
|
+
|
|
1867
|
+
```
|
|
1868
|
+
USAGE
|
|
1869
|
+
$ proca widget external update [ID_NAME_DXID] -t <value> [--json | --csv | --markdown] [--env
|
|
1870
|
+
<value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1871
|
+
|
|
1872
|
+
FLAGS
|
|
1873
|
+
-i, --id=<value>
|
|
1874
|
+
-n, --name=<the_short_name> name
|
|
1875
|
+
-t, --total=<value> (required) new total to include
|
|
1876
|
+
-x, --dxid=<value> dxid
|
|
1877
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
1878
|
+
|
|
1879
|
+
OUTPUT FLAGS
|
|
1880
|
+
--csv Format output as csv
|
|
1881
|
+
--json Format output as json
|
|
1882
|
+
--markdown Format output as markdown table
|
|
1883
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1884
|
+
|
|
1885
|
+
DESCRIPTION
|
|
1886
|
+
Update the global counter to add the actions collected elsewhere
|
|
1887
|
+
|
|
1888
|
+
EXAMPLES
|
|
1889
|
+
see also proca contact count
|
|
1890
|
+
```
|
|
1891
|
+
|
|
1901
1892
|
## `proca widget get`
|
|
1902
1893
|
|
|
1903
1894
|
view a widget
|
|
1904
1895
|
|
|
1905
1896
|
```
|
|
1906
1897
|
USAGE
|
|
1907
|
-
$ proca widget get [ID_NAME_DXID] [--json | --
|
|
1908
|
-
|
|
1898
|
+
$ proca widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1899
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
|
|
1909
1900
|
|
|
1910
1901
|
FLAGS
|
|
1911
1902
|
-i, --id=<value>
|
|
@@ -1916,7 +1907,6 @@ FLAGS
|
|
|
1916
1907
|
|
|
1917
1908
|
OUTPUT FLAGS
|
|
1918
1909
|
--csv Format output as csv
|
|
1919
|
-
--human Format output to be read on screen by a human [default]
|
|
1920
1910
|
--json Format output as json
|
|
1921
1911
|
--markdown Format output as markdown table
|
|
1922
1912
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1931,8 +1921,8 @@ list all the widgets of an org or campaign
|
|
|
1931
1921
|
|
|
1932
1922
|
```
|
|
1933
1923
|
USAGE
|
|
1934
|
-
$ proca widget list [--json | --
|
|
1935
|
-
|
|
1924
|
+
$ proca widget list [--json | --csv | --markdown] [--env <value>] [--simplify] [-o
|
|
1925
|
+
<organisation name>] [-c <campaign name>] [--config]
|
|
1936
1926
|
|
|
1937
1927
|
FLAGS
|
|
1938
1928
|
-c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
|
|
@@ -1942,7 +1932,6 @@ FLAGS
|
|
|
1942
1932
|
|
|
1943
1933
|
OUTPUT FLAGS
|
|
1944
1934
|
--csv Format output as csv
|
|
1945
|
-
--human Format output to be read on screen by a human [default]
|
|
1946
1935
|
--json Format output as json
|
|
1947
1936
|
--markdown Format output as markdown table
|
|
1948
1937
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1960,8 +1949,8 @@ EXAMPLES
|
|
|
1960
1949
|
|
|
1961
1950
|
```
|
|
1962
1951
|
USAGE
|
|
1963
|
-
$ proca widget rebuild [ID_NAME_DXID] [--json | --
|
|
1964
|
-
|
|
1952
|
+
$ proca widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1953
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1965
1954
|
|
|
1966
1955
|
FLAGS
|
|
1967
1956
|
-i, --id=<value>
|
|
@@ -1971,7 +1960,6 @@ FLAGS
|
|
|
1971
1960
|
|
|
1972
1961
|
OUTPUT FLAGS
|
|
1973
1962
|
--csv Format output as csv
|
|
1974
|
-
--human Format output to be read on screen by a human [default]
|
|
1975
1963
|
--json Format output as json
|
|
1976
1964
|
--markdown Format output as markdown table
|
|
1977
1965
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1995,9 +1983,9 @@ Update a widget's properties
|
|
|
1995
1983
|
|
|
1996
1984
|
```
|
|
1997
1985
|
USAGE
|
|
1998
|
-
$ proca widget update [ID_NAME_DXID] [--json | --
|
|
1999
|
-
|
|
2000
|
-
|
|
1986
|
+
$ proca widget update [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1987
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-n <widget name>] [-l <locale>] [--color <hex code>]
|
|
1988
|
+
[--confirm-optin] [--confirm-action] [--dry-run]
|
|
2001
1989
|
|
|
2002
1990
|
FLAGS
|
|
2003
1991
|
-i, --id=<value>
|
|
@@ -2013,7 +2001,6 @@ FLAGS
|
|
|
2013
2001
|
|
|
2014
2002
|
OUTPUT FLAGS
|
|
2015
2003
|
--csv Format output as csv
|
|
2016
|
-
--human Format output to be read on screen by a human [default]
|
|
2017
2004
|
--json Format output as json
|
|
2018
2005
|
--markdown Format output as markdown table
|
|
2019
2006
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|