proca 0.2.0 → 0.4.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.
Files changed (15) hide show
  1. package/README.md +272 -97
  2. package/package.json +5 -7
  3. package/src/commands/action/replay.mjs +54 -0
  4. package/src/commands/campaign/add.mjs +64 -0
  5. package/src/commands/campaign/get.mjs +2 -16
  6. package/src/commands/org/add.mjs +0 -1
  7. package/src/commands/org/crm.mjs +88 -0
  8. package/src/commands/org/get.mjs +1 -0
  9. package/src/commands/org/join.mjs +28 -1
  10. package/src/commands/widget/add.mjs +113 -0
  11. package/src/commands/widget/get.mjs +59 -0
  12. package/src/hooks/help.mjs +6 -2
  13. package/src/hooks/init.mjs +4 -2
  14. package/src/procaCommand.mjs +80 -10
  15. package/src/util/flags.mjs +16 -22
package/README.md CHANGED
@@ -18,7 +18,7 @@ $ npm install -g proca
18
18
  $ proca COMMAND
19
19
  running command...
20
20
  $ proca (--version)
21
- proca/0.2.0 linux-x64 node-v20.12.2
21
+ proca/0.4.1 linux-x64 node-v20.12.2
22
22
  $ proca --help [COMMAND]
23
23
  USAGE
24
24
  $ proca COMMAND
@@ -51,6 +51,8 @@ USAGE
51
51
  # Commands
52
52
  <!-- commands -->
