proca 1.7.8 → 1.8.3

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.
Files changed (58) hide show
  1. package/README.md +469 -134
  2. package/package.json +5 -3
  3. package/proca-cli +2 -2
  4. package/src/commands/action/add.mjs +131 -131
  5. package/src/commands/action/confirm.mjs +44 -44
  6. package/src/commands/action/count.mjs +41 -41
  7. package/src/commands/action/list.mjs +130 -130
  8. package/src/commands/action/replay.mjs +30 -30
  9. package/src/commands/action/requeue.mjs +110 -110
  10. package/src/commands/campaign/add.mjs +95 -83
  11. package/src/commands/campaign/copy.mjs +91 -0
  12. package/src/commands/campaign/delete.mjs +36 -56
  13. package/src/commands/campaign/get.mjs +5 -0
  14. package/src/commands/campaign/list.mjs +128 -123
  15. package/src/commands/campaign/queries.graphql +14 -14
  16. package/src/commands/campaign/status.mjs +39 -39
  17. package/src/commands/campaign/widget/archive.mjs +124 -0
  18. package/src/commands/campaign/widget/copy.mjs +175 -0
  19. package/src/commands/campaign/widget/get.mjs +19 -0
  20. package/src/commands/campaign/widget/index.mjs +17 -0
  21. package/src/commands/campaign/widget/rebuild.mjs +50 -0
  22. package/src/commands/config/add.mjs +78 -78
  23. package/src/commands/config/folder.mjs +30 -30
  24. package/src/commands/config/server.mjs +15 -15
  25. package/src/commands/config/set.mjs +84 -84
  26. package/src/commands/config/user.mjs +50 -48
  27. package/src/commands/contact/count.mjs +22 -23
  28. package/src/commands/contact/list.mjs +131 -131
  29. package/src/commands/org/add.mjs +51 -51
  30. package/src/commands/org/crm.mjs +61 -61
  31. package/src/commands/org/delete.mjs +31 -31
  32. package/src/commands/org/email.mjs +94 -66
  33. package/src/commands/org/get.mjs +10 -5
  34. package/src/commands/service/add.mjs +59 -59
  35. package/src/commands/service/list.mjs +15 -15
  36. package/src/commands/target/add.mjs +52 -52
  37. package/src/commands/template/add.mjs +67 -67
  38. package/src/commands/template/list.mjs +33 -33
  39. package/src/commands/user/get.mjs +60 -60
  40. package/src/commands/user/invite.mjs +37 -37
  41. package/src/commands/user/join.mjs +51 -51
  42. package/src/commands/user/leave.mjs +47 -47
  43. package/src/commands/user/list.mjs +2 -2
  44. package/src/commands/user/reset.mjs +72 -72
  45. package/src/commands/widget/add.mjs +61 -70
  46. package/src/commands/widget/delete.mjs +27 -27
  47. package/src/commands/widget/get.mjs +34 -33
  48. package/src/commands/widget/list.mjs +93 -80
  49. package/src/commands/widget/rebuild.mjs +64 -0
  50. package/src/commands/widget/update.mjs +174 -0
  51. package/src/config.mjs +31 -31
  52. package/src/generated/schema.json +10675 -10675
  53. package/src/hooks/help.mjs +9 -9
  54. package/src/hooks/init.mjs +26 -26
  55. package/src/procaCommand.mjs +22 -1
  56. package/src/urql.mjs +39 -39
  57. package/src/util/twitter.mjs +19 -19
  58. package/theme.json +27 -27
package/README.md CHANGED
@@ -22,12 +22,12 @@ $# if you don't have your API token, generate one
22
22
  $ proca user reset --email <your_email> --passowrd <your password>
23
23
  $ proca config init --token=<API-token>
24
24
  ```
25
- you can set up the config folder the widget builder will use to store the caches. skip unless you want a different one than the default (your/widget/folder/config).
26
25
 
26
+ you can set up the config folder the widget builder will use to store the caches. skip unless you want a different one than the default (your/widget/folder/config).
27
27
 
28
28
  ### local development
29
29
 
30
- ````sh-session
30
+ ```sh-session
31
31
  $ git clone https://github.com/fixthestatusquo/proca-cli.git
32
32
  $ cd proca-cli
33
33
  $ npm install
@@ -35,14 +35,14 @@ you can set up the config folder the widget builder will use to store the caches
35
35
  $./proca-cli config add --env=local --url=http://localhost:4000/api
36
36
  $./proca-cli config server --env=local #check if the config is working
37
37
  $./proca-cli config user #check if the config is working
38
- ````
38
+ ```
39
39
 
40
40
  you should also use the local proca-api in your [widget generator](https://github.com/fixthestatusquo/proca)
41
41
 
42
- ````sh-session
42
+ ```sh-session
43
43
  $ cd /your/path/to/proca
44
44
  $ npm link proca # use the local proca-cli repo
