proca 1.2.2 → 1.5.0

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 (17) hide show
  1. package/README.md +335 -122
  2. package/package.json +3 -2
  3. package/src/commands/action/add.mjs +169 -0
  4. package/src/commands/campaign/status.mjs +63 -0
  5. package/src/commands/config/add.mjs +53 -61
  6. package/src/commands/config/folder.mjs +42 -0
  7. package/src/commands/config/{get.mjs → server.mjs} +1 -1
  8. package/src/commands/config/user.mjs +1 -0
  9. package/src/commands/org/add.mjs +13 -3
  10. package/src/commands/org/get.mjs +42 -5
  11. package/src/commands/user/reset.mjs +83 -0
  12. package/src/commands/widget/add.mjs +1 -1
  13. package/src/config.mjs +13 -0
  14. package/src/hooks/init.mjs +22 -1
  15. package/src/procaCommand.mjs +7 -1
  16. package/src/commands/config/token.mjs +0 -34
  17. package/src/commands/widget/cache.mjs +0 -29
package/README.md CHANGED
@@ -8,17 +8,17 @@ Proca is an open-source campaign toolkit designed to empower activists and organ
8
8
 
9
9
  One of Proca's standout features is its robust support for coalition campaigns, allowing multiple organisations to collaborate seamlessly on shared initiatives. This coalition functionality enables partners to pool resources, amplify their collective voice, and reach a broader audience whilst maintaining individual branding and supporter relationships. By facilitating data sharing and joint campaign management, Proca helps coalitions to maximise their impact, streamline operations, and present a united front on critical issues, all whilst ensuring compliance with data protection regulations.
10
10
 
11
-
12
11
  ## usage
13
12
 
14
13
  ### global installation
14
+
15
15
  <!-- usage -->
16
16
  ```sh-session
17
17
  $ npm install -g proca
18
18
  $ proca COMMAND
19
19
  running command...
20
20
  $ proca (--version)
21
- proca/1.2.2 linux-x64 node-v20.12.2
21
+ proca/1.5.0 linux-x64 node-v20.12.2
22
22
  $ proca --help [COMMAND]
23
23
  USAGE
24
24
  $ proca COMMAND
@@ -28,35 +28,54 @@ USAGE
28
28
 
29
29
  ### local development
30
30
 
31
- ```sh-session
31
+ ````sh-session
32
32
  $ git clone https://github.com/fixthestatusquo/proca-cli.git
33
- $ git install
34
33
  $ cd proca-cli
35
- $./proca-cli --help
34
+ $ npm install
35
+ $ npm link # let the proca widget and other use the local version
36
+ $./proca-cli config add --env=local --url=http://localhost:4000/api
37
+ $./proca-cli config server --env=local #check if the config is working
38
+ $./proca-cli config user #check if the config is working
36
39
  ...
37
- ```
40
+
41
+ you should also use the local proca-api in your [widget generator](https://github.com/fixthestatusquo/proca)
42
+
43
+ ```sh-session
44
+ $ cd /your/path/to/proca
45
+ $ npm link proca-api
46
+ $ npm link proca # use the local proca-cli repo
47
+ ...
48
+
49
+
50
+ ````
38
51
 
39
52
  ### TOPICS
40
- - campaign Handle campaigns
53
+
54
+ - campaign Handle campaigns
41
55
  - org
42
- - config create setting to access the server authentication
56
+ - config create setting to access the server authentication
43
57
  - widget
44
58
  - supporters (counter)
45
59
 
46
60
  # Commands
61
+
47
62
  <!-- commands -->