53
53
  * [`proca action list [TITLE]`](#proca-action-list-title)
54
+ * [`proca action replay`](#proca-action-replay)
55
+ * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
54
56
  * [`proca campaign delete`](#proca-campaign-delete)
55
57
  * [`proca campaign get`](#proca-campaign-get)
56
58
  * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
@@ -60,6 +62,7 @@ USAGE
60
62
  * [`proca config user`](#proca-config-user)
61
63
  * [`proca help [COMMAND]`](#proca-help-command)
62
64
  * [`proca org add`](#proca-org-add)
65
+ * [`proca org crm`](#proca-org-crm)
63
66
  * [`proca org get`](#proca-org-get)
64
67
  * [`proca org join`](#proca-org-join)
65
68
  * [`proca plugins`](#proca-plugins)
@@ -75,21 +78,26 @@ USAGE
75
78
  * [`proca user get`](#proca-user-get)
76
79
  * [`proca user leave`](#proca-user-leave)
77
80
  * [`proca user list`](#proca-user-list)
81
+ * [`proca widget add`](#proca-widget-add)
82
+ * [`proca widget get`](#proca-widget-get)
78
83
  * [`proca widget list`](#proca-widget-list)
79
84
 
80
85
  ## `proca action list [TITLE]`
81
86
 
82
87
  ```
83
88
  USAGE
84
- $ proca action list [TITLE] -o <organisation name> [--simplify [--json | --csv |
85
- --table]] [-c <campaign title>] [--limit <value>] [--optin] [--testing] [--doi] [--utm]
89
+ $ proca action list [TITLE] -o <organisation name> [--csv] [--simplify []] [-i <value>
90
+ | -n <the_short_name> | -x <value>] [-c <campaign title>] [--limit <value>] [--optin] [--testing] [--doi] [--utm]
86
91
 
87
92
  ARGUMENTS
88
93
  TITLE name of the campaign, % for wildchar
89
94
 
90
95
  FLAGS
91
96
  -c, --campaign=<campaign title> name of the campaign, % for wildchar
97
+ -i, --id=<value>
98
+ -n, --name=<the_short_name> name
92
99
  -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
100
+ -x, --dxid=<value> dxid
93
101
  --doi only export the double optin actions
94
102
  --limit=<value> max number of actions
95
103
  --optin only export the optin actions
@@ -98,32 +106,83 @@ FLAGS
98
106
 
99
107
  OUTPUT FLAGS
100
108
  --csv Format output as csv
109
+ --human Format output to be read on screen by a human [default]
101
110
  --json Format output as json
102
- --simplify flatten and filter to output only the most important attributes
103
- --table Format output as table [default]
111
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
104
112
 
105
113
  EXAMPLES
106
114
  $ proca action list %pizza%
107
115
  ```
108
116
 
117
+ ## `proca action replay`
118
+
119
+ ```
120
+ USAGE
121
+ $ proca action replay -o <organisation name> [--csv] [--simplify []] [-i <value> | -n
122
+ <the_short_name> | -x <value>] [-c <campaign title>]
123
+
124
+ FLAGS
125
+ -c, --campaign=<campaign title> name of the campaign, % for wildchar
126
+ -i, --id=<value>
127
+ -n, --name=<the_short_name> name
128
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
129
+ -x, --dxid=<value> dxid
130
+
131
+ OUTPUT FLAGS
132
+ --csv Format output as csv
133
+ --human Format output to be read on screen by a human [default]
134
+ --json Format output as json
135
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
136
+
137
+ EXAMPLES
138
+ $ proca action replay %pizza%
139
+ ```
140
+
141
+ ## `proca campaign add [TITLE]`
142
+
143
+ ```
144
+ USAGE
145
+ $ proca campaign add [TITLE] [--csv] [--simplify []] [-i <value> | -n <campaign name> |
146
+ -x <value>] [-o <org name>]
147
+
148
+ ARGUMENTS
149
+ TITLE title of the campaign
150
+
151
+ FLAGS
152
+ -i, --id=<value>
153
+ -n, --name=<campaign name> name of the campaign
154
+ -o, --org=<org name> name of the coordinator
155
+ -x, --dxid=<value> dxid
156
+
157
+ OUTPUT FLAGS
158
+ --csv Format output as csv
159
+ --human Format output to be read on screen by a human [default]
160
+ --json Format output as json
161
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
162
+
163
+ EXAMPLES
164
+ $ proca campaign add -n <new_campaign> the full name of the campaign
165
+ ```
166
+
109
167
  ## `proca campaign delete`
110
168
 
111
169
  delete a campaign
112
170
 
113
171
  ```
114
172
  USAGE
115
- $ proca campaign delete [--simplify [--json | --csv | --table]] [-i <organisation name>]
116
- [-n <campaign name>]
173
+ $ proca campaign delete [--csv] [--simplify []] [-i <organisation name>] [-x <value>] [-n
174
+ <campaign name>]
117
175
 
118
176
  FLAGS
119
177
  -i, --id=<organisation name> id of the campaign
120
178
  -n, --name=<campaign name> name of the campaign
179
+ -x, --dxid=<value> dxid
121
180
 
122
181
  OUTPUT FLAGS
123
182
  --csv Format output as csv
183
+ --human Format output to be read on screen by a human [default]
124
184
  --json Format output as json
125
- --simplify flatten and filter to output only the most important attributes
126
- --table Format output as table [default]
185
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
127
186
 
128
187
  DESCRIPTION
129
188
  delete a campaign
@@ -138,21 +197,22 @@ view a campaign
138
197
 
139
198
  ```
140
199
  USAGE
141
- $ proca campaign get [--simplify [--json | --csv | --table]] [-i <organisation name>]
142
- [-n <campaign name>] [--config] [--stats] [--locale <value>]
200
+ $ proca campaign get [ID_NAME_DXID] [--csv] [--simplify []] [-i <value> | -n
201
+ <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
143
202
 
144
203
  FLAGS
145
- -i, --id=<organisation name> id of the campaign
146
- -n, --name=<campaign name> name of the campaign
147
- --[no-]config display the config
148
- --locale=<value> display a locale
149
- --[no-]stats display the stats
204
+ -i, --id=<value>
205
+ -n, --name=<the_short_name> name
206
+ -x, --dxid=<value> dxid
207
+ --[no-]config display the config
208
+ --locale=<value> display a locale
209
+ --[no-]stats display the stats
150
210
 
151
211
  OUTPUT FLAGS
152
212
  --csv Format output as csv
213
+ --human Format output to be read on screen by a human [default]
153
214
  --json Format output as json
154
- --simplify flatten and filter to output only the most important attributes
155
- --table Format output as table [default]
215
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
156
216
 
157
217
  DESCRIPTION
158
218
  view a campaign
@@ -167,22 +227,25 @@ list all the campaigns
167
227
 
168
228
  ```
169
229
  USAGE
170
- $ proca campaign list [TITLE] [--simplify [--json | --csv | --table]] [-o <organisation
171
- name>] [-t <campaign title>] [--stats]
230
+ $ proca campaign list [TITLE] [--csv] [--simplify []] [-i <value> | -n <the_short_name>
231
+ | -x <value>] [-o <organisation name>] [-t <campaign title>] [--stats]
172
232
 
173
233
  ARGUMENTS
174
234
  TITLE name of the campaign, % for wildchar
175
235
 
176
236
  FLAGS
237
+ -i, --id=<value>
238
+ -n, --name=<the_short_name> name
177
239
  -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
178
240
  -t, --title=<campaign title> name of the campaign, % for wildchar
241
+ -x, --dxid=<value> dxid
179
242
  --[no-]stats display the stats
180
243
 
181
244
  OUTPUT FLAGS
182
245
  --csv Format output as csv
246
+ --human Format output to be read on screen by a human [default]
183
247
  --json Format output as json
184
- --simplify flatten and filter to output only the most important attributes
185
- --table Format output as table [default]
248
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
186
249
 
187
250
  DESCRIPTION
188
251
  list all the campaigns
@@ -197,27 +260,30 @@ create setting to access the server authentication
197
260
 
198
261
  ```
199
262
  USAGE
200
- $ proca config add [ENVIRONMENT] --token <API-token> [--simplify [--json | --csv |
201
- --table]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
202
- [--supabase-secrey-key <value>]
263
+ $ proca config add [ENVIRONMENT] --token <API-token> [--csv] [--simplify []] [-i
264
+ <value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
265
+ [--supabase-anon-key <value>] [--supabase-secrey-key <value>]
203
266
 
204
267
  ARGUMENTS
205
268
  ENVIRONMENT [default: default] environment
206
269
 
207
270
  FLAGS
208
- --force write over an existing configuration
209
- --n8n=<n8n api> api access on the n8n server
210
- --supabase=<url> url of the supabase
211
- --supabase-anon-key=<value> anonymous key
212
- --supabase-secrey-key=<value> secret service key
213
- --token=<API-token> (required) user token on proca server
214
- --url=<url> [default: https://api.proca.app/api] url of the proca server api
271
+ -i, --id=<value>
272
+ -n, --name=<the_short_name> name
273
+ -x, --dxid=<value> dxid
274
+ --force write over an existing configuration
275
+ --n8n=<n8n api> api access on the n8n server
276
+ --supabase=<url> url of the supabase
277
+ --supabase-anon-key=<value> anonymous key
278
+ --supabase-secrey-key=<value> secret service key
279
+ --token=<API-token> (required) user token on proca server
280
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
215
281
 
216
282
  OUTPUT FLAGS
217
283
  --csv Format output as csv
284
+ --human Format output to be read on screen by a human [default]
218
285
  --json Format output as json
219
- --simplify flatten and filter to output only the most important attributes
220
- --table Format output as table [default]
286
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
221
287
 
222
288
  DESCRIPTION
223
289
  create setting to access the server authentication
@@ -235,13 +301,19 @@ get the server config
235
301
 
236
302
  ```
237
303
  USAGE
238
- $ proca config get [--simplify [--json | --csv | --table]]
304
+ $ proca config get [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
305
+ <value>]
306
+
307
+ FLAGS
308
+ -i, --id=<value>
309
+ -n, --name=<the_short_name> name
310
+ -x, --dxid=<value> dxid
239
311
 
240
312
  OUTPUT FLAGS
241
313
  --csv Format output as csv
314
+ --human Format output to be read on screen by a human [default]
242
315
  --json Format output as json
243
- --simplify flatten and filter to output only the most important attributes
244
- --table Format output as table [default]
316
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
245
317
 
246
318
  DESCRIPTION
247
319
  get the server config
@@ -253,27 +325,30 @@ create setting to access the server authentication
253
325
 
254
326
  ```
255
327
  USAGE
256
- $ proca config setup [ENVIRONMENT] --token <API-token> [--simplify [--json | --csv |
257
- --table]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
258
- [--supabase-secrey-key <value>]
328
+ $ proca config setup [ENVIRONMENT] --token <API-token> [--csv] [--simplify []] [-i
329
+ <value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
330
+ [--supabase-anon-key <value>] [--supabase-secrey-key <value>]
259
331
 
260
332
  ARGUMENTS
261
333
  ENVIRONMENT [default: default] environment
262
334
 
263
335
  FLAGS
264
- --force write over an existing configuration
265
- --n8n=<n8n api> api access on the n8n server
266
- --supabase=<url> url of the supabase
267
- --supabase-anon-key=<value> anonymous key
268
- --supabase-secrey-key=<value> secret service key
269
- --token=<API-token> (required) user token on proca server
270
- --url=<url> [default: https://api.proca.app/api] url of the proca server api
336
+ -i, --id=<value>
337
+ -n, --name=<the_short_name> name
338
+ -x, --dxid=<value> dxid
339
+ --force write over an existing configuration
340
+ --n8n=<n8n api> api access on the n8n server
341
+ --supabase=<url> url of the supabase
342
+ --supabase-anon-key=<value> anonymous key
343
+ --supabase-secrey-key=<value> secret service key
344
+ --token=<API-token> (required) user token on proca server
345
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
271
346
 
272
347
  OUTPUT FLAGS
273
348
  --csv Format output as csv
349
+ --human Format output to be read on screen by a human [default]
274
350
  --json Format output as json
275
- --simplify flatten and filter to output only the most important attributes
276
- --table Format output as table [default]
351
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
277
352
 
278
353
  DESCRIPTION
279
354
  create setting to access the server authentication
@@ -291,13 +366,19 @@ fetch the information about the current user (based on the token)
291
366
 
292
367
  ```
293
368
  USAGE
294
- $ proca config user [--simplify [--json | --csv | --table]]
369
+ $ proca config user [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
370
+ <value>]
371
+
372
+ FLAGS
373
+ -i, --id=<value>
374
+ -n, --name=<the_short_name> name
375
+ -x, --dxid=<value> dxid
295
376
 
296
377
  OUTPUT FLAGS
297
378
  --csv Format output as csv
379
+ --human Format output to be read on screen by a human [default]
298
380
  --json Format output as json
299
- --simplify flatten and filter to output only the most important attributes
300
- --table Format output as table [default]
381
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
301
382
 
302
383
  DESCRIPTION
303
384
  fetch the information about the current user (based on the token)
@@ -324,40 +405,69 @@ DESCRIPTION
324
405
  Display help for proca.
325
406
  ```
326
407
 
327
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.14/src/commands/help.ts)_
408
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
328
409
 
329
410
  ## `proca org add`
330
411
 
331
412
  ```
332
413
  USAGE
333
- $ proca org add [--simplify [--json | --csv | --table]] [--twitter <screen name>]
334
- [-n <org name>]
414
+ $ proca org add [--csv] [--simplify []] [-i <value> | -n <org name> | -x <value>]
415
+ [--twitter <screen name>]
335
416
 
336
417
  FLAGS
418
+ -i, --id=<value>
337
419
  -n, --name=<org name> name of the org
420
+ -x, --dxid=<value> dxid
338
421
  --twitter=<screen name> twitter account
339
422
 
340
423
  OUTPUT FLAGS
341
424
  --csv Format output as csv
425
+ --human Format output to be read on screen by a human [default]
342
426
  --json Format output as json
343
- --simplify flatten and filter to output only the most important attributes
344
- --table Format output as table [default]
427
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
345
428
 
346
429
  EXAMPLES
347
430
  $ proca org add --twitter <twitter of the organisation>
348
431
  ```
349
432
 
433
+ ## `proca org crm`
434
+
435
+ view a org crm synchroniser
436
+
437
+ ```
438
+ USAGE
439
+ $ proca org crm [--csv] [--simplify []] (-i <value> | -n <org name> | -x <value>)
440
+ [--synchronize]
441
+
442
+ FLAGS
443
+ -i, --id=<value>
444
+ -n, --name=<org name> (required) name of the org
445
+ -x, --dxid=<value> dxid
446
+ --[no-]synchronize enable or disable the synchronisation queue
447
+
448
+ OUTPUT FLAGS
449
+ --csv Format output as csv
450
+ --human Format output to be read on screen by a human [default]
451
+ --json Format output as json
452
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
453
+
454
+ DESCRIPTION
455
+ view a org crm synchroniser
456
+ ```
457
+
350
458
  ## `proca org get`
351
459
 
352
460
  view a org
353
461
 
354
462
  ```
355
463
  USAGE
356
- $ proca org get [--simplify [--json | --csv | --table]] [-n <org name>] [--config]
357
- [--keys] [--campaigns] [--widgets] [--users]
464
+ $ proca org get [--csv] [--simplify []] [-i <value> | -n <org name> | -x <value>]
465
+ [--config] [--keys] [--campaigns] [--widgets] [--users]
358
466
 
359
467
  FLAGS
468
+ -i, --id=<value>
360
469
  -n, --name=<org name> name of the org
470
+ -x, --dxid=<value> dxid
361
471
  --[no-]campaigns
362
472
  --[no-]config display the config
363
473
  --[no-]keys
@@ -366,9 +476,9 @@ FLAGS
366
476
 
367
477
  OUTPUT FLAGS
368
478
  --csv Format output as csv
479
+ --human Format output to be read on screen by a human [default]
369
480
  --json Format output as json
370
- --simplify flatten and filter to output only the most important attributes
371
- --table Format output as table [default]
481
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
372
482
 
373
483
  DESCRIPTION
374
484
  view a org
@@ -383,20 +493,23 @@ let a user join an organisation with a role
383
493
 
384
494
  ```
385
495
  USAGE
386
- $ proca org join [--simplify [--json | --csv | --table]] [--user <value>] [--role
387
- owner|campaigner|coordinator|translator] [-o <org name>]
496
+ $ proca org join -o <org name> [--csv] [--simplify []] [-i <value> | -n
497
+ <the_short_name> | -x <value>] [--user <value>] [--role owner|campaigner|coordinator|translator]
388
498
 
389
499
  FLAGS
390
- -o, --org=<org name> name of the org
391
- --role=<option> permission level in that org
392
- <options: owner|campaigner|coordinator|translator>
393
- --user=<value> user email
500
+ -i, --id=<value>
501
+ -n, --name=<the_short_name> name
502
+ -o, --org=<org name> (required) name of the org
503
+ -x, --dxid=<value> dxid
504
+ --role=<option> [default: campaigner] permission level in that org
505
+ <options: owner|campaigner|coordinator|translator>
506
+ --user=<value> user email
394
507
 
395
508
  OUTPUT FLAGS
396
509
  --csv Format output as csv
510
+ --human Format output to be read on screen by a human [default]
397
511
  --json Format output as json
398
- --simplify flatten and filter to output only the most important attributes
399
- --table Format output as table [default]
512
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
400
513
 
401
514
  DESCRIPTION
402
515
  let a user join an organisation with a role
@@ -426,7 +539,7 @@ EXAMPLES
426
539
  $ proca plugins
427
540
  ```
428
541
 
429
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/index.ts)_
542
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/index.ts)_
430
543
 
431
544
  ## `proca plugins add PLUGIN`
432
545
 
@@ -500,7 +613,7 @@ EXAMPLES
500
613
  $ proca plugins inspect myplugin
501
614
  ```
502
615
 
503
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/inspect.ts)_
616
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/inspect.ts)_
504
617
 
505
618
  ## `proca plugins install PLUGIN`
506
619
 
@@ -549,7 +662,7 @@ EXAMPLES
549
662
  $ proca plugins install someuser/someplugin
550
663
  ```
551
664
 
552
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/install.ts)_
665
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/install.ts)_
553
666
 
554
667
  ## `proca plugins link PATH`
555
668
 
@@ -580,7 +693,7 @@ EXAMPLES
580
693
  $ proca plugins link myplugin
581
694
  ```
582
695
 
583
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/link.ts)_
696
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/link.ts)_
584
697
 
585
698
  ## `proca plugins remove [PLUGIN]`
586
699
 
@@ -621,7 +734,7 @@ FLAGS
621
734
  --reinstall Reinstall all plugins after uninstalling.
622
735
  ```
623
736
 
624
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/reset.ts)_
737
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/reset.ts)_
625
738
 
626
739
  ## `proca plugins uninstall [PLUGIN]`
627
740
 
@@ -649,7 +762,7 @@ EXAMPLES
649
762
  $ proca plugins uninstall myplugin
650
763
  ```
651
764
 
652
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/uninstall.ts)_
765
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/uninstall.ts)_
653
766
 
654
767
  ## `proca plugins unlink [PLUGIN]`
655
768
 
@@ -693,7 +806,7 @@ DESCRIPTION
693
806
  Update installed plugins.
694
807
  ```
695
808
 
696
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/update.ts)_
809
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/update.ts)_
697
810
 
698
811
  ## `proca user get`
699
812
 
@@ -701,19 +814,21 @@ fetch the information about a user
701
814
 
702
815
  ```
703
816
  USAGE
704
- $ proca user get [--simplify [--json | --csv | --table]] [--email <value>] [-o <org
705
- name>] [-i <value>]
817
+ $ proca user get [--csv] [--simplify []] [-i <value>] [-x <value>] [-n
818
+ <the_short_name>] [--email <value>] [-o <org name>]
706
819
 
707
820
  FLAGS
708
- -i, --id=<value> id of the user
709
- -o, --org=<org name> name of the org
710
- --email=<value> user email
821
+ -i, --id=<value> id of the user
822
+ -n, --name=<the_short_name> name
823
+ -o, --org=<org name> name of the org
824
+ -x, --dxid=<value> dxid
825
+ --email=<value> user email
711
826
 
712
827
  OUTPUT FLAGS
713
828
  --csv Format output as csv
829
+ --human Format output to be read on screen by a human [default]
714
830
  --json Format output as json
715
- --simplify flatten and filter to output only the most important attributes
716
- --table Format output as table [default]
831
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
717
832
 
718
833
  DESCRIPTION
719
834
  fetch the information about a user
@@ -728,18 +843,21 @@ leave a org
728
843
 
729
844
  ```
730
845
  USAGE
731
- $ proca user leave --email <user email> -o <org name> [--simplify [--json | --csv |
732
- --table]]
846
+ $ proca user leave --email <user email> -o <org name> [--csv] [--simplify []] [-i
847
+ <value> | -n <the_short_name> | -x <value>]
733
848
 
734
849
  FLAGS
735
- -o, --org=<org name> (required) name of the org
736
- --email=<user email> (required) email
850
+ -i, --id=<value>
851
+ -n, --name=<the_short_name> name
852
+ -o, --org=<org name> (required) name of the org
853
+ -x, --dxid=<value> dxid
854
+ --email=<user email> (required) email
737
855
 
738
856
  OUTPUT FLAGS
739
857
  --csv Format output as csv
858
+ --human Format output to be read on screen by a human [default]
740
859
  --json Format output as json
741
- --simplify flatten and filter to output only the most important attributes
742
- --table Format output as table [default]
860
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
743
861
 
744
862
  DESCRIPTION
745
863
  leave a org
@@ -754,16 +872,20 @@ list all the users
754
872
 
755
873
  ```
756
874
  USAGE
757
- $ proca user list -o <value> [--simplify [--json | --csv | --table]]
875
+ $ proca user list -o <value> [--csv] [--simplify []] [-i <value> | -n
876
+ <the_short_name> | -x <value>]
758
877
 
759
878
  FLAGS
760
- -o, --org=<value> (required) organisation
879
+ -i, --id=<value>
880
+ -n, --name=<the_short_name> name
881
+ -o, --org=<value> (required) organisation
882
+ -x, --dxid=<value> dxid
761
883
 
762
884
  OUTPUT FLAGS
763
885
  --csv Format output as csv
886
+ --human Format output to be read on screen by a human [default]
764
887
  --json Format output as json
765
- --simplify flatten and filter to output only the most important attributes
766
- --table Format output as table [default]
888
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
767
889
 
768
890
  DESCRIPTION
769
891
  list all the users
@@ -772,25 +894,78 @@ EXAMPLES
772
894
  $ proca user list %pizza%
773
895
  ```
774
896
 
897
+ ## `proca widget add`
898
+
899
+ ```
900
+ USAGE
901
+ $ proca widget add -c <campaign name> [--csv] [--simplify []] [-i <value> | -n by
902
+ default <campaign>/<org>/<lang> | -x <value>] [-o <en>] [-l <en>]
903
+
904
+ FLAGS
905
+ -c, --campaign=<campaign name> (required) name of the campaign
906
+ -i, --id=<value>
907
+ -l, --lang=<en> [default: en] language
908
+ -n, --name=by default <campaign>/<org>/<lang> url slug
909
+ -o, --org=<en> organisation
910
+ -x, --dxid=<value> dxid
911
+
912
+ OUTPUT FLAGS
913
+ --csv Format output as csv
914
+ --human Format output to be read on screen by a human [default]
915
+ --json Format output as json
916
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
917
+ ```
918
+
919
+ ## `proca widget get`
920
+
921
+ view a widget
922
+
923
+ ```
924
+ USAGE
925
+ $ proca widget get [ID_NAME_DXID] [--csv] [--simplify []] [-i <value> | -n
926
+ <the_short_name> | -x <value>] [--config]
927
+
928
+ FLAGS
929
+ -i, --id=<value>
930
+ -n, --name=<the_short_name> name
931
+ -x, --dxid=<value> dxid
932
+ --[no-]config display the config
933
+
934
+ OUTPUT FLAGS
935
+ --csv Format output as csv
936
+ --human Format output to be read on screen by a human [default]
937
+ --json Format output as json
938
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
939
+
940
+ DESCRIPTION
941
+ view a widget
942
+
943
+ EXAMPLES
944
+ $ proca widget get <path of the widget>
945
+ ```
946
+
775
947
  ## `proca widget list`
776
948
 
777
949
  list all the widgets of an org or campaign
778
950
 
779
951
  ```
780
952
  USAGE
781
- $ proca widget list [--simplify [--json | --csv | --table]] [-o <organisation name>]
782
- [-c <campaign name>] [--config]
953
+ $ proca widget list [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
954
+ <value>] [-o <organisation name>] [-c <campaign name>] [--config]
783
955
 
784
956
  FLAGS
785
957
  -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
958
+ -i, --id=<value>
959
+ -n, --name=<the_short_name> name
786
960
  -o, --org=<organisation name> widgets of the organisation (coordinator or partner)
961
+ -x, --dxid=<value> dxid
787
962
  --[no-]config get the config
788
963
 
789
964
  OUTPUT FLAGS
790
965
  --csv Format output as csv
966
+ --human Format output to be read on screen by a human [default]
791
967
  --json Format output as json
792
- --simplify flatten and filter to output only the most important attributes
793
- --table Format output as table [default]
968
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
794
969
 
795
970
  DESCRIPTION
796
971
  list all the widgets of an org or campaign