45
- ````
45
+ ```
46
46
 
47
47
  # Commands
48
48
 
@@ -55,11 +55,16 @@ you should also use the local proca-api in your [widget generator](https://githu
55
55
  * [`proca action requeue`](#proca-action-requeue)
56
56
  * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
57
57
  * [`proca campaign close`](#proca-campaign-close)
58
+ * [`proca campaign copy`](#proca-campaign-copy)
58
59
  * [`proca campaign delete`](#proca-campaign-delete)
59
60
  * [`proca campaign get`](#proca-campaign-get)
60
61
  * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
61
62
  * [`proca campaign mtt`](#proca-campaign-mtt)
62
63
  * [`proca campaign status`](#proca-campaign-status)
64
+ * [`proca campaign widget archive`](#proca-campaign-widget-archive)
65
+ * [`proca campaign widget copy`](#proca-campaign-widget-copy)
66
+ * [`proca campaign widget get`](#proca-campaign-widget-get)
67
+ * [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
63
68
  * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
64
69
  * [`proca config folder`](#proca-config-folder)
65
70
  * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-markdown-simplify)
@@ -75,14 +80,16 @@ you should also use the local proca-api in your [widget generator](https://githu
75
80
  * [`proca org delete`](#proca-org-delete)
76
81
  * [`proca org email`](#proca-org-email)
77
82
  * [`proca org get`](#proca-org-get)
83
+ * [`proca org user get`](#proca-org-user-get)
78
84
  * [`proca plugins`](#proca-plugins)
79
- * [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
85
+ * [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
80
86
  * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
81
- * [`proca plugins:install PLUGIN...`](#proca-pluginsinstall-plugin)
82
- * [`proca plugins:link PLUGIN`](#proca-pluginslink-plugin)
83
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
84
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
85
- * [`proca plugins:uninstall PLUGIN...`](#proca-pluginsuninstall-plugin)
87
+ * [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
88
+ * [`proca plugins link PATH`](#proca-plugins-link-path)
89
+ * [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
90
+ * [`proca plugins reset`](#proca-plugins-reset)
91
+ * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
92
+ * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
86
93
  * [`proca plugins update`](#proca-plugins-update)
87
94
  * [`proca service add`](#proca-service-add)
88
95
  * [`proca service list`](#proca-service-list)
@@ -101,15 +108,17 @@ you should also use the local proca-api in your [widget generator](https://githu
101
108
  * [`proca widget delete`](#proca-widget-delete)
102
109
  * [`proca widget get`](#proca-widget-get)
103
110
  * [`proca widget list`](#proca-widget-list)
111
+ * [`proca widget rebuild`](#proca-widget-rebuild)
112
+ * [`proca widget update`](#proca-widget-update)
104
113
 
105
114
  ## `proca action add`
106
115
 
107
116
  ```
108
117
  USAGE
