proca 1.8.2 → 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 +347 -195
- package/package.json +2 -1
- package/proca-cli +2 -2
- package/src/commands/action/add.mjs +131 -131
- package/src/commands/action/confirm.mjs +44 -44
- package/src/commands/action/count.mjs +41 -41
- package/src/commands/action/list.mjs +130 -130
- package/src/commands/action/replay.mjs +30 -30
- package/src/commands/action/requeue.mjs +110 -110
- package/src/commands/campaign/add.mjs +92 -83
- package/src/commands/campaign/copy.mjs +91 -0
- package/src/commands/campaign/delete.mjs +36 -56
- package/src/commands/campaign/get.mjs +5 -0
- package/src/commands/campaign/list.mjs +98 -111
- package/src/commands/campaign/queries.graphql +14 -14
- package/src/commands/campaign/status.mjs +39 -39
- package/src/commands/campaign/widget/archive.mjs +124 -0
- package/src/commands/campaign/widget/copy.mjs +175 -0
- package/src/commands/config/add.mjs +78 -78
- package/src/commands/config/folder.mjs +30 -30
- package/src/commands/config/server.mjs +15 -15
- package/src/commands/config/set.mjs +84 -84
- package/src/commands/config/user.mjs +50 -48
- package/src/commands/contact/area/count.mjs +38 -0
- package/src/commands/contact/count.mjs +0 -1
- package/src/commands/contact/list.mjs +128 -132
- package/src/commands/org/add.mjs +51 -51
- package/src/commands/org/crm.mjs +61 -61
- package/src/commands/org/delete.mjs +31 -31
- package/src/commands/org/email.mjs +94 -66
- package/src/commands/org/get.mjs +9 -1
- package/src/commands/service/add.mjs +59 -59
- package/src/commands/service/list.mjs +15 -15
- package/src/commands/target/add.mjs +52 -52
- package/src/commands/template/add.mjs +67 -67
- package/src/commands/template/list.mjs +33 -33
- package/src/commands/user/get.mjs +60 -60
- package/src/commands/user/invite.mjs +37 -37
- package/src/commands/user/join.mjs +51 -51
- package/src/commands/user/leave.mjs +47 -47
- package/src/commands/user/reset.mjs +72 -72
- package/src/commands/widget/add.mjs +61 -70
- package/src/commands/widget/delete.mjs +27 -27
- package/src/commands/widget/external/update.mjs +52 -0
- package/src/commands/widget/get.mjs +5 -0
- package/src/commands/widget/list.mjs +7 -5
- package/src/commands/widget/update.mjs +174 -0
- package/src/config.mjs +31 -31
- package/src/generated/schema.json +10675 -10675
- package/src/hooks/help.mjs +9 -9
- package/src/hooks/init.mjs +26 -26
- package/src/procaCommand.mjs +32 -9
- package/src/urql.mjs +39 -39
- package/src/util/twitter.mjs +19 -19
- 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
|
-
|
|
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
|
-
|
|
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
|
|
|
@@ -53,24 +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
|
+
* [`proca campaign copy`](#proca-campaign-copy)
|
|
58
59
|
* [`proca campaign delete`](#proca-campaign-delete)
|
|
59
60
|
* [`proca campaign get`](#proca-campaign-get)
|
|
60
|
-
* [`proca campaign list
|
|
61
|
+
* [`proca campaign list`](#proca-campaign-list)
|
|
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)
|
|
63
66
|
* [`proca campaign widget get`](#proca-campaign-widget-get)
|
|
64
67
|
* [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
|
|
65
|
-
* [`proca config add [ENV] [
|
|
68
|
+
* [`proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-json-csv-markdown-simplify)
|
|
66
69
|
* [`proca config folder`](#proca-config-folder)
|
|
67
|
-
* [`proca config init [ENV] [
|
|
70
|
+
* [`proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-json-csv-markdown-simplify)
|
|
68
71
|
* [`proca config server`](#proca-config-server)
|
|
69
72
|
* [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
|
|
70
|
-
* [`proca config setup [ENV] [
|
|
73
|
+
* [`proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-json-csv-markdown-simplify)
|
|
71
74
|
* [`proca config user`](#proca-config-user)
|
|
75
|
+
* [`proca contact area count`](#proca-contact-area-count)
|
|
72
76
|
* [`proca contact count`](#proca-contact-count)
|
|
73
|
-
* [`proca contact list
|
|
77
|
+
* [`proca contact list`](#proca-contact-list)
|
|
74
78
|
* [`proca help [COMMAND]`](#proca-help-command)
|
|
75
79
|
* [`proca org add`](#proca-org-add)
|
|
76
80
|
* [`proca org crm`](#proca-org-crm)
|
|
@@ -103,18 +107,20 @@ you should also use the local proca-api in your [widget generator](https://githu
|
|
|
103
107
|
* [`proca user whoami`](#proca-user-whoami)
|
|
104
108
|
* [`proca widget add`](#proca-widget-add)
|
|
105
109
|
* [`proca widget delete`](#proca-widget-delete)
|
|
110
|
+
* [`proca widget external update`](#proca-widget-external-update)
|
|
106
111
|
* [`proca widget get`](#proca-widget-get)
|
|
107
112
|
* [`proca widget list`](#proca-widget-list)
|
|
108
113
|
* [`proca widget rebuild`](#proca-widget-rebuild)
|
|
114
|
+
* [`proca widget update`](#proca-widget-update)
|
|
109
115
|
|
|
110
116
|
## `proca action add`
|
|
111
117
|
|
|
112
118
|
```
|
|
113
119
|
USAGE
|
|
114
120
|
$ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
|
|
115
|
-
[--json | --
|
|
116
|
-
[--
|
|
117
|
-
|
|
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>]
|
|
118
124
|
|
|
119
125
|
FLAGS
|
|
120
126
|
-i, --id=<value> (required) widget's id
|
|
@@ -139,7 +145,6 @@ FLAGS
|
|
|
139
145
|
|
|
140
146
|
OUTPUT FLAGS
|
|
141
147
|
--csv Format output as csv
|
|
142
|
-
--human Format output to be read on screen by a human [default]
|
|
143
148
|
--json Format output as json
|
|
144
149
|
--markdown Format output as markdown table
|
|
145
150
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -158,8 +163,8 @@ Should the supporter confirm the action? it can be set either for all the widget
|
|
|
158
163
|
|
|
159
164
|
```
|
|
160
165
|
USAGE
|
|
161
|
-
$ proca action confirm [--json | --
|
|
162
|
-
|
|
166
|
+
$ proca action confirm [--json | --csv | --markdown] [--env <value>] [--simplify] [--org
|
|
167
|
+
<value>] [--campaign <value>] [--confirm] [--template <value>]
|
|
163
168
|
|
|
164
169
|
FLAGS
|
|
165
170
|
--campaign=<value> campaign collecting the action
|
|
@@ -170,7 +175,6 @@ FLAGS
|
|
|
170
175
|
|
|
171
176
|
OUTPUT FLAGS
|
|
172
177
|
--csv Format output as csv
|
|
173
|
-
--human Format output to be read on screen by a human [default]
|
|
174
178
|
--json Format output as json
|
|
175
179
|
--markdown Format output as markdown table
|
|
176
180
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -186,8 +190,8 @@ counter of actions
|
|
|
186
190
|
|
|
187
191
|
```
|
|
188
192
|
USAGE
|
|
189
|
-
$ proca action count [ID_NAME_DXID] [--json | --
|
|
190
|
-
|
|
193
|
+
$ proca action count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
194
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
191
195
|
|
|
192
196
|
FLAGS
|
|
193
197
|
-i, --id=<value>
|
|
@@ -197,7 +201,6 @@ FLAGS
|
|
|
197
201
|
|
|
198
202
|
OUTPUT FLAGS
|
|
199
203
|
--csv Format output as csv
|
|
200
|
-
--human Format output to be read on screen by a human [default]
|
|
201
204
|
--json Format output as json
|
|
202
205
|
--markdown Format output as markdown table
|
|
203
206
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -215,9 +218,9 @@ EXAMPLES
|
|
|
215
218
|
|
|
216
219
|
```
|
|
217
220
|
USAGE
|
|
218
|
-
$ proca action list [TITLE] -o <organisation name> [--json | --
|
|
219
|
-
|
|
220
|
-
[--
|
|
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 | ]
|
|
221
224
|
|
|
222
225
|
ARGUMENTS
|
|
223
226
|
TITLE name of the campaign, % for wildchar
|
|
@@ -237,7 +240,6 @@ FLAGS
|
|
|
237
240
|
|
|
238
241
|
OUTPUT FLAGS
|
|
239
242
|
--csv Format output as csv
|
|
240
|
-
--human Format output to be read on screen by a human [default]
|
|
241
243
|
--json Format output as json
|
|
242
244
|
--markdown Format output as markdown table
|
|
243
245
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -250,8 +252,8 @@ EXAMPLES
|
|
|
250
252
|
|
|
251
253
|
```
|
|
252
254
|
USAGE
|
|
253
|
-
$ proca action replay -o <organisation name> [--json | --
|
|
254
|
-
|
|
255
|
+
$ proca action replay -o <organisation name> [--json | --csv | --markdown] [--env
|
|
256
|
+
<value>] [--simplify] [-c <campaign title>]
|
|
255
257
|
|
|
256
258
|
FLAGS
|
|
257
259
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
@@ -260,7 +262,6 @@ FLAGS
|
|
|
260
262
|
|
|
261
263
|
OUTPUT FLAGS
|
|
262
264
|
--csv Format output as csv
|
|
263
|
-
--human Format output to be read on screen by a human [default]
|
|
264
265
|
--json Format output as json
|
|
265
266
|
--markdown Format output as markdown table
|
|
266
267
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -276,9 +277,9 @@ requeue actions
|
|
|
276
277
|
```
|
|
277
278
|
USAGE
|
|
278
279
|
$ proca action requeue -o <org name> -q
|
|
279
|
-
CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --
|
|
280
|
-
--
|
|
281
|
-
|
|
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]
|
|
282
283
|
|
|
283
284
|
FLAGS
|
|
284
285
|
-c, --campaign=<campaign name> name of the campaign, % for wildchar
|
|
@@ -296,7 +297,6 @@ FLAGS
|
|
|
296
297
|
|
|
297
298
|
OUTPUT FLAGS
|
|
298
299
|
--csv Format output as csv
|
|
299
|
-
--human Format output to be read on screen by a human [default]
|
|
300
300
|
--json Format output as json
|
|
301
301
|
--markdown Format output as markdown table
|
|
302
302
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -308,24 +308,21 @@ EXAMPLES
|
|
|
308
308
|
$ proca action requeue
|
|
309
309
|
```
|
|
310
310
|
|
|
311
|
-
## `proca campaign add
|
|
311
|
+
## `proca campaign add`
|
|
312
312
|
|
|
313
313
|
```
|
|
314
314
|
USAGE
|
|
315
|
-
$ proca campaign add
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
ARGUMENTS
|
|
319
|
-
TITLE title of the campaign
|
|
315
|
+
$ proca campaign add -n <campaign name> -o <org name> [--json | --csv | --markdown]
|
|
316
|
+
[--env <value>] [--simplify] [--title <value>...]
|
|
320
317
|
|
|
321
318
|
FLAGS
|
|
322
319
|
-n, --name=<campaign name> (required) name of the campaign
|
|
323
320
|
-o, --org=<org name> (required) name of the coordinator
|
|
324
321
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
322
|
+
--title=<value>... title of the campaign
|
|
325
323
|
|
|
326
324
|
OUTPUT FLAGS
|
|
327
325
|
--csv Format output as csv
|
|
328
|
-
--human Format output to be read on screen by a human [default]
|
|
329
326
|
--json Format output as json
|
|
330
327
|
--markdown Format output as markdown table
|
|
331
328
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -338,8 +335,8 @@ EXAMPLES
|
|
|
338
335
|
|
|
339
336
|
```
|
|
340
337
|
USAGE
|
|
341
|
-
$ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
|
|
342
|
-
|
|
338
|
+
$ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
|
|
339
|
+
| --markdown] [--env <value>] [--simplify]
|
|
343
340
|
|
|
344
341
|
FLAGS
|
|
345
342
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -348,7 +345,6 @@ FLAGS
|
|
|
348
345
|
|
|
349
346
|
OUTPUT FLAGS
|
|
350
347
|
--csv Format output as csv
|
|
351
|
-
--human Format output to be read on screen by a human [default]
|
|
352
348
|
--json Format output as json
|
|
353
349
|
--markdown Format output as markdown table
|
|
354
350
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -362,23 +358,58 @@ EXAMPLES
|
|
|
362
358
|
$ proca campaign close -i <campaign_id>
|
|
363
359
|
```
|
|
364
360
|
|
|
361
|
+
## `proca campaign copy`
|
|
362
|
+
|
|
363
|
+
Copy campaign settings to a new campaign
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
USAGE
|
|
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]
|
|
370
|
+
|
|
371
|
+
FLAGS
|
|
372
|
+
-i, --id=<value>
|
|
373
|
+
-n, --name=<the_short_name> name
|
|
374
|
+
-o, --org=<org name> organization for the new campaign (defaults to source campaign org)
|
|
375
|
+
-t, --to=<campaign name> (required) new campaign name
|
|
376
|
+
-x, --dxid=<value> dxid
|
|
377
|
+
--dry-run preview changes without executing
|
|
378
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
379
|
+
--title=<campaign title> title for the new campaign (defaults to source campaign title)
|
|
380
|
+
|
|
381
|
+
OUTPUT FLAGS
|
|
382
|
+
--csv Format output as csv
|
|
383
|
+
--json Format output as json
|
|
384
|
+
--markdown Format output as markdown table
|
|
385
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
386
|
+
|
|
387
|
+
DESCRIPTION
|
|
388
|
+
Copy campaign settings to a new campaign
|
|
389
|
+
|
|
390
|
+
EXAMPLES
|
|
391
|
+
$ proca campaign copy test_2025 --to test_2026
|
|
392
|
+
|
|
393
|
+
$ proca campaign copy -n old_campaign --to new_campaign -o different_org
|
|
394
|
+
```
|
|
395
|
+
|
|
365
396
|
## `proca campaign delete`
|
|
366
397
|
|
|
367
398
|
delete a campaign
|
|
368
399
|
|
|
369
400
|
```
|
|
370
401
|
USAGE
|
|
371
|
-
$ proca campaign delete [--json | --
|
|
372
|
-
[--simplify] [-i <
|
|
402
|
+
$ proca campaign delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
403
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
373
404
|
|
|
374
405
|
FLAGS
|
|
375
|
-
-i, --id=<
|
|
376
|
-
-n, --name=<
|
|
377
|
-
|
|
406
|
+
-i, --id=<value>
|
|
407
|
+
-n, --name=<the_short_name> name
|
|
408
|
+
-x, --dxid=<value> dxid
|
|
409
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
378
410
|
|
|
379
411
|
OUTPUT FLAGS
|
|
380
412
|
--csv Format output as csv
|
|
381
|
-
--human Format output to be read on screen by a human [default]
|
|
382
413
|
--json Format output as json
|
|
383
414
|
--markdown Format output as markdown table
|
|
384
415
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -387,7 +418,13 @@ DESCRIPTION
|
|
|
387
418
|
delete a campaign
|
|
388
419
|
|
|
389
420
|
EXAMPLES
|
|
421
|
+
$ proca campaign delete 42
|
|
422
|
+
|
|
390
423
|
$ proca campaign delete -i 42
|
|
424
|
+
|
|
425
|
+
$ proca campaign delete my_campaign
|
|
426
|
+
|
|
427
|
+
$ proca campaign delete -n my_campaign
|
|
391
428
|
```
|
|
392
429
|
|
|
393
430
|
## `proca campaign get`
|
|
@@ -396,8 +433,8 @@ view a campaign
|
|
|
396
433
|
|
|
397
434
|
```
|
|
398
435
|
USAGE
|
|
399
|
-
$ proca campaign get [ID_NAME_DXID] [--json | --
|
|
400
|
-
|
|
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>]
|
|
401
438
|
|
|
402
439
|
FLAGS
|
|
403
440
|
-i, --id=<value>
|
|
@@ -410,7 +447,6 @@ FLAGS
|
|
|
410
447
|
|
|
411
448
|
OUTPUT FLAGS
|
|
412
449
|
--csv Format output as csv
|
|
413
|
-
--human Format output to be read on screen by a human [default]
|
|
414
450
|
--json Format output as json
|
|
415
451
|
--markdown Format output as markdown table
|
|
416
452
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -422,36 +458,29 @@ EXAMPLES
|
|
|
422
458
|
$ proca campaign get -i 42
|
|
423
459
|
```
|
|
424
460
|
|
|
425
|
-
## `proca campaign list
|
|
461
|
+
## `proca campaign list`
|
|
426
462
|
|
|
427
463
|
list all the campaigns
|
|
428
464
|
|
|
429
465
|
```
|
|
430
466
|
USAGE
|
|
431
|
-
$ proca campaign list [
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
ARGUMENTS
|
|
435
|
-
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]
|
|
436
469
|
|
|
437
470
|
FLAGS
|
|
438
|
-
-
|
|
439
|
-
-t, --title=<campaign title
|
|
440
|
-
--env=<value>
|
|
441
|
-
--[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
|
|
442
475
|
|
|
443
476
|
OUTPUT FLAGS
|
|
444
477
|
--csv Format output as csv
|
|
445
|
-
--human Format output to be read on screen by a human [default]
|
|
446
478
|
--json Format output as json
|
|
447
479
|
--markdown Format output as markdown table
|
|
448
480
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
449
481
|
|
|
450
482
|
DESCRIPTION
|
|
451
483
|
list all the campaigns
|
|
452
|
-
|
|
453
|
-
EXAMPLES
|
|
454
|
-
$ proca campaign list %pizza%
|
|
455
484
|
```
|
|
456
485
|
|
|
457
486
|
## `proca campaign mtt`
|
|
@@ -460,9 +489,9 @@ set the mail to target (mtt) params
|
|
|
460
489
|
|
|
461
490
|
```
|
|
462
491
|
USAGE
|
|
463
|
-
$ proca campaign mtt [ID_NAME_DXID] [--json | --
|
|
464
|
-
|
|
465
|
-
|
|
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]
|
|
466
495
|
|
|
467
496
|
FLAGS
|
|
468
497
|
-i, --id=<value>
|
|
@@ -480,7 +509,6 @@ FLAGS
|
|
|
480
509
|
|
|
481
510
|
OUTPUT FLAGS
|
|
482
511
|
--csv Format output as csv
|
|
483
|
-
--human Format output to be read on screen by a human [default]
|
|
484
512
|
--json Format output as json
|
|
485
513
|
--markdown Format output as markdown table
|
|
486
514
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -496,8 +524,8 @@ EXAMPLES
|
|
|
496
524
|
|
|
497
525
|
```
|
|
498
526
|
USAGE
|
|
499
|
-
$ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
|
|
500
|
-
|
|
527
|
+
$ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json | --csv
|
|
528
|
+
| --markdown] [--env <value>] [--simplify]
|
|
501
529
|
|
|
502
530
|
FLAGS
|
|
503
531
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
@@ -506,7 +534,6 @@ FLAGS
|
|
|
506
534
|
|
|
507
535
|
OUTPUT FLAGS
|
|
508
536
|
--csv Format output as csv
|
|
509
|
-
--human Format output to be read on screen by a human [default]
|
|
510
537
|
--json Format output as json
|
|
511
538
|
--markdown Format output as markdown table
|
|
512
539
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -520,14 +547,85 @@ EXAMPLES
|
|
|
520
547
|
$ proca campaign status -i <campaign_id>
|
|
521
548
|
```
|
|
522
549
|
|
|
550
|
+
## `proca campaign widget archive`
|
|
551
|
+
|
|
552
|
+
Archive all widgets in the campaign by adding suffix
|
|
553
|
+
|
|
554
|
+
```
|
|
555
|
+
USAGE
|
|
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]
|
|
558
|
+
|
|
559
|
+
FLAGS
|
|
560
|
+
-i, --id=<value>
|
|
561
|
+
-n, --name=<the_short_name> name
|
|
562
|
+
-s, --suffix=<suffix> [default: _archive] custom suffix to append (default: _archive)
|
|
563
|
+
-x, --dxid=<value> dxid
|
|
564
|
+
--dry-run preview changes without executing
|
|
565
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
566
|
+
|
|
567
|
+
OUTPUT FLAGS
|
|
568
|
+
--csv Format output as csv
|
|
569
|
+
--json Format output as json
|
|
570
|
+
--markdown Format output as markdown table
|
|
571
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
572
|
+
|
|
573
|
+
DESCRIPTION
|
|
574
|
+
Archive all widgets in the campaign by adding suffix
|
|
575
|
+
|
|
576
|
+
EXAMPLES
|
|
577
|
+
$ proca campaign widget archive old_campaign
|
|
578
|
+
|
|
579
|
+
$ proca campaign widget archive -n old_campaign --suffix _backup
|
|
580
|
+
|
|
581
|
+
$ proca campaign widget archive old_campaign --dry-run
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
## `proca campaign widget copy`
|
|
585
|
+
|
|
586
|
+
Copy widgets from one campaign to another
|
|
587
|
+
|
|
588
|
+
```
|
|
589
|
+
USAGE
|
|
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]
|
|
592
|
+
|
|
593
|
+
FLAGS
|
|
594
|
+
-i, --id=<value>
|
|
595
|
+
-n, --name=<the_short_name> name
|
|
596
|
+
-s, --suffix=<suffix> [default: _archive] suffix to remove from widget names (e.g., _archive, -v1)
|
|
597
|
+
-t, --to=<campaign name> (required) destination campaign name
|
|
598
|
+
-x, --dxid=<value> dxid
|
|
599
|
+
--dry-run preview changes without executing
|
|
600
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
601
|
+
|
|
602
|
+
OUTPUT FLAGS
|
|
603
|
+
--csv Format output as csv
|
|
604
|
+
--json Format output as json
|
|
605
|
+
--markdown Format output as markdown table
|
|
606
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
607
|
+
|
|
608
|
+
DESCRIPTION
|
|
609
|
+
Copy widgets from one campaign to another
|
|
610
|
+
|
|
611
|
+
EXAMPLES
|
|
612
|
+
$ proca campaign widget copy old_campaign --to new_campaign
|
|
613
|
+
|
|
614
|
+
$ proca campaign widget copy -n old_campaign --to new_campaign
|
|
615
|
+
|
|
616
|
+
$ proca campaign widget copy old_campaign --to new_campaign --suffix _archive
|
|
617
|
+
|
|
618
|
+
$ proca campaign widget copy old_campaign --to new_campaign --dry-run
|
|
619
|
+
```
|
|
620
|
+
|
|
523
621
|
## `proca campaign widget get`
|
|
524
622
|
|
|
525
623
|
List widgets in a campaign
|
|
526
624
|
|
|
527
625
|
```
|
|
528
626
|
USAGE
|
|
529
|
-
$ proca campaign widget get [ID_NAME_DXID] [--json | --
|
|
530
|
-
|
|
627
|
+
$ proca campaign widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
628
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
531
629
|
|
|
532
630
|
FLAGS
|
|
533
631
|
-i, --id=<value>
|
|
@@ -537,7 +635,6 @@ FLAGS
|
|
|
537
635
|
|
|
538
636
|
OUTPUT FLAGS
|
|
539
637
|
--csv Format output as csv
|
|
540
|
-
--human Format output to be read on screen by a human [default]
|
|
541
638
|
--json Format output as json
|
|
542
639
|
--markdown Format output as markdown table
|
|
543
640
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -552,8 +649,8 @@ DESCRIPTION
|
|
|
552
649
|
|
|
553
650
|
```
|
|
554
651
|
USAGE
|
|
555
|
-
$ proca campaign widget rebuild [ID_NAME_DXID] [--json | --
|
|
556
|
-
|
|
652
|
+
$ proca campaign widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
653
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
557
654
|
|
|
558
655
|
FLAGS
|
|
559
656
|
-i, --id=<value>
|
|
@@ -563,7 +660,6 @@ FLAGS
|
|
|
563
660
|
|
|
564
661
|
OUTPUT FLAGS
|
|
565
662
|
--csv Format output as csv
|
|
566
|
-
--human Format output to be read on screen by a human [default]
|
|
567
663
|
--json Format output as json
|
|
568
664
|
--markdown Format output as markdown table
|
|
569
665
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -575,19 +671,18 @@ EXAMPLES
|
|
|
575
671
|
$ proca-cli campaign widget rebuild climate-action
|
|
576
672
|
```
|
|
577
673
|
|
|
578
|
-
## `proca config add [ENV] [
|
|
674
|
+
## `proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
579
675
|
|
|
580
676
|
create setting to access to a server
|
|
581
677
|
|
|
582
678
|
```
|
|
583
679
|
USAGE
|
|
584
|
-
$ proca config add [ENV] [
|
|
585
|
-
|
|
680
|
+
$ proca config add [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
681
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
586
682
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
587
683
|
|
|
588
684
|
ARGUMENTS
|
|
589
685
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
590
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
591
686
|
JSON Format output as json
|
|
592
687
|
CSV Format output as csv
|
|
593
688
|
MARKDOWN Format output as markdown table
|
|
@@ -602,7 +697,6 @@ FLAGS
|
|
|
602
697
|
|
|
603
698
|
OUTPUT FLAGS
|
|
604
699
|
--csv Format output as csv
|
|
605
|
-
--human Format output to be read on screen by a human [default]
|
|
606
700
|
--json Format output as json
|
|
607
701
|
--markdown Format output as markdown table
|
|
608
702
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -624,15 +718,13 @@ Check and create config folders
|
|
|
624
718
|
|
|
625
719
|
```
|
|
626
720
|
USAGE
|
|
627
|
-
$ proca config folder [--json | --
|
|
628
|
-
[--simplify]
|
|
721
|
+
$ proca config folder [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
629
722
|
|
|
630
723
|
FLAGS
|
|
631
724
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
632
725
|
|
|
633
726
|
OUTPUT FLAGS
|
|
634
727
|
--csv Format output as csv
|
|
635
|
-
--human Format output to be read on screen by a human [default]
|
|
636
728
|
--json Format output as json
|
|
637
729
|
--markdown Format output as markdown table
|
|
638
730
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -643,19 +735,18 @@ DESCRIPTION
|
|
|
643
735
|
Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
|
|
644
736
|
```
|
|
645
737
|
|
|
646
|
-
## `proca config init [ENV] [
|
|
738
|
+
## `proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
647
739
|
|
|
648
740
|
create setting to access to a server
|
|
649
741
|
|
|
650
742
|
```
|
|
651
743
|
USAGE
|
|
652
|
-
$ proca config init [ENV] [
|
|
653
|
-
|
|
744
|
+
$ proca config init [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
745
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
654
746
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
655
747
|
|
|
656
748
|
ARGUMENTS
|
|
657
749
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
658
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
659
750
|
JSON Format output as json
|
|
660
751
|
CSV Format output as csv
|
|
661
752
|
MARKDOWN Format output as markdown table
|
|
@@ -670,7 +761,6 @@ FLAGS
|
|
|
670
761
|
|
|
671
762
|
OUTPUT FLAGS
|
|
672
763
|
--csv Format output as csv
|
|
673
|
-
--human Format output to be read on screen by a human [default]
|
|
674
764
|
--json Format output as json
|
|
675
765
|
--markdown Format output as markdown table
|
|
676
766
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -692,15 +782,13 @@ get the server config
|
|
|
692
782
|
|
|
693
783
|
```
|
|
694
784
|
USAGE
|
|
695
|
-
$ proca config server [--json | --
|
|
696
|
-
[--simplify]
|
|
785
|
+
$ proca config server [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
697
786
|
|
|
698
787
|
FLAGS
|
|
699
788
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
700
789
|
|
|
701
790
|
OUTPUT FLAGS
|
|
702
791
|
--csv Format output as csv
|
|
703
|
-
--human Format output to be read on screen by a human [default]
|
|
704
792
|
--json Format output as json
|
|
705
793
|
--markdown Format output as markdown table
|
|
706
794
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -715,8 +803,8 @@ update the setting used to authenticate to the servers and services
|
|
|
715
803
|
|
|
716
804
|
```
|
|
717
805
|
USAGE
|
|
718
|
-
$ proca config set [KEY] [VALUE] [--json | --
|
|
719
|
-
|
|
806
|
+
$ proca config set [KEY] [VALUE] [--json | --csv | --markdown] [--env <value>]
|
|
807
|
+
[--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
|
|
720
808
|
|
|
721
809
|
ARGUMENTS
|
|
722
810
|
KEY variable name
|
|
@@ -730,7 +818,6 @@ FLAGS
|
|
|
730
818
|
|
|
731
819
|
OUTPUT FLAGS
|
|
732
820
|
--csv Format output as csv
|
|
733
|
-
--human Format output to be read on screen by a human [default]
|
|
734
821
|
--json Format output as json
|
|
735
822
|
--markdown Format output as markdown table
|
|
736
823
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -747,19 +834,18 @@ EXAMPLES
|
|
|
747
834
|
$ proca config set VAR1 VALUE
|
|
748
835
|
```
|
|
749
836
|
|
|
750
|
-
## `proca config setup [ENV] [
|
|
837
|
+
## `proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
|
|
751
838
|
|
|
752
839
|
create setting to access to a server
|
|
753
840
|
|
|
754
841
|
```
|
|
755
842
|
USAGE
|
|
756
|
-
$ proca config setup [ENV] [
|
|
757
|
-
|
|
843
|
+
$ proca config setup [ENV] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --csv |
|
|
844
|
+
--markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
|
|
758
845
|
you@example.org] [--folder /var/www/proca/config.example]
|
|
759
846
|
|
|
760
847
|
ARGUMENTS
|
|
761
848
|
ENV [default: default] allow to switch between configurations (server or users)
|
|
762
|
-
HUMAN [default: true] Format output to be read on screen by a human [default]
|
|
763
849
|
JSON Format output as json
|
|
764
850
|
CSV Format output as csv
|
|
765
851
|
MARKDOWN Format output as markdown table
|
|
@@ -774,7 +860,6 @@ FLAGS
|
|
|
774
860
|
|
|
775
861
|
OUTPUT FLAGS
|
|
776
862
|
--csv Format output as csv
|
|
777
|
-
--human Format output to be read on screen by a human [default]
|
|
778
863
|
--json Format output as json
|
|
779
864
|
--markdown Format output as markdown table
|
|
780
865
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -796,15 +881,13 @@ fetch the information about the current user (based on the token)
|
|
|
796
881
|
|
|
797
882
|
```
|
|
798
883
|
USAGE
|
|
799
|
-
$ proca config user [--json | --
|
|
800
|
-
[--simplify]
|
|
884
|
+
$ proca config user [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
801
885
|
|
|
802
886
|
FLAGS
|
|
803
887
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
804
888
|
|
|
805
889
|
OUTPUT FLAGS
|
|
806
890
|
--csv Format output as csv
|
|
807
|
-
--human Format output to be read on screen by a human [default]
|
|
808
891
|
--json Format output as json
|
|
809
892
|
--markdown Format output as markdown table
|
|
810
893
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -820,14 +903,42 @@ EXAMPLES
|
|
|
820
903
|
$ proca config user
|
|
821
904
|
```
|
|
822
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
|
+
|
|
823
934
|
## `proca contact count`
|
|
824
935
|
|
|
825
936
|
counter of supporters
|
|
826
937
|
|
|
827
938
|
```
|
|
828
939
|
USAGE
|
|
829
|
-
$ proca contact count [ID_NAME_DXID] [--json | --
|
|
830
|
-
|
|
940
|
+
$ proca contact count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
941
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
831
942
|
|
|
832
943
|
FLAGS
|
|
833
944
|
-i, --id=<value>
|
|
@@ -837,7 +948,6 @@ FLAGS
|
|
|
837
948
|
|
|
838
949
|
OUTPUT FLAGS
|
|
839
950
|
--csv Format output as csv
|
|
840
|
-
--human Format output to be read on screen by a human [default]
|
|
841
951
|
--json Format output as json
|
|
842
952
|
--markdown Format output as markdown table
|
|
843
953
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -846,21 +956,16 @@ DESCRIPTION
|
|
|
846
956
|
counter of supporters
|
|
847
957
|
|
|
848
958
|
EXAMPLES
|
|
849
|
-
$ proca contact count --id <id of the campaign>
|
|
850
|
-
|
|
851
959
|
$ proca contact count --name <name of the campaign>
|
|
852
960
|
```
|
|
853
961
|
|
|
854
|
-
## `proca contact list
|
|
962
|
+
## `proca contact list`
|
|
855
963
|
|
|
856
964
|
```
|
|
857
965
|
USAGE
|
|
858
|
-
$ proca contact list
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
ARGUMENTS
|
|
863
|
-
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 | ]
|
|
864
969
|
|
|
865
970
|
FLAGS
|
|
866
971
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
@@ -877,7 +982,6 @@ FLAGS
|
|
|
877
982
|
|
|
878
983
|
OUTPUT FLAGS
|
|
879
984
|
--csv Format output as csv
|
|
880
|
-
--human Format output to be read on screen by a human [default]
|
|
881
985
|
--json Format output as json
|
|
882
986
|
--markdown Format output as markdown table
|
|
883
987
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -910,8 +1014,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
|
|
|
910
1014
|
|
|
911
1015
|
```
|
|
912
1016
|
USAGE
|
|
913
|
-
$ proca org add [--json | --
|
|
914
|
-
[--
|
|
1017
|
+
$ proca org add [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1018
|
+
[--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
|
|
915
1019
|
|
|
916
1020
|
FLAGS
|
|
917
1021
|
-n, --name=<org acronym/name> short name of the org
|
|
@@ -921,7 +1025,6 @@ FLAGS
|
|
|
921
1025
|
|
|
922
1026
|
OUTPUT FLAGS
|
|
923
1027
|
--csv Format output as csv
|
|
924
|
-
--human Format output to be read on screen by a human [default]
|
|
925
1028
|
--json Format output as json
|
|
926
1029
|
--markdown Format output as markdown table
|
|
927
1030
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -938,8 +1041,8 @@ view a org crm synchroniser
|
|
|
938
1041
|
|
|
939
1042
|
```
|
|
940
1043
|
USAGE
|
|
941
|
-
$ proca org crm -n <org name> [--json | --
|
|
942
|
-
|
|
1044
|
+
$ proca org crm -n <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1045
|
+
[--simplify] [--synchronize]
|
|
943
1046
|
|
|
944
1047
|
FLAGS
|
|
945
1048
|
-n, --name=<org name> (required) name of the org
|
|
@@ -948,7 +1051,6 @@ FLAGS
|
|
|
948
1051
|
|
|
949
1052
|
OUTPUT FLAGS
|
|
950
1053
|
--csv Format output as csv
|
|
951
|
-
--human Format output to be read on screen by a human [default]
|
|
952
1054
|
--json Format output as json
|
|
953
1055
|
--markdown Format output as markdown table
|
|
954
1056
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -961,8 +1063,8 @@ DESCRIPTION
|
|
|
961
1063
|
|
|
962
1064
|
```
|
|
963
1065
|
USAGE
|
|
964
|
-
$ proca org delete [ID_NAME_DXID] [--json | --
|
|
965
|
-
|
|
1066
|
+
$ proca org delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1067
|
+
[--simplify] [-i <value> | -n <org name> | -x <value>]
|
|
966
1068
|
|
|
967
1069
|
FLAGS
|
|
968
1070
|
-i, --id=<value>
|
|
@@ -972,7 +1074,6 @@ FLAGS
|
|
|
972
1074
|
|
|
973
1075
|
OUTPUT FLAGS
|
|
974
1076
|
--csv Format output as csv
|
|
975
|
-
--human Format output to be read on screen by a human [default]
|
|
976
1077
|
--json Format output as json
|
|
977
1078
|
--markdown Format output as markdown table
|
|
978
1079
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -983,33 +1084,36 @@ EXAMPLES
|
|
|
983
1084
|
|
|
984
1085
|
## `proca org email`
|
|
985
1086
|
|
|
986
|
-
Set service
|
|
1087
|
+
Set email service and supporter confirmation for an org
|
|
987
1088
|
|
|
988
1089
|
```
|
|
989
1090
|
USAGE
|
|
990
|
-
$ proca org email [ID_NAME_DXID] --
|
|
991
|
-
|
|
992
|
-
[--
|
|
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>]
|
|
993
1094
|
|
|
994
1095
|
FLAGS
|
|
995
|
-
--
|
|
996
|
-
|
|
997
|
-
--
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1096
|
+
-i, --id=<value>
|
|
1097
|
+
-n, --name=<the_short_name> name
|
|
1098
|
+
-x, --dxid=<value> dxid
|
|
1099
|
+
--env=<value> [default: default] allow to switch
|
|
1100
|
+
between configurations (server or
|
|
1101
|
+
users)
|
|
1102
|
+
--from=default <org>@proca.app Email address to send from
|
|
1103
|
+
--mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp [default: system] service to send
|
|
1104
|
+
emails
|
|
1105
|
+
--[no-]supporter-confirm enable/disable action confirmation
|
|
1106
|
+
emails
|
|
1107
|
+
--supporter-confirm-template=<value> add confirmation template
|
|
1003
1108
|
|
|
1004
1109
|
OUTPUT FLAGS
|
|
1005
1110
|
--csv Format output as csv
|
|
1006
|
-
--human Format output to be read on screen by a human [default]
|
|
1007
1111
|
--json Format output as json
|
|
1008
1112
|
--markdown Format output as markdown table
|
|
1009
1113
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1010
1114
|
|
|
1011
1115
|
DESCRIPTION
|
|
1012
|
-
Set service
|
|
1116
|
+
Set email service and supporter confirmation for an org
|
|
1013
1117
|
```
|
|
1014
1118
|
|
|
1015
1119
|
## `proca org get`
|
|
@@ -1018,8 +1122,8 @@ view a org
|
|
|
1018
1122
|
|
|
1019
1123
|
```
|
|
1020
1124
|
USAGE
|
|
1021
|
-
$ proca org get [ID_NAME_DXID] [--json | --
|
|
1022
|
-
|
|
1125
|
+
$ proca org get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1126
|
+
[--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
|
|
1023
1127
|
|
|
1024
1128
|
FLAGS
|
|
1025
1129
|
-n, --name=<org name> name of the org
|
|
@@ -1033,7 +1137,6 @@ FLAGS
|
|
|
1033
1137
|
|
|
1034
1138
|
OUTPUT FLAGS
|
|
1035
1139
|
--csv Format output as csv
|
|
1036
|
-
--human Format output to be read on screen by a human [default]
|
|
1037
1140
|
--json Format output as json
|
|
1038
1141
|
--markdown Format output as markdown table
|
|
1039
1142
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1051,7 +1154,7 @@ list all the users
|
|
|
1051
1154
|
|
|
1052
1155
|
```
|
|
1053
1156
|
USAGE
|
|
1054
|
-
$ proca org user get -o <value> [--json | --
|
|
1157
|
+
$ proca org user get -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1055
1158
|
[--simplify]
|
|
1056
1159
|
|
|
1057
1160
|
FLAGS
|
|
@@ -1060,7 +1163,6 @@ FLAGS
|
|
|
1060
1163
|
|
|
1061
1164
|
OUTPUT FLAGS
|
|
1062
1165
|
--csv Format output as csv
|
|
1063
|
-
--human Format output to be read on screen by a human [default]
|
|
1064
1166
|
--json Format output as json
|
|
1065
1167
|
--markdown Format output as markdown table
|
|
1066
1168
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1372,7 +1474,7 @@ Set service, usually email backend for an org, the specific meaning of each para
|
|
|
1372
1474
|
```
|
|
1373
1475
|
USAGE
|
|
1374
1476
|
$ proca service add -o <value> --type
|
|
1375
|
-
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>]
|
|
1376
1478
|
[--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
|
|
1377
1479
|
|
|
1378
1480
|
FLAGS
|
|
@@ -1387,7 +1489,6 @@ FLAGS
|
|
|
1387
1489
|
|
|
1388
1490
|
OUTPUT FLAGS
|
|
1389
1491
|
--csv Format output as csv
|
|
1390
|
-
--human Format output to be read on screen by a human [default]
|
|
1391
1492
|
--json Format output as json
|
|
1392
1493
|
--markdown Format output as markdown table
|
|
1393
1494
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1402,7 +1503,7 @@ list services set for an organisation
|
|
|
1402
1503
|
|
|
1403
1504
|
```
|
|
1404
1505
|
USAGE
|
|
1405
|
-
$ proca service list -o <value> [--json | --
|
|
1506
|
+
$ proca service list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1406
1507
|
[--simplify]
|
|
1407
1508
|
|
|
1408
1509
|
FLAGS
|
|
@@ -1411,7 +1512,6 @@ FLAGS
|
|
|
1411
1512
|
|
|
1412
1513
|
OUTPUT FLAGS
|
|
1413
1514
|
--csv Format output as csv
|
|
1414
|
-
--human Format output to be read on screen by a human [default]
|
|
1415
1515
|
--json Format output as json
|
|
1416
1516
|
--markdown Format output as markdown table
|
|
1417
1517
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1424,8 +1524,8 @@ DESCRIPTION
|
|
|
1424
1524
|
|
|
1425
1525
|
```
|
|
1426
1526
|
USAGE
|
|
1427
|
-
$ proca target add -c <value> --name <value> --email <value> [--json | --
|
|
1428
|
-
--
|
|
1527
|
+
$ proca target add -c <value> --name <value> --email <value> [--json | --csv |
|
|
1528
|
+
--markdown] [--env <value>] [--simplify] [--external_id <value>]
|
|
1429
1529
|
|
|
1430
1530
|
FLAGS
|
|
1431
1531
|
-c, --campaign=<value> (required) mtt campaign to add the target
|
|
@@ -1436,7 +1536,6 @@ FLAGS
|
|
|
1436
1536
|
|
|
1437
1537
|
OUTPUT FLAGS
|
|
1438
1538
|
--csv Format output as csv
|
|
1439
|
-
--human Format output to be read on screen by a human [default]
|
|
1440
1539
|
--json Format output as json
|
|
1441
1540
|
--markdown Format output as markdown table
|
|
1442
1541
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1446,7 +1545,7 @@ OUTPUT FLAGS
|
|
|
1446
1545
|
|
|
1447
1546
|
```
|
|
1448
1547
|
USAGE
|
|
1449
|
-
$ proca template add -o <value> [--json | --
|
|
1548
|
+
$ proca template add -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1450
1549
|
[--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
|
|
1451
1550
|
'template:' + type]
|
|
1452
1551
|
|
|
@@ -1461,7 +1560,6 @@ FLAGS
|
|
|
1461
1560
|
|
|
1462
1561
|
OUTPUT FLAGS
|
|
1463
1562
|
--csv Format output as csv
|
|
1464
|
-
--human Format output to be read on screen by a human [default]
|
|
1465
1563
|
--json Format output as json
|
|
1466
1564
|
--markdown Format output as markdown table
|
|
1467
1565
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1473,7 +1571,7 @@ list services set for an organisation
|
|
|
1473
1571
|
|
|
1474
1572
|
```
|
|
1475
1573
|
USAGE
|
|
1476
|
-
$ proca template list -o <value> [--json | --
|
|
1574
|
+
$ proca template list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1477
1575
|
[--simplify]
|
|
1478
1576
|
|
|
1479
1577
|
FLAGS
|
|
@@ -1482,7 +1580,6 @@ FLAGS
|
|
|
1482
1580
|
|
|
1483
1581
|
OUTPUT FLAGS
|
|
1484
1582
|
--csv Format output as csv
|
|
1485
|
-
--human Format output to be read on screen by a human [default]
|
|
1486
1583
|
--json Format output as json
|
|
1487
1584
|
--markdown Format output as markdown table
|
|
1488
1585
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1497,8 +1594,8 @@ fetch the information about a user
|
|
|
1497
1594
|
|
|
1498
1595
|
```
|
|
1499
1596
|
USAGE
|
|
1500
|
-
$ proca user get [--json | --
|
|
1501
|
-
[--
|
|
1597
|
+
$ proca user get [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1598
|
+
[--email <value>] [-o <org name>] [-i <value>]
|
|
1502
1599
|
|
|
1503
1600
|
FLAGS
|
|
1504
1601
|
-i, --id=<value> id of the user
|
|
@@ -1508,7 +1605,6 @@ FLAGS
|
|
|
1508
1605
|
|
|
1509
1606
|
OUTPUT FLAGS
|
|
1510
1607
|
--csv Format output as csv
|
|
1511
|
-
--human Format output to be read on screen by a human [default]
|
|
1512
1608
|
--json Format output as json
|
|
1513
1609
|
--markdown Format output as markdown table
|
|
1514
1610
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1526,8 +1622,8 @@ invite a user to join an organisation with a role
|
|
|
1526
1622
|
|
|
1527
1623
|
```
|
|
1528
1624
|
USAGE
|
|
1529
|
-
$ proca user invite -o <org name> -u <user email> [--json | --
|
|
1530
|
-
|
|
1625
|
+
$ proca user invite -o <org name> -u <user email> [--json | --csv | --markdown] [--env
|
|
1626
|
+
<value>] [--simplify] [--role owner|campaigner|coordinator|translator]
|
|
1531
1627
|
|
|
1532
1628
|
FLAGS
|
|
1533
1629
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1538,7 +1634,6 @@ FLAGS
|
|
|
1538
1634
|
|
|
1539
1635
|
OUTPUT FLAGS
|
|
1540
1636
|
--csv Format output as csv
|
|
1541
|
-
--human Format output to be read on screen by a human [default]
|
|
1542
1637
|
--json Format output as json
|
|
1543
1638
|
--markdown Format output as markdown table
|
|
1544
1639
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1556,8 +1651,8 @@ let a user join an organisation with a role
|
|
|
1556
1651
|
|
|
1557
1652
|
```
|
|
1558
1653
|
USAGE
|
|
1559
|
-
$ proca user join -o <org name> [--json | --
|
|
1560
|
-
|
|
1654
|
+
$ proca user join -o <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1655
|
+
[--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
|
|
1561
1656
|
|
|
1562
1657
|
FLAGS
|
|
1563
1658
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1568,7 +1663,6 @@ FLAGS
|
|
|
1568
1663
|
|
|
1569
1664
|
OUTPUT FLAGS
|
|
1570
1665
|
--csv Format output as csv
|
|
1571
|
-
--human Format output to be read on screen by a human [default]
|
|
1572
1666
|
--json Format output as json
|
|
1573
1667
|
--markdown Format output as markdown table
|
|
1574
1668
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1586,8 +1680,8 @@ leave a org
|
|
|
1586
1680
|
|
|
1587
1681
|
```
|
|
1588
1682
|
USAGE
|
|
1589
|
-
$ proca user leave -o <org name> [--json | --
|
|
1590
|
-
|
|
1683
|
+
$ proca user leave -o <org name> [--json | --csv | --markdown] [--env <value>]
|
|
1684
|
+
[--simplify] [-u <user email>]
|
|
1591
1685
|
|
|
1592
1686
|
FLAGS
|
|
1593
1687
|
-o, --org=<org name> (required) name of the org
|
|
@@ -1596,7 +1690,6 @@ FLAGS
|
|
|
1596
1690
|
|
|
1597
1691
|
OUTPUT FLAGS
|
|
1598
1692
|
--csv Format output as csv
|
|
1599
|
-
--human Format output to be read on screen by a human [default]
|
|
1600
1693
|
--json Format output as json
|
|
1601
1694
|
--markdown Format output as markdown table
|
|
1602
1695
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1614,7 +1707,7 @@ list all the users
|
|
|
1614
1707
|
|
|
1615
1708
|
```
|
|
1616
1709
|
USAGE
|
|
1617
|
-
$ proca user list -o <value> [--json | --
|
|
1710
|
+
$ proca user list -o <value> [--json | --csv | --markdown] [--env <value>]
|
|
1618
1711
|
[--simplify]
|
|
1619
1712
|
|
|
1620
1713
|
FLAGS
|
|
@@ -1623,7 +1716,6 @@ FLAGS
|
|
|
1623
1716
|
|
|
1624
1717
|
OUTPUT FLAGS
|
|
1625
1718
|
--csv Format output as csv
|
|
1626
|
-
--human Format output to be read on screen by a human [default]
|
|
1627
1719
|
--json Format output as json
|
|
1628
1720
|
--markdown Format output as markdown table
|
|
1629
1721
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1644,15 +1736,13 @@ fetch the information about the current user (based on the token)
|
|
|
1644
1736
|
|
|
1645
1737
|
```
|
|
1646
1738
|
USAGE
|
|
1647
|
-
$ proca user me [--json | --
|
|
1648
|
-
[--simplify]
|
|
1739
|
+
$ proca user me [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1649
1740
|
|
|
1650
1741
|
FLAGS
|
|
1651
1742
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
1652
1743
|
|
|
1653
1744
|
OUTPUT FLAGS
|
|
1654
1745
|
--csv Format output as csv
|
|
1655
|
-
--human Format output to be read on screen by a human [default]
|
|
1656
1746
|
--json Format output as json
|
|
1657
1747
|
--markdown Format output as markdown table
|
|
1658
1748
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1674,8 +1764,8 @@ Reset user API token
|
|
|
1674
1764
|
|
|
1675
1765
|
```
|
|
1676
1766
|
USAGE
|
|
1677
|
-
$ proca user reset [USER] [--json | --
|
|
1678
|
-
[--
|
|
1767
|
+
$ proca user reset [USER] [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1768
|
+
[--password <value>] [--url <value>]
|
|
1679
1769
|
|
|
1680
1770
|
ARGUMENTS
|
|
1681
1771
|
USER Username (email)
|
|
@@ -1687,7 +1777,6 @@ FLAGS
|
|
|
1687
1777
|
|
|
1688
1778
|
OUTPUT FLAGS
|
|
1689
1779
|
--csv Format output as csv
|
|
1690
|
-
--human Format output to be read on screen by a human [default]
|
|
1691
1780
|
--json Format output as json
|
|
1692
1781
|
--markdown Format output as markdown table
|
|
1693
1782
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1702,15 +1791,13 @@ fetch the information about the current user (based on the token)
|
|
|
1702
1791
|
|
|
1703
1792
|
```
|
|
1704
1793
|
USAGE
|
|
1705
|
-
$ proca user whoami [--json | --
|
|
1706
|
-
[--simplify]
|
|
1794
|
+
$ proca user whoami [--json | --csv | --markdown] [--env <value>] [--simplify]
|
|
1707
1795
|
|
|
1708
1796
|
FLAGS
|
|
1709
1797
|
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
1710
1798
|
|
|
1711
1799
|
OUTPUT FLAGS
|
|
1712
1800
|
--csv Format output as csv
|
|
1713
|
-
--human Format output to be read on screen by a human [default]
|
|
1714
1801
|
--json Format output as json
|
|
1715
1802
|
--markdown Format output as markdown table
|
|
1716
1803
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1730,8 +1817,8 @@ EXAMPLES
|
|
|
1730
1817
|
|
|
1731
1818
|
```
|
|
1732
1819
|
USAGE
|
|
1733
|
-
$ proca widget add -c <campaign name> [--json | --
|
|
1734
|
-
|
|
1820
|
+
$ proca widget add -c <campaign name> [--json | --csv | --markdown] [--env <value>]
|
|
1821
|
+
[--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
|
|
1735
1822
|
|
|
1736
1823
|
FLAGS
|
|
1737
1824
|
-c, --campaign=<campaign name> (required) name of the campaign
|
|
@@ -1743,7 +1830,6 @@ FLAGS
|
|
|
1743
1830
|
|
|
1744
1831
|
OUTPUT FLAGS
|
|
1745
1832
|
--csv Format output as csv
|
|
1746
|
-
--human Format output to be read on screen by a human [default]
|
|
1747
1833
|
--json Format output as json
|
|
1748
1834
|
--markdown Format output as markdown table
|
|
1749
1835
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1755,8 +1841,8 @@ Delete a widget
|
|
|
1755
1841
|
|
|
1756
1842
|
```
|
|
1757
1843
|
USAGE
|
|
1758
|
-
$ proca widget delete [ID_NAME_DXID] [--json | --
|
|
1759
|
-
|
|
1844
|
+
$ proca widget delete [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1845
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1760
1846
|
|
|
1761
1847
|
FLAGS
|
|
1762
1848
|
-i, --id=<value>
|
|
@@ -1766,7 +1852,6 @@ FLAGS
|
|
|
1766
1852
|
|
|
1767
1853
|
OUTPUT FLAGS
|
|
1768
1854
|
--csv Format output as csv
|
|
1769
|
-
--human Format output to be read on screen by a human [default]
|
|
1770
1855
|
--json Format output as json
|
|
1771
1856
|
--markdown Format output as markdown table
|
|
1772
1857
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1775,14 +1860,43 @@ DESCRIPTION
|
|
|
1775
1860
|
Delete a widget
|
|
1776
1861
|
```
|
|
1777
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
|
+
|
|
1778
1892
|
## `proca widget get`
|
|
1779
1893
|
|
|
1780
1894
|
view a widget
|
|
1781
1895
|
|
|
1782
1896
|
```
|
|
1783
1897
|
USAGE
|
|
1784
|
-
$ proca widget get [ID_NAME_DXID] [--json | --
|
|
1785
|
-
|
|
1898
|
+
$ proca widget get [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1899
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
|
|
1786
1900
|
|
|
1787
1901
|
FLAGS
|
|
1788
1902
|
-i, --id=<value>
|
|
@@ -1793,7 +1907,6 @@ FLAGS
|
|
|
1793
1907
|
|
|
1794
1908
|
OUTPUT FLAGS
|
|
1795
1909
|
--csv Format output as csv
|
|
1796
|
-
--human Format output to be read on screen by a human [default]
|
|
1797
1910
|
--json Format output as json
|
|
1798
1911
|
--markdown Format output as markdown table
|
|
1799
1912
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1808,8 +1921,8 @@ list all the widgets of an org or campaign
|
|
|
1808
1921
|
|
|
1809
1922
|
```
|
|
1810
1923
|
USAGE
|
|
1811
|
-
$ proca widget list [--json | --
|
|
1812
|
-
|
|
1924
|
+
$ proca widget list [--json | --csv | --markdown] [--env <value>] [--simplify] [-o
|
|
1925
|
+
<organisation name>] [-c <campaign name>] [--config]
|
|
1813
1926
|
|
|
1814
1927
|
FLAGS
|
|
1815
1928
|
-c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
|
|
@@ -1819,7 +1932,6 @@ FLAGS
|
|
|
1819
1932
|
|
|
1820
1933
|
OUTPUT FLAGS
|
|
1821
1934
|
--csv Format output as csv
|
|
1822
|
-
--human Format output to be read on screen by a human [default]
|
|
1823
1935
|
--json Format output as json
|
|
1824
1936
|
--markdown Format output as markdown table
|
|
1825
1937
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1837,8 +1949,8 @@ EXAMPLES
|
|
|
1837
1949
|
|
|
1838
1950
|
```
|
|
1839
1951
|
USAGE
|
|
1840
|
-
$ proca widget rebuild [ID_NAME_DXID] [--json | --
|
|
1841
|
-
|
|
1952
|
+
$ proca widget rebuild [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
|
|
1953
|
+
[--simplify] [-i <value> | -n <the_short_name> | -x <value>]
|
|
1842
1954
|
|
|
1843
1955
|
FLAGS
|
|
1844
1956
|
-i, --id=<value>
|
|
@@ -1848,7 +1960,6 @@ FLAGS
|
|
|
1848
1960
|
|
|
1849
1961
|
OUTPUT FLAGS
|
|
1850
1962
|
--csv Format output as csv
|
|
1851
|
-
--human Format output to be read on screen by a human [default]
|
|
1852
1963
|
--json Format output as json
|
|
1853
1964
|
--markdown Format output as markdown table
|
|
1854
1965
|
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
@@ -1865,4 +1976,45 @@ EXAMPLES
|
|
|
1865
1976
|
|
|
1866
1977
|
$ proca campaign widget rebuild Rebuild all the widgets of a campaign
|
|
1867
1978
|
```
|
|
1979
|
+
|
|
1980
|
+
## `proca widget update`
|
|
1981
|
+
|
|
1982
|
+
Update a widget's properties
|
|
1983
|
+
|
|
1984
|
+
```
|
|
1985
|
+
USAGE
|
|
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]
|
|
1989
|
+
|
|
1990
|
+
FLAGS
|
|
1991
|
+
-i, --id=<value>
|
|
1992
|
+
-l, --locale=<locale> change the locale
|
|
1993
|
+
-n, --name=<the_short_name> name
|
|
1994
|
+
-n, --rename=<widget name> new name for the widget
|
|
1995
|
+
-x, --dxid=<value> dxid
|
|
1996
|
+
--color=<hex code> update color (not yet implemented)
|
|
1997
|
+
--confirm-action add actionConfirm (check email snack) to consent.email component
|
|
1998
|
+
--confirm-optin add confirmOptIn (check email snack) to consent.email component
|
|
1999
|
+
--dry-run Show changes without updating the widget
|
|
2000
|
+
--env=<value> [default: default] allow to switch between configurations (server or users)
|
|
2001
|
+
|
|
2002
|
+
OUTPUT FLAGS
|
|
2003
|
+
--csv Format output as csv
|
|
2004
|
+
--json Format output as json
|
|
2005
|
+
--markdown Format output as markdown table
|
|
2006
|
+
--[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
2007
|
+
|
|
2008
|
+
DESCRIPTION
|
|
2009
|
+
Update a widget's properties
|
|
2010
|
+
|
|
2011
|
+
EXAMPLES
|
|
2012
|
+
$ proca widget update 4454 --name new_widget_name
|
|
2013
|
+
|
|
2014
|
+
$ proca widget update 4454 --locale fr
|
|
2015
|
+
|
|
2016
|
+
$ proca widget update 4454 --confirm-optin
|
|
2017
|
+
|
|
2018
|
+
$ proca widget update 4454 --confirm-optin --dry-run
|
|
2019
|
+
```
|
|
1868
2020
|
<!-- commandsstop -->
|