63
+ * [`proca action add`](#proca-action-add)
48
64
  * [`proca action count`](#proca-action-count)
49
65
  * [`proca action list [TITLE]`](#proca-action-list-title)
50
66
  * [`proca action replay`](#proca-action-replay)
51
67
  * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
68
+ * [`proca campaign close`](#proca-campaign-close)
52
69
  * [`proca campaign delete`](#proca-campaign-delete)
53
70
  * [`proca campaign get`](#proca-campaign-get)
54
71
  * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
55
- * [`proca config add [ENVIRONMENT]`](#proca-config-add-environment)
56
- * [`proca config get`](#proca-config-get)
72
+ * [`proca campaign status`](#proca-campaign-status)
73
+ * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-simplify)
74
+ * [`proca config folder`](#proca-config-folder)
75
+ * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-simplify)
76
+ * [`proca config server`](#proca-config-server)
57
77
  * [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
58
- * [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
59
- * [`proca config token`](#proca-config-token)
78
+ * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-simplify)
60
79
  * [`proca config user`](#proca-config-user)
61
80
  * [`proca contact count`](#proca-contact-count)
62
81
  * [`proca contact list [TITLE]`](#proca-contact-list-title)
@@ -79,24 +98,64 @@ USAGE
79
98
  * [`proca user get`](#proca-user-get)
80
99
  * [`proca user leave`](#proca-user-leave)
81
100
  * [`proca user list`](#proca-user-list)
101
+ * [`proca user reset [USER]`](#proca-user-reset-user)
102
+ * [`proca user whoami`](#proca-user-whoami)
82
103
  * [`proca widget add`](#proca-widget-add)
83
- * [`proca widget cache`](#proca-widget-cache)
84
104
  * [`proca widget get`](#proca-widget-get)
85
105
  * [`proca widget list`](#proca-widget-list)
86
106
 
107
+ ## `proca action add`
108
+
109
+ ```
110
+ USAGE
111
+ $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
112
+ [--json | --human | --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
113
+ [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
114
+ <value>] [--utm <value>]
115
+
116
+ FLAGS
117
+ -i, --id=<value> (required) widget's id
118
+ -n, --name=<the_short_name> name
119
+ -x, --dxid=<value> dxid
120
+ --action_type=<value> [default: register]
121
+ --country=<value> 2-letter country iso code
122
+ --email=<value> (required) email
123
+ --env=<value> [default: default] allow to switch between configurations (server or users)
124
+ --firstname=<value> (required) supporter's firstname
125
+ --lastname=<value>
126
+ --locality=<value>
127
+ --optin
128
+ --region=<value>
129
+ --street=<value>
130
+ --testing
131
+ --utm=<value> utm=campaign.source.medium
132
+
133
+ OUTPUT FLAGS
134
+ --csv Format output as csv
135
+ --human Format output to be read on screen by a human [default]
136
+ --json Format output as json
137
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
138
+
139
+ EXAMPLES
140
+ $ proca action add -i <widget_id> --firstname=John --email=john@example.org
141
+
142
+ $ proca action add -i <widget_id> --firstname=John --email=john@example.org --country=FR custom1=A custom2=B
143
+ ```
144
+
87
145
  ## `proca action count`
88
146
 
89
147
  counter of actions
90
148
 
91
149
  ```
92
150
  USAGE
93
- $ proca action count [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
94
- | -n <the_short_name> | -x <value>]
151
+ $ proca action count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
152
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
95
153
 
96
154
  FLAGS
97
155
  -i, --id=<value>
98
156
  -n, --name=<the_short_name> name
99
157
  -x, --dxid=<value> dxid
158
+ --env=<value> [default: default] allow to switch between configurations (server or users)
100
159
 
101
160
  OUTPUT FLAGS
102
161
  --csv Format output as csv
@@ -117,9 +176,9 @@ EXAMPLES
117
176
 
118
177
  ```
119
178
  USAGE
120
- $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv] [-c
121
- <campaign title>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
122
- --simplify] [--comment | ]
179
+ $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
180
+ <value>] [-c <campaign title>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm
181
+ | --simplify] [--comment | ]
123
182
 
124
183
  ARGUMENTS
125
184
  TITLE name of the campaign, % for wildchar
@@ -130,6 +189,7 @@ FLAGS
130
189
  --after=2025-04-09 only actions after a date
131
190
  --[no-]comment display the comment
132
191
  --doi only export the double optin actions
192
+ --env=<value> [default: default] allow to switch between configurations (server or users)
133
193
  --limit=<value> max number of actions
134
194
  --optin only export the optin actions
135
195
  --testing also export the test actions
@@ -150,12 +210,13 @@ EXAMPLES
150
210
 
151
211
  ```
152
212
  USAGE
153
- $ proca action replay -o <organisation name> [--json | --human | --csv] [--simplify] [-c
154
- <campaign title>]
213
+ $ proca action replay -o <organisation name> [--json | --human | --csv] [--env <value>]
214
+ [--simplify] [-c <campaign title>]
155
215
 
156
216
  FLAGS
157
217
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
158
218
  -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
219
+ --env=<value> [default: default] allow to switch between configurations (server or users)
159
220
 
160
221
  OUTPUT FLAGS
161
222
  --csv Format output as csv
@@ -172,7 +233,7 @@ EXAMPLES
172
233
  ```
173
234
  USAGE
174
235
  $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human |
175
- --csv] [--simplify]
236
+ --csv] [--env <value>] [--simplify]
176
237
 
177
238
  ARGUMENTS
178
239
  TITLE title of the campaign
@@ -180,6 +241,7 @@ ARGUMENTS
180
241
  FLAGS
181
242
  -n, --name=<campaign name> (required) name of the campaign
182
243
  -o, --org=<org name> (required) name of the coordinator
244
+ --env=<value> [default: default] allow to switch between configurations (server or users)
183
245
 
184
246
  OUTPUT FLAGS
185
247
  --csv Format output as csv
@@ -191,18 +253,46 @@ EXAMPLES
191
253
  $ proca campaign add -n <new_campaign> the full name of the campaign
192
254
  ```
193
255
 
256
+ ## `proca campaign close`
257
+
258
+ ```
259
+ USAGE
260
+ $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
261
+ --human | --csv] [--env <value>] [--simplify]
262
+
263
+ FLAGS
264
+ --env=<value> [default: default] allow to switch between configurations (server or users)
265
+ --status=<option> (required) Status to set
266
+ <options: draft|live|closed|ignored>
267
+
268
+ OUTPUT FLAGS
269
+ --csv Format output as csv
270
+ --human Format output to be read on screen by a human [default]
271
+ --json Format output as json
272
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
273
+
274
+ ALIASES
275
+ $ proca campaign close
276
+
277
+ EXAMPLES
278
+ $ proca campaign close -name <campaign>
279
+
280
+ $ proca campaign close -i <campaign_id>
281
+ ```
282
+
194
283
  ## `proca campaign delete`
195
284
 
196
285
  delete a campaign
197
286
 
198
287
  ```
199
288
  USAGE
200
- $ proca campaign delete [--json | --human | --csv] [--simplify] [-i <organisation name>]
201
- [-n <campaign name>]
289
+ $ proca campaign delete [--json | --human | --csv] [--env <value>] [--simplify] [-i
290
+ <organisation name>] [-n <campaign name>]
202
291
 
203
292
  FLAGS
204
293
  -i, --id=<organisation name> id of the campaign
205
294
  -n, --name=<campaign name> name of the campaign
295
+ --env=<value> [default: default] allow to switch between configurations (server or users)
206
296
 
207
297
  OUTPUT FLAGS
208
298
  --csv Format output as csv
@@ -223,14 +313,15 @@ view a campaign
223
313
 
224
314
  ```
225
315
  USAGE
226
- $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
227
- | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
316
+ $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
317
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
228
318
 
229
319
  FLAGS
230
320
  -i, --id=<value>
231
321
  -n, --name=<the_short_name> name
232
322
  -x, --dxid=<value> dxid
233
323
  --[no-]config display the config
324
+ --env=<value> [default: default] allow to switch between configurations (server or users)
234
325
  --locale=<value> display a locale
235
326
  --[no-]stats display the stats
236
327
 
@@ -253,8 +344,8 @@ list all the campaigns
253
344
 
254
345
  ```
255
346
  USAGE
256
- $ proca campaign list [TITLE] [--json | --human | --csv] [--simplify] [-o <organisation
257
- name>] [-t <campaign title>] [--stats]
347
+ $ proca campaign list [TITLE] [--json | --human | --csv] [--env <value>] [--simplify]
348
+ [-o <organisation name>] [-t <campaign title>] [--stats]
258
349
 
259
350
  ARGUMENTS
260
351
  TITLE name of the campaign, % for wildchar
@@ -262,6 +353,7 @@ ARGUMENTS
262
353
  FLAGS
263
354
  -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
264
355
  -t, --title=<campaign title> name of the campaign, % for wildchar
356
+ --env=<value> [default: default] allow to switch between configurations (server or users)
265
357
  --[no-]stats display the stats
266
358
 
267
359
  OUTPUT FLAGS
@@ -277,27 +369,54 @@ EXAMPLES
277
369
  $ proca campaign list %pizza%
278
370
  ```
279
371
 
280
- ## `proca config add [ENVIRONMENT]`
372
+ ## `proca campaign status`
373
+
374
+ ```
375
+ USAGE
376
+ $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
377
+ --human | --csv] [--env <value>] [--simplify]
378
+
379
+ FLAGS
380
+ --env=<value> [default: default] allow to switch between configurations (server or users)
381
+ --status=<option> (required) Status to set
382
+ <options: draft|live|closed|ignored>
383
+
384
+ OUTPUT FLAGS
385
+ --csv Format output as csv
386
+ --human Format output to be read on screen by a human [default]
387
+ --json Format output as json
388
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
389
+
390
+ ALIASES
391
+ $ proca campaign close
392
+
393
+ EXAMPLES
394
+ $ proca campaign status -name <campaign>
395
+
396
+ $ proca campaign status -i <campaign_id>
397
+ ```
398
+
399
+ ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
281
400
 
282
- create setting to access the server authentication
401
+ create setting to access to a server
283
402
 
284
403
  ```
285
404
  USAGE
286
- $ proca config add [ENVIRONMENT] --token <API-token> [--json | --human | --csv]
287
- [--simplify] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
288
- [--supabase-secrey-key <value>]
405
+ $ proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
406
+ [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
289
407
 
290
408
  ARGUMENTS
291
- ENVIRONMENT [default: default] environment
409
+ ENV [default: default] allow to switch between configurations (server or users)
410
+ HUMAN [default: true] Format output to be read on screen by a human [default]
411
+ JSON Format output as json
412
+ CSV Format output as csv
413
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
292
414
 
293
415
  FLAGS
294
- --force write over an existing configuration
295
- --n8n=<n8n api> api access on the n8n server
296
- --supabase=<url> url of the supabase
297
- --supabase-anon-key=<value> anonymous key
298
- --supabase-secrey-key=<value> secret service key
299
- --token=<API-token> (required) user token on proca server
300
- --url=<url> [default: https://api.proca.app/api] url of the proca server api
416
+ --env=<value> [default: default] allow to switch between configurations (server or users)
417
+ --folder=/var/www/proca config folder (in the proca widget generator)
418
+ --token=<API-token> user token on proca server
419
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
301
420
 
302
421
  OUTPUT FLAGS
303
422
  --csv Format output as csv
@@ -306,22 +425,26 @@ OUTPUT FLAGS
306
425
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
307
426
 
308
427
  DESCRIPTION
309
- create setting to access the server authentication
428
+ create setting to access to a server
310
429
 
311
430
  ALIASES
312
431
  $ proca config setup
432
+ $ proca config init
313
433
 
314
434
  EXAMPLES
315
435
  $ proca config add --user=xavier@example.org --token=API-12345789
316
436
  ```
317
437
 
318
- ## `proca config get`
438
+ ## `proca config folder`
319
439
 
320
- get the server config
440
+ Check and create config folders
321
441
 
322
442
  ```
323
443
  USAGE
324
- $ proca config get [--json | --human | --csv] [--simplify]
444
+ $ proca config folder [--json | --human | --csv] [--env <value>] [--simplify]
445
+
446
+ FLAGS
447
+ --env=<value> [default: default] allow to switch between configurations (server or users)
325
448
 
326
449
  OUTPUT FLAGS
327
450
  --csv Format output as csv
@@ -330,26 +453,32 @@ OUTPUT FLAGS
330
453
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
331
454
 
332
455
  DESCRIPTION
333
- get the server config
456
+ Check and create config folders
457
+
458
+ Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
334
459
  ```
335
460
 
336
- ## `proca config set [KEY] [VALUE]`
461
+ ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
337
462
 
338
- update the setting used to authenticate to the servers and services
463
+ create setting to access to a server
339
464
 
340
465
  ```
341
466
  USAGE
342
- $ proca config set [KEY] [VALUE] [--json | --human | --csv] [--simplify]
343
- [--environment <value>] [--url <url>] [--token <API-token>]
467
+ $ proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
468
+ [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
344
469
 
345
470
  ARGUMENTS
346
- KEY variable name
347
- VALUE value
471
+ ENV [default: default] allow to switch between configurations (server or users)
472
+ HUMAN [default: true] Format output to be read on screen by a human [default]
473
+ JSON Format output as json
474
+ CSV Format output as csv
475
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
348
476
 
349
477
  FLAGS
350
- --environment=<value> [default: default] environment
351
- --token=<API-token> user token on proca server
352
- --url=<url> [default: https://api.proca.app/api] url of the proca server api
478
+ --env=<value> [default: default] allow to switch between configurations (server or users)
479
+ --folder=/var/www/proca config folder (in the proca widget generator)
480
+ --token=<API-token> user token on proca server
481
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
353
482
 
354
483
  OUTPUT FLAGS
355
484
  --csv Format output as csv
@@ -358,38 +487,55 @@ OUTPUT FLAGS
358
487
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
359
488
 
360
489
  DESCRIPTION
361
- update the setting used to authenticate to the servers and services
490
+ create setting to access to a server
362
491
 
363
492
  ALIASES
364
493
  $ proca config setup
494
+ $ proca config init
365
495
 
366
496
  EXAMPLES
367
- $ proca config set --user=xavier@example.org --token=API-12345789
497
+ $ proca config init --user=xavier@example.org --token=API-12345789
498
+ ```
368
499
 
369
- $ proca config set VAR1 VALUE
500
+ ## `proca config server`
501
+
502
+ get the server config
503
+
504
+ ```
505
+ USAGE
506
+ $ proca config server [--json | --human | --csv] [--env <value>] [--simplify]
507
+
508
+ FLAGS
509
+ --env=<value> [default: default] allow to switch between configurations (server or users)
510
+
511
+ OUTPUT FLAGS
512
+ --csv Format output as csv
513
+ --human Format output to be read on screen by a human [default]
514
+ --json Format output as json
515
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
516
+
517
+ DESCRIPTION
518
+ get the server config
370
519
  ```
371
520
 
372
- ## `proca config setup [ENVIRONMENT]`
521
+ ## `proca config set [KEY] [VALUE]`
373
522
 
374
- create setting to access the server authentication
523
+ update the setting used to authenticate to the servers and services
375
524
 
376
525
  ```
377
526
  USAGE
378
- $ proca config setup [ENVIRONMENT] --token <API-token> [--json | --human | --csv]
379
- [--simplify] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
380
- [--supabase-secrey-key <value>]
527
+ $ proca config set [KEY] [VALUE] [--json | --human | --csv] [--env <value>]
528
+ [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
381
529
 
382
530
  ARGUMENTS
383
- ENVIRONMENT [default: default] environment
531
+ KEY variable name
532
+ VALUE value
384
533
 
385
534
  FLAGS
386
- --force write over an existing configuration
387
- --n8n=<n8n api> api access on the n8n server
388
- --supabase=<url> url of the supabase
389
- --supabase-anon-key=<value> anonymous key
390
- --supabase-secrey-key=<value> secret service key
391
- --token=<API-token> (required) user token on proca server
392
- --url=<url> [default: https://api.proca.app/api] url of the proca server api
535
+ --env=<value> [default: default] allow to switch between configurations (server or users)
536
+ --environment=<value> [default: default] environment
537
+ --token=<API-token> user token on proca server
538
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
393
539
 
394
540
  OUTPUT FLAGS
395
541
  --csv Format output as csv
@@ -398,25 +544,38 @@ OUTPUT FLAGS
398
544
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
399
545
 
400
546
  DESCRIPTION
401
- create setting to access the server authentication
547
+ update the setting used to authenticate to the servers and services
402
548
 
403
549
  ALIASES
404
550
  $ proca config setup
405
551
 
406
552
  EXAMPLES
407
- $ proca config setup --user=xavier@example.org --token=API-12345789
553
+ $ proca config set --user=xavier@example.org --token=API-12345789
554
+
555
+ $ proca config set VAR1 VALUE
408
556
  ```
409
557
 
410
- ## `proca config token`
558
+ ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`
411
559
 
412
- convert between token and sql value
560
+ create setting to access to a server
413
561
 
414
562
  ```
415
563
  USAGE
416
- $ proca config token [--json | --human | --csv] [--simplify] [--token API-xxx]
564
+ $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
565
+ [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
566
+
567
+ ARGUMENTS
568
+ ENV [default: default] allow to switch between configurations (server or users)
569
+ HUMAN [default: true] Format output to be read on screen by a human [default]
570
+ JSON Format output as json
571
+ CSV Format output as csv
572
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
417
573
 
418
574
  FLAGS
419
- --token=API-xxx the token in your config
575
+ --env=<value> [default: default] allow to switch between configurations (server or users)
576
+ --folder=/var/www/proca config folder (in the proca widget generator)
577
+ --token=<API-token> user token on proca server
578
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
420
579
 
421
580
  OUTPUT FLAGS
422
581
  --csv Format output as csv
@@ -425,7 +584,14 @@ OUTPUT FLAGS
425
584
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
426
585
 
427
586
  DESCRIPTION
428
- convert between token and sql value
587
+ create setting to access to a server
588
+
589
+ ALIASES
590
+ $ proca config setup
591
+ $ proca config init
592
+
593
+ EXAMPLES
594
+ $ proca config setup --user=xavier@example.org --token=API-12345789
429
595
  ```
430
596
 
431
597
  ## `proca config user`
@@ -434,7 +600,10 @@ fetch the information about the current user (based on the token)
434
600
 
435
601
  ```
436
602
  USAGE
437
- $ proca config user [--json | --human | --csv] [--simplify]
603
+ $ proca config user [--json | --human | --csv] [--env <value>] [--simplify]
604
+
605
+ FLAGS
606
+ --env=<value> [default: default] allow to switch between configurations (server or users)
438
607
 
439
608
  OUTPUT FLAGS
440
609
  --csv Format output as csv
@@ -445,6 +614,9 @@ OUTPUT FLAGS
445
614
  DESCRIPTION
446
615
  fetch the information about the current user (based on the token)
447
616
 
617
+ ALIASES
618
+ $ proca user whoami
619
+
448
620
  EXAMPLES
449
621
  $ proca config user
450
622
  ```
@@ -455,13 +627,14 @@ counter of supporters
455
627
 
456
628
  ```
457
629
  USAGE
458
- $ proca contact count [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
459
- | -n <the_short_name> | -x <value>]
630
+ $ proca contact count [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
631
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
460
632
 
461
633
  FLAGS
462
634
  -i, --id=<value>
463
635
  -n, --name=<the_short_name> name
464
636
  -x, --dxid=<value> dxid
637
+ --env=<value> [default: default] allow to switch between configurations (server or users)
465
638
 
466
639
  OUTPUT FLAGS
467
640
  --csv Format output as csv
@@ -482,9 +655,9 @@ EXAMPLES
482
655
 
483
656
  ```
484
657
  USAGE
485
- $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv] [-c
486
- <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm | --simplify]
487
- [--comment | ]
658
+ $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
659
+ <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm |
660
+ --simplify] [--comment | ]
488
661
 
489
662
  ARGUMENTS
490
663
  TITLE name of the campaign, % for wildchar
@@ -496,6 +669,7 @@ FLAGS
496
669
  --after=2025-04-09 only actions after a date
497
670
  --[no-]comment display the comment
498
671
  --doi only export the double optin actions
672
+ --env=<value> [default: default] allow to switch between configurations (server or users)
499
673
  --optin only export the optin actions
500
674
  --testing also export the test actions
501
675
  --today only actions today
@@ -535,12 +709,14 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.2
535
709
 
536
710
  ```
537
711
  USAGE
538
- $ proca org add [--json | --human | --csv] [--simplify] [--twitter <screen name>]
539
- [-n <org name>]
712
+ $ proca org add [--json | --human | --csv] [--env <value>] [--simplify] [--twitter
713
+ <screen name>] [-n <org acronym/name>] [-t <org full name>]
540
714
 
541
715
  FLAGS
542
- -n, --name=<org name> name of the org
543
- --twitter=<screen name> twitter account
716
+ -n, --name=<org acronym/name> short name of the org
717
+ -t, --title=<org full name> title/full name of the org
718
+ --env=<value> [default: default] allow to switch between configurations (server or users)
719
+ --twitter=<screen name> twitter account
544
720
 
545
721
  OUTPUT FLAGS
546
722
  --csv Format output as csv
@@ -549,6 +725,8 @@ OUTPUT FLAGS
549
725
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
550
726
 
551
727
  EXAMPLES
728
+ $ proca org add --name <twitter of the organisation> --title='this is an organisation'
729
+
552
730
  $ proca org add --twitter <twitter of the organisation>
553
731
  ```
554
732
 
@@ -558,11 +736,12 @@ view a org crm synchroniser
558
736
 
559
737
  ```
560
738
  USAGE
561
- $ proca org crm -n <org name> [--json | --human | --csv] [--simplify]
562
- [--synchronize]
739
+ $ proca org crm -n <org name> [--json | --human | --csv] [--env <value>]
740
+ [--simplify] [--synchronize]
563
741
 
564
742
  FLAGS
565
743
  -n, --name=<org name> (required) name of the org
744
+ --env=<value> [default: default] allow to switch between configurations (server or users)
566
745
  --[no-]synchronize enable or disable the synchronisation queue
567
746
 
568
747
  OUTPUT FLAGS
@@ -579,13 +758,14 @@ DESCRIPTION
579
758
 
580
759
  ```
581
760
  USAGE
582
- $ proca org delete [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
583
- | -n <org name> | -x <value>]
761
+ $ proca org delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
762
+ [--simplify] [-i <value> | -n <org name> | -x <value>]
584
763
 
585
764
  FLAGS
586
765
  -i, --id=<value>
587
766
  -n, --name=<org name> name of the org
588
767
  -x, --dxid=<value> dxid
768
+ --env=<value> [default: default] allow to switch between configurations (server or users)
589
769
 
590
770
  OUTPUT FLAGS
591
771
  --csv Format output as csv
@@ -603,16 +783,16 @@ view a org
603
783
 
604
784
  ```
605
785
  USAGE
606
- $ proca org get [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-n <org
607
- name>] [--config] [--keys] [--campaigns] [--widgets] [--users]
786
+ $ proca org get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
787
+ [--simplify] [-n <org name>] [--config] [--keys] [--campaigns] [--users]
608
788
 
609
789
  FLAGS
610
790
  -n, --name=<org name> name of the org
611
791
  --[no-]campaigns
612
792
  --[no-]config display the config
793
+ --env=<value> [default: default] allow to switch between configurations (server or users)
613
794
  --[no-]keys
614
795
  --[no-]users
615
- --[no-]widgets
616
796
 
617
797
  OUTPUT FLAGS
618
798
  --csv Format output as csv
@@ -633,11 +813,12 @@ let a user join an organisation with a role
633
813
 
634
814
  ```
635
815
  USAGE
636
- $ proca org join -o <org name> [--json | --human | --csv] [--simplify] [--user
637
- <value>] [--role owner|campaigner|coordinator|translator]
816
+ $ proca org join -o <org name> [--json | --human | --csv] [--env <value>]
817
+ [--simplify] [--user <value>] [--role owner|campaigner|coordinator|translator]
638
818
 
639
819
  FLAGS
640
820
  -o, --org=<org name> (required) name of the org
821
+ --env=<value> [default: default] allow to switch between configurations (server or users)
641
822
  --role=<option> [default: campaigner] permission level in that org
642
823
  <options: owner|campaigner|coordinator|translator>
643
824
  --user=<value> user email
@@ -951,13 +1132,14 @@ fetch the information about a user
951
1132
 
952
1133
  ```
953
1134
  USAGE
954
- $ proca user get [--json | --human | --csv] [--simplify] [--email <value>] [-o <org
955
- name>] [-i <value>]
1135
+ $ proca user get [--json | --human | --csv] [--env <value>] [--simplify] [--email
1136
+ <value>] [-o <org name>] [-i <value>]
956
1137
 
957
1138
  FLAGS
958
1139
  -i, --id=<value> id of the user
959
1140
  -o, --org=<org name> name of the org
960
1141
  --email=<value> user email
1142
+ --env=<value> [default: default] allow to switch between configurations (server or users)
961
1143
 
962
1144
  OUTPUT FLAGS
963
1145
  --csv Format output as csv
@@ -979,11 +1161,12 @@ leave a org
979
1161
  ```
980
1162
  USAGE
981
1163
  $ proca user leave --email <user email> -o <org name> [--json | --human | --csv]
982
- [--simplify]
1164
+ [--env <value>] [--simplify]
983
1165
 
984
1166
  FLAGS
985
1167
  -o, --org=<org name> (required) name of the org
986
1168
  --email=<user email> (required) email
1169
+ --env=<value> [default: default] allow to switch between configurations (server or users)
987
1170
 
988
1171
  OUTPUT FLAGS
989
1172
  --csv Format output as csv
@@ -1004,10 +1187,12 @@ list all the users
1004
1187
 
1005
1188
  ```
1006
1189
  USAGE
1007
- $ proca user list -o <value> [--json | --human | --csv] [--simplify]
1190
+ $ proca user list -o <value> [--json | --human | --csv] [--env <value>]
1191
+ [--simplify]
1008
1192
 
1009
1193
  FLAGS
1010
1194
  -o, --org=<value> (required) organisation
1195
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1011
1196
 
1012
1197
  OUTPUT FLAGS
1013
1198
  --csv Format output as csv
@@ -1022,40 +1207,43 @@ EXAMPLES
1022
1207
  $ proca user list %pizza%
1023
1208
  ```
1024
1209
 
1025
- ## `proca widget add`
1210
+ ## `proca user reset [USER]`
1211
+
1212
+ Reset user API token
1026
1213
 
1027
1214
  ```
1028
1215
  USAGE
1029
- $ proca widget add -c <campaign name> [--json | --human | --csv] [--simplify] [-o
1030
- <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1216
+ $ proca user reset [USER] [--json | --human | --csv] [--env <value>] [--simplify]
1217
+ [--password <value>] [--url <value>]
1218
+
1219
+ ARGUMENTS
1220
+ USER Username (email)
1031
1221
 
1032
1222
  FLAGS
1033
- -c, --campaign=<campaign name> (required) name of the campaign
1034
- -l, --lang=<en> [default: en] language
1035
- -n, --name=by default <campaign>/<org>/<lang> url slug
1036
- -o, --org=<en> organisation
1223
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1224
+ --password=<value> Password
1225
+ --url=<value> URL of the Proca server API
1037
1226
 
1038
1227
  OUTPUT FLAGS
1039
1228
  --csv Format output as csv
1040
1229
  --human Format output to be read on screen by a human [default]
1041
1230
  --json Format output as json
1042
1231
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1232
+
1233
+ DESCRIPTION
1234
+ Reset user API token
1043
1235
  ```
1044
1236
 
1045
- ## `proca widget cache`
1237
+ ## `proca user whoami`
1046
1238
 
1047
- clear the cdn cache of a widget
1239
+ fetch the information about the current user (based on the token)
1048
1240
 
1049
1241
  ```
1050
1242
  USAGE
1051
- $ proca widget cache [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
1052
- | -n <the_short_name> | -x <value>] [--url <value>]
1243
+ $ proca user whoami [--json | --human | --csv] [--env <value>] [--simplify]
1053
1244
 
1054
1245
  FLAGS
1055
- -i, --id=<value>
1056
- -n, --name=<the_short_name> name
1057
- -x, --dxid=<value> dxid
1058
- --url=<value> url of the widget on the CDN
1246
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1059
1247
 
1060
1248
  OUTPUT FLAGS
1061
1249
  --csv Format output as csv
@@ -1064,12 +1252,35 @@ OUTPUT FLAGS
1064
1252
  --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1065
1253
 
1066
1254
  DESCRIPTION
1067
- clear the cdn cache of a widget
1255
+ fetch the information about the current user (based on the token)
1256
+
1257
+ ALIASES
1258
+ $ proca user whoami
1068
1259
 
1069
1260
  EXAMPLES
1070
- $ proca widget cache --url https://cdn.proca.app/d/[campaign]/[org]/[locale]
1261
+ $ proca user whoami
1262
+ ```
1263
+
1264
+ ## `proca widget add`
1265
+
1266
+ ```
1267
+ USAGE
1268
+ $ proca widget add -c <campaign name> [--json | --human | --csv] [--env <value>]
1269
+ [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
1270
+
1271
+ FLAGS
1272
+ -c, --campaign=<campaign name> (required) name of the campaign
1273
+ -l, --lang=<en> [default: en] language
1274
+ -n, --name=by default <campaign>/<org>/<lang> url slug
1275
+ -o, --org=<en> organisation
1276
+ --env=<value> [default: default] allow to switch between configurations (server or
1277
+ users)
1071
1278
 
1072
- $ proca widget cache --name [campaign]/[org]/[locale]
1279
+ OUTPUT FLAGS
1280
+ --csv Format output as csv
1281
+ --human Format output to be read on screen by a human [default]
1282
+ --json Format output as json
1283
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1073
1284
  ```
1074
1285
 
1075
1286
  ## `proca widget get`
@@ -1078,14 +1289,15 @@ view a widget
1078
1289
 
1079
1290
  ```
1080
1291
  USAGE
1081
- $ proca widget get [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
1082
- | -n <the_short_name> | -x <value>] [--config]
1292
+ $ proca widget get [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
1293
+ [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
1083
1294
 
1084
1295
  FLAGS
1085
1296
  -i, --id=<value>
1086
1297
  -n, --name=<the_short_name> name
1087
1298
  -x, --dxid=<value> dxid
1088
1299
  --[no-]config display the config
1300
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1089
1301
 
1090
1302
  OUTPUT FLAGS
1091
1303
  --csv Format output as csv
@@ -1106,13 +1318,14 @@ list all the widgets of an org or campaign
1106
1318
 
1107
1319
  ```
1108
1320
  USAGE
1109
- $ proca widget list [--json | --human | --csv] [--simplify] [-o <organisation name>]
1110
- [-c <campaign name>] [--config]
1321
+ $ proca widget list [--json | --human | --csv] [--env <value>] [--simplify] [-o
1322
+ <organisation name>] [-c <campaign name>] [--config]
1111
1323
 
1112
1324
  FLAGS
1113
1325
  -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
1114
1326
  -o, --org=<organisation name> widgets of the organisation (coordinator or partner)
1115
1327
  --[no-]config get the config
1328
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1116
1329
 
1117
1330
  OUTPUT FLAGS
1118
1331
  --csv Format output as csv