109
- $ proca action add -i <value> --firstname <value> --email <value> [--json | --human |
110
- --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
111
- [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
112
- <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
118
+ $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
119
+ [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing]
120
+ [--optin] [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>]
121
+ [--country <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
113
122
 
114
123
  FLAGS
115
124
  -i, --id=<value> (required) widget's id
@@ -181,8 +190,8 @@ counter of actions
181
190
 
182
191
  ```
183
192
  USAGE
184
- $ proca action count [--json | --human | --csv | --markdown] [--env <value>]
185
- [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
193
+ $ proca action count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
194
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
186
195
 
187
196
  FLAGS
188
197
  -i, --id=<value>
@@ -215,7 +224,7 @@ USAGE
215
224
  [--testing] [--doi] [--utm | --simplify] [--comment | ]
216
225
 
217
226
  ARGUMENTS
218
- [TITLE] name of the campaign, % for wildchar
227
+ TITLE name of the campaign, % for wildchar
219
228
 
220
229
  FLAGS
221
230
  -c, --campaign=<campaign name> name of the campaign, % for wildchar
@@ -311,7 +320,7 @@ USAGE
311
320
  | --markdown] [--env <value>] [--simplify]
312
321
 
313
322
  ARGUMENTS
314
- [TITLE] title of the campaign
323
+ TITLE title of the campaign
315
324
 
316
325
  FLAGS
317
326
  -n, --name=<campaign name> (required) name of the campaign
@@ -333,12 +342,12 @@ EXAMPLES
333
342
 
334
343
  ```
335
344
  USAGE
336
- $ proca campaign close --status draft|live|closed|ignored [--json | --human | --csv |
337
- --markdown] [--env <value>] [--simplify]
345
+ $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
346
+ --human | --csv | --markdown] [--env <value>] [--simplify]
338
347
 
339
348
  FLAGS
340
349
  --env=<value> [default: default] allow to switch between configurations (server or users)
341
- --status=<option> (required) [env: [object Object]] Status to set
350
+ --status=<option> (required) Status to set
342
351
  <options: draft|live|closed|ignored>
343
352
 
344
353
  OUTPUT FLAGS
@@ -357,19 +366,56 @@ EXAMPLES
357
366
  $ proca campaign close -i <campaign_id>
358
367
  ```
359
368
 
369
+ ## `proca campaign copy`
370
+
371
+ Copy campaign settings to a new campaign
372
+
373
+ ```
374
+ USAGE
375
+ $ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
376
+ --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title
377
+ <campaign title>] [--dry-run]
378
+
379
+ FLAGS
380
+ -i, --id=<value>
381
+ -n, --name=<the_short_name> name
382
+ -o, --org=<org name> organization for the new campaign (defaults to source campaign org)
383
+ -t, --to=<campaign name> (required) new campaign name
384
+ -x, --dxid=<value> dxid
385
+ --dry-run preview changes without executing
386
+ --env=<value> [default: default] allow to switch between configurations (server or users)
387
+ --title=<campaign title> title for the new campaign (defaults to source campaign title)
388
+
389
+ OUTPUT FLAGS
390
+ --csv Format output as csv
391
+ --human Format output to be read on screen by a human [default]
392
+ --json Format output as json
393
+ --markdown Format output as markdown table
394
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
395
+
396
+ DESCRIPTION
397
+ Copy campaign settings to a new campaign
398
+
399
+ EXAMPLES
400
+ $ proca campaign copy test_2025 --to test_2026
401
+
402
+ $ proca campaign copy -n old_campaign --to new_campaign -o different_org
403
+ ```
404
+
360
405
  ## `proca campaign delete`
361
406
 
362
407
  delete a campaign
363
408
 
364
409
  ```
365
410
  USAGE
366
- $ proca campaign delete [--json | --human | --csv | --markdown] [--env <value>]
367
- [--simplify] [-i <organisation name>] [-n <campaign name>]
411
+ $ proca campaign delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
412
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
368
413
 
369
414
  FLAGS
370
- -i, --id=<organisation name> id of the campaign
371
- -n, --name=<campaign name> name of the campaign
372
- --env=<value> [default: default] allow to switch between configurations (server or users)
415
+ -i, --id=<value>
416
+ -n, --name=<the_short_name> name
417
+ -x, --dxid=<value> dxid
418
+ --env=<value> [default: default] allow to switch between configurations (server or users)
373
419
 
374
420
  OUTPUT FLAGS
375
421
  --csv Format output as csv
@@ -382,7 +428,13 @@ DESCRIPTION
382
428
  delete a campaign
383
429
 
384
430
  EXAMPLES
431
+ $ proca campaign delete 42
432
+
385
433
  $ proca campaign delete -i 42
434
+
435
+ $ proca campaign delete my_campaign
436
+
437
+ $ proca campaign delete -n my_campaign
386
438
  ```
387
439
 
388
440
  ## `proca campaign get`
@@ -391,8 +443,8 @@ view a campaign
391
443
 
392
444
  ```
393
445
  USAGE
394
- $ proca campaign get [--json | --human | --csv | --markdown] [--env <value>]
395
- [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
446
+ $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
447
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
396
448
 
397
449
  FLAGS
398
450
  -i, --id=<value>
@@ -427,7 +479,7 @@ USAGE
427
479
  [--simplify] [-o <organisation name>] [-t <campaign title>] [--stats]
428
480
 
429
481
  ARGUMENTS
430
- [TITLE] name of the campaign, % for wildchar
482
+ TITLE name of the campaign, % for wildchar
431
483
 
432
484
  FLAGS
433
485
  -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
@@ -455,9 +507,9 @@ set the mail to target (mtt) params
455
507
 
456
508
  ```
457
509
  USAGE
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]
510
+ $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
511
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template
512
+ <value>] [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
461
513
 
462
514
  FLAGS
463
515
  -i, --id=<value>
@@ -491,12 +543,12 @@ EXAMPLES
491
543
 
492
544
  ```
493
545
  USAGE
494
- $ proca campaign status --status draft|live|closed|ignored [--json | --human | --csv |
495
- --markdown] [--env <value>] [--simplify]
546
+ $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
547
+ --human | --csv | --markdown] [--env <value>] [--simplify]
496
548
 
497
549
  FLAGS
498
550
  --env=<value> [default: default] allow to switch between configurations (server or users)
499
- --status=<option> (required) [env: [object Object]] Status to set
551
+ --status=<option> (required) Status to set
500
552
  <options: draft|live|closed|ignored>
501
553
 
502
554
  OUTPUT FLAGS
@@ -515,6 +567,134 @@ EXAMPLES
515
567
  $ proca campaign status -i <campaign_id>
516
568
  ```
517
569
 
570
+ ## `proca campaign widget archive`
571
+
572
+ Archive all widgets in the campaign by adding suffix
573
+
574
+ ```
575
+ USAGE
576
+ $ proca campaign widget archive [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
577
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
578
+
579
+ FLAGS
580
+ -i, --id=<value>
581
+ -n, --name=<the_short_name> name
582
+ -s, --suffix=<suffix> [default: _archive] custom suffix to append (default: _archive)
583
+ -x, --dxid=<value> dxid
584
+ --dry-run preview changes without executing
585
+ --env=<value> [default: default] allow to switch between configurations (server or users)
586
+
587
+ OUTPUT FLAGS
588
+ --csv Format output as csv
589
+ --human Format output to be read on screen by a human [default]
590
+ --json Format output as json
591
+ --markdown Format output as markdown table
592
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
593
+
594
+ DESCRIPTION
595
+ Archive all widgets in the campaign by adding suffix
596
+
597
+ EXAMPLES
598
+ $ proca campaign widget archive old_campaign
599
+
600
+ $ proca campaign widget archive -n old_campaign --suffix _backup
601
+
602
+ $ proca campaign widget archive old_campaign --dry-run
603
+ ```
604
+
605
+ ## `proca campaign widget copy`
606
+
607
+ Copy widgets from one campaign to another
608
+
609
+ ```
610
+ USAGE
611
+ $ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
612
+ --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
613
+
614
+ FLAGS
615
+ -i, --id=<value>
616
+ -n, --name=<the_short_name> name
617
+ -s, --suffix=<suffix> [default: _archive] suffix to remove from widget names (e.g., _archive, -v1)
618
+ -t, --to=<campaign name> (required) destination campaign name
619
+ -x, --dxid=<value> dxid
620
+ --dry-run preview changes without executing
621
+ --env=<value> [default: default] allow to switch between configurations (server or users)
622
+
623
+ OUTPUT FLAGS
624
+ --csv Format output as csv
625
+ --human Format output to be read on screen by a human [default]
626
+ --json Format output as json
627
+ --markdown Format output as markdown table
628
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
629
+
630
+ DESCRIPTION
631
+ Copy widgets from one campaign to another
632
+
633
+ EXAMPLES
634
+ $ proca campaign widget copy old_campaign --to new_campaign
635
+
636
+ $ proca campaign widget copy -n old_campaign --to new_campaign
637
+
638
+ $ proca campaign widget copy old_campaign --to new_campaign --suffix _archive
639
+
640
+ $ proca campaign widget copy old_campaign --to new_campaign --dry-run
641
+ ```
642
+
643
+ ## `proca campaign widget get`
644
+
645
+ List widgets in a campaign
646
+
647
+ ```
648
+ USAGE
649
+ $ proca campaign widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
650
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
651
+
652
+ FLAGS
653
+ -i, --id=<value>
654
+ -n, --name=<the_short_name> name
655
+ -x, --dxid=<value> dxid
656
+ --env=<value> [default: default] allow to switch between configurations (server or users)
657
+
658
+ OUTPUT FLAGS
659
+ --csv Format output as csv
660
+ --human Format output to be read on screen by a human [default]
661
+ --json Format output as json
662
+ --markdown Format output as markdown table
663
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
664
+
665
+ DESCRIPTION
666
+ List widgets in a campaign
667
+ ```
668
+
669
+ ## `proca campaign widget rebuild`
670
+
671
+ (re)build all the widgets of a campaign
672
+
673
+ ```
674
+ USAGE
675
+ $ proca campaign widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
676
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
677
+
678
+ FLAGS
679
+ -i, --id=<value>
680
+ -n, --name=<the_short_name> name
681
+ -x, --dxid=<value> dxid
682
+ --env=<value> [default: default] allow to switch between configurations (server or users)
683
+
684
+ OUTPUT FLAGS
685
+ --csv Format output as csv
686
+ --human Format output to be read on screen by a human [default]
687
+ --json Format output as json
688
+ --markdown Format output as markdown table
689
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
690
+
691
+ DESCRIPTION
692
+ (re)build all the widgets of a campaign
693
+
694
+ EXAMPLES
695
+ $ proca-cli campaign widget rebuild climate-action
696
+ ```
697
+
518
698
  ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
519
699
 
520
700
  create setting to access to a server
@@ -526,12 +706,12 @@ USAGE
526
706
  you@example.org] [--folder /var/www/proca/config.example]
527
707
 
528
708
  ARGUMENTS
529
- [ENV] [default: default] allow to switch between configurations (server or users)
530
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
531
- [JSON] Format output as json
532
- [CSV] Format output as csv
533
- [MARKDOWN] Format output as markdown table
534
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
709
+ 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
+ JSON Format output as json
712
+ CSV Format output as csv
713
+ MARKDOWN Format output as markdown table
714
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
535
715
 
536
716
  FLAGS
537
717
  --email=you@example.org user email on proca server
@@ -594,12 +774,12 @@ USAGE
594
774
  you@example.org] [--folder /var/www/proca/config.example]
595
775
 
596
776
  ARGUMENTS
597
- [ENV] [default: default] allow to switch between configurations (server or users)
598
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
599
- [JSON] Format output as json
600
- [CSV] Format output as csv
601
- [MARKDOWN] Format output as markdown table
602
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
777
+ 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
+ JSON Format output as json
780
+ CSV Format output as csv
781
+ MARKDOWN Format output as markdown table
782
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
603
783
 
604
784
  FLAGS
605
785
  --email=you@example.org user email on proca server
@@ -659,8 +839,8 @@ USAGE
659
839
  <value>] [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
660
840
 
661
841
  ARGUMENTS
662
- [KEY] variable name
663
- [VALUE] value
842
+ KEY variable name
843
+ VALUE value
664
844
 
665
845
  FLAGS
666
846
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -698,12 +878,12 @@ USAGE
698
878
  you@example.org] [--folder /var/www/proca/config.example]
699
879
 
700
880
  ARGUMENTS
701
- [ENV] [default: default] allow to switch between configurations (server or users)
702
- [HUMAN] [default: true] Format output to be read on screen by a human [default]
703
- [JSON] Format output as json
704
- [CSV] Format output as csv
705
- [MARKDOWN] Format output as markdown table
706
- [SIMPLIFY] flatten and filter to output only the most important attributes, mostly relevant for json
881
+ 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
+ JSON Format output as json
884
+ CSV Format output as csv
885
+ MARKDOWN Format output as markdown table
886
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
707
887
 
708
888
  FLAGS
709
889
  --email=you@example.org user email on proca server
@@ -766,8 +946,8 @@ counter of supporters
766
946
 
767
947
  ```
768
948
  USAGE
769
- $ proca contact count [--json | --human | --csv | --markdown] [--env <value>]
770
- [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
949
+ $ proca contact count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
950
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
771
951
 
772
952
  FLAGS
773
953
  -i, --id=<value>
@@ -786,8 +966,6 @@ DESCRIPTION
786
966
  counter of supporters
787
967
 
788
968
  EXAMPLES
789
- $ proca contact count --id <id of the campaign>
790
-
791
969
  $ proca contact count --name <name of the campaign>
792
970
  ```
793
971
 
@@ -800,7 +978,7 @@ USAGE
800
978
  [--doi] [--utm | --simplify] [--comment | ]
801
979
 
802
980
  ARGUMENTS
803
- [TITLE] name of the campaign, % for wildchar
981
+ TITLE name of the campaign, % for wildchar
804
982
 
805
983
  FLAGS
806
984
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
@@ -835,7 +1013,7 @@ USAGE
835
1013
  $ proca help [COMMAND...] [-n]
836
1014
 
837
1015
  ARGUMENTS
838
- [COMMAND...] Command to show help for.
1016
+ COMMAND... Command to show help for.
839
1017
 
840
1018
  FLAGS
841
1019
  -n, --nested-commands Include all nested commands in the output.
@@ -901,8 +1079,8 @@ DESCRIPTION
901
1079
 
902
1080
  ```
903
1081
  USAGE
904
- $ proca org delete [--json | --human | --csv | --markdown] [--env <value>]
905
- [--simplify] [-i <value> | -n <org name> | -x <value>]
1082
+ $ proca org delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1083
+ <value>] [--simplify] [-i <value> | -n <org name> | -x <value>]
906
1084
 
907
1085
  FLAGS
908
1086
  -i, --id=<value>
@@ -923,22 +1101,28 @@ EXAMPLES
923
1101
 
924
1102
  ## `proca org email`
925
1103
 
926
- Set service, usually email backend for an org
1104
+ Set email service and supporter confirmation for an org
927
1105
 
928
1106
  ```
929
1107
  USAGE
930
- $ proca org email --org <value> --mailer mailjet ses stripe test_stripe system
931
- preview webhook supabase smtp [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [--from <value>]
1108
+ $ proca org email [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1109
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe
1110
+ system preview webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm]
1111
+ [--supporter-confirm-template <value>]
932
1112
 
933
1113
  FLAGS
934
- --env=<value> [default: default] allow to switch
935
- between configurations (server or users)
936
- --from=<value> Email address to send from (default:
937
- <org>@proca.app)
938
- --mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp (required) [default: MAILJET] service to
939
- send emails
940
- --org=<value> (required) organisation running the
941
- service
1114
+ -i, --id=<value>
1115
+ -n, --name=<the_short_name> name
1116
+ -x, --dxid=<value> dxid
1117
+ --env=<value> [default: default] allow to switch
1118
+ between configurations (server or
1119
+ users)
1120
+ --from=default <org>@proca.app Email address to send from
1121
+ --mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp [default: system] service to send
1122
+ emails
1123
+ --[no-]supporter-confirm enable/disable action confirmation
1124
+ emails
1125
+ --supporter-confirm-template=<value> add confirmation template
942
1126
 
943
1127
  OUTPUT FLAGS
944
1128
  --csv Format output as csv
@@ -948,7 +1132,7 @@ OUTPUT FLAGS
948
1132
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
949
1133
 
950
1134
  DESCRIPTION
951
- Set service, usually email backend for an org
1135
+ Set email service and supporter confirmation for an org
952
1136
  ```
953
1137
 
954
1138
  ## `proca org get`
@@ -957,8 +1141,8 @@ view a org
957
1141
 
958
1142
  ```
959
1143
  USAGE
960
- $ proca org get [--json | --human | --csv | --markdown] [--env <value>]
961
- [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
1144
+ $ proca org get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1145
+ <value>] [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
962
1146
 
963
1147
  FLAGS
964
1148
  -n, --name=<org name> name of the org
@@ -984,6 +1168,36 @@ EXAMPLES
984
1168
  $ proca org get <name of the ngo>
985
1169
  ```
986
1170
 
1171
+ ## `proca org user get`
1172
+
1173
+ list all the users
1174
+
1175
+ ```
1176
+ USAGE
1177
+ $ proca org user get -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1178
+ [--simplify]
1179
+
1180
+ FLAGS
1181
+ -o, --org=<value> (required) organisation
1182
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1183
+
1184
+ OUTPUT FLAGS
1185
+ --csv Format output as csv
1186
+ --human Format output to be read on screen by a human [default]
1187
+ --json Format output as json
1188
+ --markdown Format output as markdown table
1189
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1190
+
1191
+ DESCRIPTION
1192
+ list all the users
1193
+
1194
+ ALIASES
1195
+ $ proca org user get
1196
+
1197
+ EXAMPLES
1198
+ $ proca org user get %pizza%
1199
+ ```
1200
+
987
1201
  ## `proca plugins`
988
1202
 
989
1203
  List installed plugins.
@@ -1005,44 +1219,53 @@ EXAMPLES
1005
1219
  $ proca plugins
1006
1220
  ```
1007
1221
 
1008
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/index.ts)_
1222
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
1009
1223
 
1010
- ## `proca plugins:install PLUGIN...`
1224
+ ## `proca plugins add PLUGIN`
1011
1225
 
1012
- Installs a plugin into the CLI.
1226
+ Installs a plugin into proca.
1013
1227
 
1014
1228
  ```
1015
1229
  USAGE
1016
- $ proca plugins add plugins:install PLUGIN...
1230
+ $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
1017
1231
 
1018
1232
  ARGUMENTS
1019
1233
  PLUGIN... Plugin to install.
1020
1234
 
1021
1235
  FLAGS
1022
- -f, --force Run yarn install with force flag.
1236
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1023
1237
  -h, --help Show CLI help.
1024
- -v, --verbose
1238
+ -s, --silent Silences npm output.
1239
+ -v, --verbose Show verbose npm output.
1240
+
1241
+ GLOBAL FLAGS
1242
+ --json Format output as json.
1025
1243
 
1026
1244
  DESCRIPTION
1027
- Installs a plugin into the CLI.
1028
- Can be installed from npm or a git url.
1245
+ Installs a plugin into proca.
1029
1246
 
1030
- Installation of a user-installed plugin will override a core plugin.
1247
+ Uses npm to install plugins.
1031
1248
 
1032
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1033
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1034
- the CLI without the need to patch and update the whole CLI.
1249
+ Installation of a user-installed plugin will override a core plugin.
1035
1250
 
1251
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1252
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1036
1253
 
1037
1254
  ALIASES
1038
1255
  $ proca plugins add
1039
1256
 
1040
1257
  EXAMPLES
1041
- $ proca plugins:install myplugin
1258
+ Install a plugin from npm registry.
1042
1259
 
1043
- $ proca plugins:install https://github.com/someuser/someplugin
1260
+ $ proca plugins add myplugin
1044
1261
 
1045
- $ proca plugins:install someuser/someplugin
1262
+ Install a plugin from a github url.
1263
+
1264
+ $ proca plugins add https://github.com/someuser/someplugin
1265
+
1266
+ Install a plugin from a github slug.
1267
+
1268
+ $ proca plugins add someuser/someplugin
1046
1269
  ```
1047
1270
 
1048
1271
  ## `proca plugins:inspect PLUGIN...`
@@ -1067,68 +1290,79 @@ DESCRIPTION
1067
1290
  Displays installation properties of a plugin.
1068
1291
 
1069
1292
  EXAMPLES
1070
- $ proca plugins:inspect myplugin
1293
+ $ proca plugins inspect myplugin
1071
1294
  ```
1072
1295
 
1073
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/inspect.ts)_
1296
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
1074
1297
 
1075
- ## `proca plugins:install PLUGIN...`
1298
+ ## `proca plugins install PLUGIN`
1076
1299
 
1077
- Installs a plugin into the CLI.
1300
+ Installs a plugin into proca.
1078
1301
 
1079
1302
  ```
1080
1303
  USAGE
1081
- $ proca plugins install PLUGIN...
1304
+ $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
1082
1305
 
1083
1306
  ARGUMENTS
1084
1307
  PLUGIN... Plugin to install.
1085
1308
 
1086
1309
  FLAGS
1087
- -f, --force Run yarn install with force flag.
1310
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1088
1311
  -h, --help Show CLI help.
1089
- -v, --verbose
1312
+ -s, --silent Silences npm output.
1313
+ -v, --verbose Show verbose npm output.
1314
+
1315
+ GLOBAL FLAGS
1316
+ --json Format output as json.
1090
1317
 
1091
1318
  DESCRIPTION
1092
- Installs a plugin into the CLI.
1093
- Can be installed from npm or a git url.
1319
+ Installs a plugin into proca.
1094
1320
 
1095
- Installation of a user-installed plugin will override a core plugin.
1321
+ Uses npm to install plugins.
1096
1322
 
1097
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
1098
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
1099
- the CLI without the need to patch and update the whole CLI.
1323
+ Installation of a user-installed plugin will override a core plugin.
1100
1324
 
1325
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1326
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1101
1327
 
1102
1328
  ALIASES
1103
1329
  $ proca plugins add
1104
1330
 
1105
1331
  EXAMPLES
1106
- $ proca plugins:install myplugin
1332
+ Install a plugin from npm registry.
1333
+
1334
+ $ proca plugins install myplugin
1335
+
1336
+ Install a plugin from a github url.
1337
+
1338
+ $ proca plugins install https://github.com/someuser/someplugin
1107
1339
 
1108
- $ proca plugins:install https://github.com/someuser/someplugin
1340
+ Install a plugin from a github slug.
1109
1341
 
1110
- $ proca plugins:install someuser/someplugin
1342
+ $ proca plugins install someuser/someplugin
1111
1343
  ```
1112
1344
 
1113
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/install.ts)_
1345
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
1114
1346
 
1115
- ## `proca plugins:link PLUGIN`
1347
+ ## `proca plugins link PATH`
1116
1348
 
1117
1349
  Links a plugin into the CLI for development.
1118
1350
 
1119
1351
  ```
1120
1352
  USAGE
1121
- $ proca plugins link PLUGIN
1353
+ $ proca plugins link PATH [-h] [--install] [-v]
1122
1354
 
1123
1355
  ARGUMENTS
1124
1356
  PATH [default: .] path to plugin
1125
1357
 
1126
1358
  FLAGS
1127
- -h, --help Show CLI help.
1359
+ -h, --help Show CLI help.
1128
1360
  -v, --verbose
1361
+ --[no-]install Install dependencies after linking the plugin.
1129
1362
 
1130
1363
  DESCRIPTION
1131
1364
  Links a plugin into the CLI for development.
1365
+
1132
1366
  Installation of a linked plugin will override a user-installed or core plugin.
1133
1367
 
1134
1368
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -1136,21 +1370,21 @@ DESCRIPTION
1136
1370
 
1137
1371
 
1138
1372
  EXAMPLES
1139
- $ proca plugins:link myplugin
1373
+ $ proca plugins link myplugin
1140
1374
  ```
1141
1375
 
1142
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/link.ts)_
1376
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
1143
1377
 
1144
- ## `proca plugins:uninstall PLUGIN...`
1378
+ ## `proca plugins remove [PLUGIN]`
1145
1379
 
1146
1380
  Removes a plugin from the CLI.
1147
1381
 
1148
1382
  ```
1149
1383
  USAGE
1150
- $ proca plugins remove plugins:uninstall PLUGIN...
1384
+ $ proca plugins remove [PLUGIN...] [-h] [-v]
1151
1385
 
1152
1386
  ARGUMENTS
1153
- [PLUGIN] plugin to uninstall
1387
+ PLUGIN... plugin to uninstall
1154
1388
 
1155
1389
  FLAGS
1156
1390
  -h, --help Show CLI help.
@@ -1162,18 +1396,36 @@ DESCRIPTION
1162
1396
  ALIASES
1163
1397
  $ proca plugins unlink
1164
1398
  $ proca plugins remove
1399
+
1400
+ EXAMPLES
1401
+ $ proca plugins remove myplugin
1402
+ ```
1403
+
1404
+ ## `proca plugins reset`
1405
+
1406
+ Remove all user-installed and linked plugins.
1407
+
1408
+ ```
1409
+ USAGE
1410
+ $ proca plugins reset [--hard] [--reinstall]
1411
+
1412
+ FLAGS
1413
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1414
+ --reinstall Reinstall all plugins after uninstalling.
1165
1415
  ```
1166
1416
 
1167
- ## `proca plugins:uninstall PLUGIN...`
1417
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
1418
+
1419
+ ## `proca plugins uninstall [PLUGIN]`
1168
1420
 
1169
1421
  Removes a plugin from the CLI.
1170
1422
 
1171
1423
  ```
1172
1424
  USAGE
1173
- $ proca plugins uninstall PLUGIN...
1425
+ $ proca plugins uninstall [PLUGIN...] [-h] [-v]
1174
1426
 
1175
1427
  ARGUMENTS
1176
- [PLUGIN] plugin to uninstall
1428
+ PLUGIN... plugin to uninstall
1177
1429
 
1178
1430
  FLAGS
1179
1431
  -h, --help Show CLI help.
@@ -1185,20 +1437,23 @@ DESCRIPTION
1185
1437
  ALIASES
1186
1438
  $ proca plugins unlink
1187
1439
  $ proca plugins remove
1440
+
1441
+ EXAMPLES
1442
+ $ proca plugins uninstall myplugin
1188
1443
  ```
1189
1444
 
1190
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/uninstall.ts)_
1445
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
1191
1446
 
1192
- ## `proca plugins:uninstall PLUGIN...`
1447
+ ## `proca plugins unlink [PLUGIN]`
1193
1448
 
1194
1449
  Removes a plugin from the CLI.
1195
1450
 
1196
1451
  ```
1197
1452
  USAGE
1198
- $ proca plugins unlink plugins:uninstall PLUGIN...
1453
+ $ proca plugins unlink [PLUGIN...] [-h] [-v]
1199
1454
 
1200
1455
  ARGUMENTS
1201
- [PLUGIN] plugin to uninstall
1456
+ PLUGIN... plugin to uninstall
1202
1457
 
1203
1458
  FLAGS
1204
1459
  -h, --help Show CLI help.
@@ -1210,6 +1465,9 @@ DESCRIPTION
1210
1465
  ALIASES
1211
1466
  $ proca plugins unlink
1212
1467
  $ proca plugins remove
1468
+
1469
+ EXAMPLES
1470
+ $ proca plugins unlink myplugin
1213
1471
  ```
1214
1472
 
1215
1473
  ## `proca plugins update`
@@ -1228,7 +1486,7 @@ DESCRIPTION
1228
1486
  Update installed plugins.
1229
1487
  ```
1230
1488
 
1231
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.0/src/commands/plugins/update.ts)_
1489
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
1232
1490
 
1233
1491
  ## `proca service add`
1234
1492
 
@@ -1496,6 +1754,9 @@ OUTPUT FLAGS
1496
1754
  DESCRIPTION
1497
1755
  list all the users
1498
1756
 
1757
+ ALIASES
1758
+ $ proca org user get
1759
+
1499
1760
  EXAMPLES
1500
1761
  $ proca user list %pizza%
1501
1762
  ```
@@ -1540,7 +1801,7 @@ USAGE
1540
1801
  [--simplify] [--password <value>] [--url <value>]
1541
1802
 
1542
1803
  ARGUMENTS
1543
- [USER] Username (email)
1804
+ USER Username (email)
1544
1805
 
1545
1806
  FLAGS
1546
1807
  --env=<value> [default: default] allow to switch between configurations (server or users)
@@ -1617,8 +1878,8 @@ Delete a widget
1617
1878
 
1618
1879
  ```
1619
1880
  USAGE
1620
- $ proca widget delete [--json | --human | --csv | --markdown] [--env <value>]
1621
- [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1881
+ $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1882
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1622
1883
 
1623
1884
  FLAGS
1624
1885
  -i, --id=<value>
@@ -1643,8 +1904,8 @@ view a widget
1643
1904
 
1644
1905
  ```
1645
1906
  USAGE
1646
- $ proca widget get [--json | --human | --csv | --markdown] [--env <value>]
1647
- [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1907
+ $ proca widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1908
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1648
1909
 
1649
1910
  FLAGS
1650
1911
  -i, --id=<value>
@@ -1662,9 +1923,6 @@ OUTPUT FLAGS
1662
1923
 
1663
1924
  DESCRIPTION
1664
1925
  view a widget
1665
-
1666
- EXAMPLES
1667
- $ proca widget get <path of the widget>
1668
1926
  ```
1669
1927
 
1670
1928
  ## `proca widget list`
@@ -1695,4 +1953,81 @@ DESCRIPTION
1695
1953
  EXAMPLES
1696
1954
  $ proca widget list -o <organisation>
1697
1955
  ```
1956
+
1957
+ ## `proca widget rebuild`
1958
+
1959
+ (re)build a widget
1960
+
1961
+ ```
1962
+ USAGE
1963
+ $ proca widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1964
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1965
+
1966
+ FLAGS
1967
+ -i, --id=<value>
1968
+ -n, --name=<the_short_name> name
1969
+ -x, --dxid=<value> dxid
1970
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1971
+
1972
+ OUTPUT FLAGS
1973
+ --csv Format output as csv
1974
+ --human Format output to be read on screen by a human [default]
1975
+ --json Format output as json
1976
+ --markdown Format output as markdown table
1977
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1978
+
1979
+ DESCRIPTION
1980
+ (re)build a widget
1981
+
1982
+ EXAMPLES
1983
+ $ proca widget rebuild 42
1984
+
1985
+ $ proca widget rebuild climate-action/my-org/en
1986
+
1987
+ SEE ALSO:
1988
+
1989
+ $ proca campaign widget rebuild Rebuild all the widgets of a campaign
1990
+ ```
1991
+
1992
+ ## `proca widget update`
1993
+
1994
+ Update a widget's properties
1995
+
1996
+ ```
1997
+ USAGE
1998
+ $ proca widget update [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1999
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-n <widget name>] [-l <locale>] [--color <hex
2000
+ code>] [--confirm-optin] [--confirm-action] [--dry-run]
2001
+
2002
+ FLAGS
2003
+ -i, --id=<value>
2004
+ -l, --locale=<locale> change the locale
2005
+ -n, --name=<the_short_name> name
2006
+ -n, --rename=<widget name> new name for the widget
2007
+ -x, --dxid=<value> dxid
2008
+ --color=<hex code> update color (not yet implemented)
2009
+ --confirm-action add actionConfirm (check email snack) to consent.email component
2010
+ --confirm-optin add confirmOptIn (check email snack) to consent.email component
2011
+ --dry-run Show changes without updating the widget
2012
+ --env=<value> [default: default] allow to switch between configurations (server or users)
2013
+
2014
+ OUTPUT FLAGS
2015
+ --csv Format output as csv
2016
+ --human Format output to be read on screen by a human [default]
2017
+ --json Format output as json
2018
+ --markdown Format output as markdown table
2019
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
2020
+
2021
+ DESCRIPTION
2022
+ Update a widget's properties
2023
+
2024
+ EXAMPLES
2025
+ $ proca widget update 4454 --name new_widget_name
2026
+
2027
+ $ proca widget update 4454 --locale fr
2028
+
2029
+ $ proca widget update 4454 --confirm-optin
2030
+
2031
+ $ proca widget update 4454 --confirm-optin --dry-run
2032
+ ```
1698
2033
  <!-- commandsstop -->