proca 0.8.1 → 1.1.4

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 (104) hide show
  1. package/README.md +1027 -28
  2. package/package.json +94 -101
  3. package/proca-cli +8 -0
  4. package/src/commands/action/count.mjs +61 -0
  5. package/src/commands/action/list.mjs +189 -0
  6. package/src/commands/action/replay.mjs +54 -0
  7. package/src/commands/campaign/add.mjs +101 -0
  8. package/src/commands/campaign/delete.mjs +61 -0
  9. package/src/commands/campaign/get.mjs +107 -0
  10. package/src/commands/campaign/list.mjs +156 -0
  11. package/src/commands/campaign/queries.graphql +19 -0
  12. package/src/commands/config/add.mjs +101 -0
  13. package/src/commands/config/get.mjs +33 -0
  14. package/src/commands/config/set.mjs +103 -0
  15. package/src/commands/config/user.mjs +76 -0
  16. package/src/commands/org/add.mjs +66 -0
  17. package/src/commands/org/crm.mjs +88 -0
  18. package/src/commands/org/delete.mjs +48 -0
  19. package/src/commands/org/get.mjs +97 -0
  20. package/src/commands/org/join.mjs +77 -0
  21. package/src/commands/supporter/count.mjs +96 -0
  22. package/src/commands/user/get.mjs +91 -0
  23. package/src/commands/user/leave.mjs +52 -0
  24. package/src/commands/user/list.mjs +71 -0
  25. package/src/commands/widget/add.mjs +101 -0
  26. package/src/commands/widget/get.mjs +59 -0
  27. package/src/commands/widget/list.mjs +116 -0
  28. package/src/config.mjs +36 -0
  29. package/src/generated/schema.json +10677 -0
  30. package/src/hooks/help.mjs +14 -0
  31. package/src/hooks/init.mjs +20 -0
  32. package/src/index.mjs +1 -0
  33. package/src/procaCommand.mjs +218 -0
  34. package/src/queries/campaign.mjs +21 -0
  35. package/src/queries/widget.mjs +12 -0
  36. package/src/urql.mjs +60 -0
  37. package/src/util/twitter.mjs +23 -0
  38. package/theme.json +29 -0
  39. package/LICENSE +0 -661
  40. package/dist/App.css +0 -22
  41. package/dist/App.js +0 -25
  42. package/dist/App.test.js +0 -8
  43. package/dist/Wizard.js +0 -32
  44. package/dist/components/Alert.js +0 -49
  45. package/dist/components/Clickify.js +0 -26
  46. package/dist/components/Consent.js +0 -120
  47. package/dist/components/Country.js +0 -94
  48. package/dist/components/Dialog.js +0 -84
  49. package/dist/components/Disabled.js +0 -3
  50. package/dist/components/Emoji.js +0 -12
  51. package/dist/components/FAB.js +0 -70
  52. package/dist/components/Html.js +0 -56
  53. package/dist/components/Loader.js +0 -14
  54. package/dist/components/Openletter.js +0 -443
  55. package/dist/components/Organisation.js +0 -181
  56. package/dist/components/Petition.js +0 -16
  57. package/dist/components/ProcaRoot.js +0 -23
  58. package/dist/components/ProcaStyle.js +0 -94
  59. package/dist/components/ProgressCounter.js +0 -64
  60. package/dist/components/Register.js +0 -345
  61. package/dist/components/Share.js +0 -177
  62. package/dist/components/TextField.js +0 -58
  63. package/dist/components/Twitter.js +0 -127
  64. package/dist/components/TwitterAction.js +0 -111
  65. package/dist/components/TwitterList.js +0 -25
  66. package/dist/components/TwitterText.js +0 -42
  67. package/dist/components/Widget.js +0 -266
  68. package/dist/components/bespoke/Download.js +0 -49
  69. package/dist/components/bespoke/Register-CH.js +0 -505
  70. package/dist/data/countries.json +0 -114
  71. package/dist/hooks/useConfig.js +0 -217
  72. package/dist/hooks/useCount.js +0 -95
  73. package/dist/hooks/useData.js +0 -59
  74. package/dist/hooks/useElementWidth.js +0 -46
  75. package/dist/hooks/useGeoLocation.js +0 -45
  76. package/dist/hooks/useLayout.js +0 -63
  77. package/dist/images/Twitter.js +0 -16
  78. package/dist/images/Twitter.svg +0 -1
  79. package/dist/index.css +0 -13
  80. package/dist/index.js +0 -114
  81. package/dist/lib/domparser.js +0 -12
  82. package/dist/lib/i18n.js +0 -40
  83. package/dist/lib/init.js +0 -7
  84. package/dist/lib/server.js +0 -331
  85. package/dist/lib/urlparser.js +0 -65
  86. package/dist/lib/uuid.js +0 -30
  87. package/dist/locales/README.md +0 -37
  88. package/dist/locales/common.json +0 -189
  89. package/dist/locales/de/common.json +0 -46
  90. package/dist/locales/de/index.js +0 -0
  91. package/dist/locales/en/common.json +0 -45
  92. package/dist/locales/fr/common.json +0 -51
  93. package/dist/locales/index.js +0 -27
  94. package/dist/locales/it/common.json +0 -46
  95. package/dist/logo.svg +0 -1
  96. package/dist/module.js +0 -14
  97. package/dist/slingshot.xcf +0 -0
  98. package/dist/tmp.config/0.json +0 -21
  99. package/dist/tmp.config/2.json +0 -11
  100. package/dist/tmp.config/20.json +0 -29
  101. package/dist/tmp.config/28.json +0 -14
  102. package/dist/tmp.config/32.json +0 -34
  103. package/dist/tmp.config/35.json +0 -14
  104. package/dist/tmp.config/null.json +0 -1
package/README.md CHANGED
@@ -1,48 +1,1047 @@
1
- # Proca *Progressive Campaigning*
1
+ # Command line access the proca api
2
2
 
3
- You want to engage your members and ask them to take an online action? Well, you won't be the first organisation, and you will soon realise that they aren't any decent looking petition tool that are easy to install and configure.
3
+ This is to manage the components of campaigns as an admin, or to integrate with external tools (eg. get counters and stats). For the widget builder, check [@proca/widget](https://www.npmjs.com/@proca/widget)
4
4
 
5
- And this is what this tool solves.
5
+ ## Proca: Progressive Campaigning
6
6
 
7
- ## Guiding principles and design
8
- - *Focussed*: this tool should do as little as possible. It doesn't have to be managing the content/layout of your campaign. You have already a prefered CMS for that, or can spin a wordpress one in no time. We provide action/petition widgets that you can embed into your site, we don't want to be yet another site you need to manage
9
- - *Build relationship*: We don't believe a petition is only a step in your campaign. Collecting their information so you can contact them later for more actions and campaigns
10
- - *Privacy*: We will always ask the people taking action to consent to their contact details being shared with your org. We will never use these contacts without their/and your consent.
11
- - *Sharing is caring*: We have seen how supporters can use social media to convince others to join. We see the sharing step as a key component to this tool
12
- - *Integrated*: with your CRM/mailing list. If your supporter consented it, it should be as simple as possible to have their contact detail into your mailing plateform. CSV download is not simple, timeconsuming and errorprone.
13
- - *Support coalitions*: A successful campaign will have multiple partners. We make it easy to aggregate the signature counts, we make it easy to have multiple widgets for each partner (with different consent)
7
+ Proca is an open-source campaign toolkit designed to empower activists and organisations in their digital advocacy efforts. It provides a flexible and customisable platform for creating and managing online petitions, email campaigns, and other forms of digital engagement, enabling users to effectively mobilise supporters and drive social change.
14
8
 
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.
15
10
 
16
- ## Embeded in your existing website
17
11
 
18
- Introducing a new tool is often a source of frustration for the users (new login, new interface to learn, new workflow, new bugs) and extra work for the IT team (adapt the layout).
19
- There are as well the issue of introducing a new domain/subdomain (weak SEO, potential confusion for your supporters).
12
+ ## usage
20
13
 
21
- Our solution? This petition tool is as transparent as possible and embed the action into one (or several) of your existing pages).
14
+ ### global installation
15
+ <!-- usage -->
16
+ ```sh-session
17
+ $ npm install -g proca
18
+ $ proca COMMAND
19
+ running command...
20
+ $ proca (--version)
21
+ proca/1.1.4 linux-x64 node-v22.14.0
22
+ $ proca --help [COMMAND]
23
+ USAGE
24
+ $ proca COMMAND
25
+ ...
26
+ ```
27
+ <!-- usagestop -->
22
28
 
23
- ## Full encryption mode
24
- If the campaigner organisation provides an encryption key (based on NaCl, probably the best elliptic curve encryption solution), we store the signatures and actions *encrypted*. We will not be able to read them anymore. Even if the bad guys compromise the security of our server, they will not be able to read any personal data either, because the campaign organisation (having the key) is the only one that can
29
+ ### local development
25
30
 
26
- This simplify GDPR and other privacy compliance: we do not store any personal data, only encrypted blobs of data that we can't read.
31
+ ```sh-session
32
+ $ git clone https://github.com/fixthestatusquo/proca-cli.git
33
+ $ git install
34
+ $ cd proca-cli
35
+ $./proca-cli --help
36
+ ...
37
+ ```
27
38
 
28
- ## Privacy
29
- We are fully GDPR compliant. As part of a mandatory element of the signature form, we do ask the signatory to consent to be contacted, and record that information.
39
+ ### TOPICS
40
+ - campaign Handle campaigns
41
+ - org
42
+ - config create setting to access the server authentication
30
43
 
44
+ ### TODO TOPICS
31
45
 
32
- ## Performance
46
+ - widget
47
+ - actions
48
+ - service
49
+ - target
33
50
 
34
- Benchmarked at > 1'000'000 signatures per hour on a 16 core
51
+ # Commands
52
+ <!-- commands -->
53
+ * [`proca action count`](#proca-action-count)
54
+ * [`proca action list [TITLE]`](#proca-action-list-title)
55
+ * [`proca action replay`](#proca-action-replay)
56
+ * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
57
+ * [`proca campaign delete`](#proca-campaign-delete)
58
+ * [`proca campaign get`](#proca-campaign-get)
59
+ * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
60
+ * [`proca config add [ENVIRONMENT]`](#proca-config-add-environment)
61
+ * [`proca config get`](#proca-config-get)
62
+ * [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
63
+ * [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
64
+ * [`proca config user`](#proca-config-user)
65
+ * [`proca help [COMMAND]`](#proca-help-command)
66
+ * [`proca org add`](#proca-org-add)
67
+ * [`proca org crm`](#proca-org-crm)
68
+ * [`proca org delete`](#proca-org-delete)
69
+ * [`proca org get`](#proca-org-get)
70
+ * [`proca org join`](#proca-org-join)
71
+ * [`proca plugins`](#proca-plugins)
72
+ * [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
73
+ * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
74
+ * [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
75
+ * [`proca plugins link PATH`](#proca-plugins-link-path)
76
+ * [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
77
+ * [`proca plugins reset`](#proca-plugins-reset)
78
+ * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
79
+ * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
80
+ * [`proca plugins update`](#proca-plugins-update)
81
+ * [`proca supporter count`](#proca-supporter-count)
82
+ * [`proca user get`](#proca-user-get)
83
+ * [`proca user leave`](#proca-user-leave)
84
+ * [`proca user list`](#proca-user-list)
85
+ * [`proca widget add`](#proca-widget-add)
86
+ * [`proca widget get`](#proca-widget-get)
87
+ * [`proca widget list`](#proca-widget-list)
35
88
 
36
- ## Technology
37
- Front and back are clearly separated. the backend is a bunch of APIs clearly documented (so it's easier to build a different front end or switch the back end)
38
- graphql
89
+ ## `proca action count`
39
90
 
40
- front-end: react (next.js or gatsby to generate multiple widgets?)
41
- Back-end: elixir
91
+ counter of actions
42
92
 
43
- Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.
93
+ ```
94
+ USAGE
95
+ $ proca action count [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
96
+ | -n <the_short_name> | -x <value>]
44
97
 
45
- [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
98
+ FLAGS
99
+ -i, --id=<value>
100
+ -n, --name=<the_short_name> name
101
+ -x, --dxid=<value> dxid
46
102
 
103
+ OUTPUT FLAGS
104
+ --csv Format output as csv
105
+ --human Format output to be read on screen by a human [default]
106
+ --json Format output as json
107
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
47
108
 
109
+ DESCRIPTION
110
+ counter of actions
48
111
 
112
+ EXAMPLES
113
+ $ proca action count --id <id of the campaign>
114
+
115
+ $ proca action count --name <name of the campaign>
116
+ ```
117
+
118
+ ## `proca action list [TITLE]`
119
+
120
+ ```
121
+ USAGE
122
+ $ proca action list [TITLE] -o <organisation name> [--simplify [--json | --human |
123
+ --csv]] [-c <campaign title>] [--limit <value>] [--optin] [--testing] [--doi] [--utm]
124
+
125
+ ARGUMENTS
126
+ TITLE name of the campaign, % for wildchar
127
+
128
+ FLAGS
129
+ -c, --campaign=<campaign title> name of the campaign, % for wildchar
130
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
131
+ --doi only export the double optin actions
132
+ --limit=<value> max number of actions
133
+ --optin only export the optin actions
134
+ --testing also export the test actions
135
+ --[no-]utm display the utm tracking parameters
136
+
137
+ OUTPUT FLAGS
138
+ --csv Format output as csv
139
+ --human Format output to be read on screen by a human [default]
140
+ --json Format output as json
141
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
142
+
143
+ EXAMPLES
144
+ $ proca action list %pizza%
145
+ ```
146
+
147
+ ## `proca action replay`
148
+
149
+ ```
150
+ USAGE
151
+ $ proca action replay -o <organisation name> [--simplify [--json | --human | --csv]] [-c
152
+ <campaign title>]
153
+
154
+ FLAGS
155
+ -c, --campaign=<campaign title> name of the campaign, % for wildchar
156
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
157
+
158
+ OUTPUT FLAGS
159
+ --csv Format output as csv
160
+ --human Format output to be read on screen by a human [default]
161
+ --json Format output as json
162
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
163
+
164
+ EXAMPLES
165
+ $ proca action replay %pizza%
166
+ ```
167
+
168
+ ## `proca campaign add [TITLE]`
169
+
170
+ ```
171
+ USAGE
172
+ $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--simplify [--json |
173
+ --human | --csv]]
174
+
175
+ ARGUMENTS
176
+ TITLE title of the campaign
177
+
178
+ FLAGS
179
+ -n, --name=<campaign name> (required) name of the campaign
180
+ -o, --org=<org name> (required) name of the coordinator
181
+
182
+ OUTPUT FLAGS
183
+ --csv Format output as csv
184
+ --human Format output to be read on screen by a human [default]
185
+ --json Format output as json
186
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
187
+
188
+ EXAMPLES
189
+ $ proca campaign add -n <new_campaign> the full name of the campaign
190
+ ```
191
+
192
+ ## `proca campaign delete`
193
+
194
+ delete a campaign
195
+
196
+ ```
197
+ USAGE
198
+ $ proca campaign delete [--simplify [--json | --human | --csv]] [-i <organisation name>]
199
+ [-n <campaign name>]
200
+
201
+ FLAGS
202
+ -i, --id=<organisation name> id of the campaign
203
+ -n, --name=<campaign name> name of the campaign
204
+
205
+ OUTPUT FLAGS
206
+ --csv Format output as csv
207
+ --human Format output to be read on screen by a human [default]
208
+ --json Format output as json
209
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
210
+
211
+ DESCRIPTION
212
+ delete a campaign
213
+
214
+ EXAMPLES
215
+ $ proca campaign delete -i 42
216
+ ```
217
+
218
+ ## `proca campaign get`
219
+
220
+ view a campaign
221
+
222
+ ```
223
+ USAGE
224
+ $ proca campaign get [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
225
+ | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
226
+
227
+ FLAGS
228
+ -i, --id=<value>
229
+ -n, --name=<the_short_name> name
230
+ -x, --dxid=<value> dxid
231
+ --[no-]config display the config
232
+ --locale=<value> display a locale
233
+ --[no-]stats display the stats
234
+
235
+ OUTPUT FLAGS
236
+ --csv Format output as csv
237
+ --human Format output to be read on screen by a human [default]
238
+ --json Format output as json
239
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
240
+
241
+ DESCRIPTION
242
+ view a campaign
243
+
244
+ EXAMPLES
245
+ $ proca campaign get -i 42
246
+ ```
247
+
248
+ ## `proca campaign list [TITLE]`
249
+
250
+ list all the campaigns
251
+
252
+ ```
253
+ USAGE
254
+ $ proca campaign list [TITLE] [--simplify [--json | --human | --csv]] [-o <organisation
255
+ name>] [-t <campaign title>] [--stats]
256
+
257
+ ARGUMENTS
258
+ TITLE name of the campaign, % for wildchar
259
+
260
+ FLAGS
261
+ -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
262
+ -t, --title=<campaign title> name of the campaign, % for wildchar
263
+ --[no-]stats display the stats
264
+
265
+ OUTPUT FLAGS
266
+ --csv Format output as csv
267
+ --human Format output to be read on screen by a human [default]
268
+ --json Format output as json
269
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
270
+
271
+ DESCRIPTION
272
+ list all the campaigns
273
+
274
+ EXAMPLES
275
+ $ proca campaign list %pizza%
276
+ ```
277
+
278
+ ## `proca config add [ENVIRONMENT]`
279
+
280
+ create setting to access the server authentication
281
+
282
+ ```
283
+ USAGE
284
+ $ proca config add [ENVIRONMENT] --token <API-token> [--simplify [--json | --human |
285
+ --csv]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
286
+ [--supabase-secrey-key <value>]
287
+
288
+ ARGUMENTS
289
+ ENVIRONMENT [default: default] environment
290
+
291
+ FLAGS
292
+ --force write over an existing configuration
293
+ --n8n=<n8n api> api access on the n8n server
294
+ --supabase=<url> url of the supabase
295
+ --supabase-anon-key=<value> anonymous key
296
+ --supabase-secrey-key=<value> secret service key
297
+ --token=<API-token> (required) user token on proca server
298
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
299
+
300
+ OUTPUT FLAGS
301
+ --csv Format output as csv
302
+ --human Format output to be read on screen by a human [default]
303
+ --json Format output as json
304
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
305
+
306
+ DESCRIPTION
307
+ create setting to access the server authentication
308
+
309
+ ALIASES
310
+ $ proca config setup
311
+
312
+ EXAMPLES
313
+ $ proca config add --user=xavier@example.org --token=API-12345789
314
+ ```
315
+
316
+ ## `proca config get`
317
+
318
+ get the server config
319
+
320
+ ```
321
+ USAGE
322
+ $ proca config get [--simplify [--json | --human | --csv]]
323
+
324
+ OUTPUT FLAGS
325
+ --csv Format output as csv
326
+ --human Format output to be read on screen by a human [default]
327
+ --json Format output as json
328
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
329
+
330
+ DESCRIPTION
331
+ get the server config
332
+ ```
333
+
334
+ ## `proca config set [KEY] [VALUE]`
335
+
336
+ update the setting used to authenticate to the servers and services
337
+
338
+ ```
339
+ USAGE
340
+ $ proca config set [KEY] [VALUE] [--simplify [--json | --human | --csv]]
341
+ [--environment <value>] [--url <url>] [--token <API-token>]
342
+
343
+ ARGUMENTS
344
+ KEY variable name
345
+ VALUE value
346
+
347
+ FLAGS
348
+ --environment=<value> [default: default] environment
349
+ --token=<API-token> user token on proca server
350
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
351
+
352
+ OUTPUT FLAGS
353
+ --csv Format output as csv
354
+ --human Format output to be read on screen by a human [default]
355
+ --json Format output as json
356
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
357
+
358
+ DESCRIPTION
359
+ update the setting used to authenticate to the servers and services
360
+
361
+ ALIASES
362
+ $ proca config setup
363
+
364
+ EXAMPLES
365
+ $ proca config set --user=xavier@example.org --token=API-12345789
366
+
367
+ $ proca config set VAR1 VALUE
368
+ ```
369
+
370
+ ## `proca config setup [ENVIRONMENT]`
371
+
372
+ create setting to access the server authentication
373
+
374
+ ```
375
+ USAGE
376
+ $ proca config setup [ENVIRONMENT] --token <API-token> [--simplify [--json | --human |
377
+ --csv]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
378
+ [--supabase-secrey-key <value>]
379
+
380
+ ARGUMENTS
381
+ ENVIRONMENT [default: default] environment
382
+
383
+ FLAGS
384
+ --force write over an existing configuration
385
+ --n8n=<n8n api> api access on the n8n server
386
+ --supabase=<url> url of the supabase
387
+ --supabase-anon-key=<value> anonymous key
388
+ --supabase-secrey-key=<value> secret service key
389
+ --token=<API-token> (required) user token on proca server
390
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
391
+
392
+ OUTPUT FLAGS
393
+ --csv Format output as csv
394
+ --human Format output to be read on screen by a human [default]
395
+ --json Format output as json
396
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
397
+
398
+ DESCRIPTION
399
+ create setting to access the server authentication
400
+
401
+ ALIASES
402
+ $ proca config setup
403
+
404
+ EXAMPLES
405
+ $ proca config setup --user=xavier@example.org --token=API-12345789
406
+ ```
407
+
408
+ ## `proca config user`
409
+
410
+ fetch the information about the current user (based on the token)
411
+
412
+ ```
413
+ USAGE
414
+ $ proca config user [--simplify [--json | --human | --csv]]
415
+
416
+ OUTPUT FLAGS
417
+ --csv Format output as csv
418
+ --human Format output to be read on screen by a human [default]
419
+ --json Format output as json
420
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
421
+
422
+ DESCRIPTION
423
+ fetch the information about the current user (based on the token)
424
+
425
+ EXAMPLES
426
+ $ proca config user
427
+ ```
428
+
429
+ ## `proca help [COMMAND]`
430
+
431
+ Display help for proca.
432
+
433
+ ```
434
+ USAGE
435
+ $ proca help [COMMAND...] [-n]
436
+
437
+ ARGUMENTS
438
+ COMMAND... Command to show help for.
439
+
440
+ FLAGS
441
+ -n, --nested-commands Include all nested commands in the output.
442
+
443
+ DESCRIPTION
444
+ Display help for proca.
445
+ ```
446
+
447
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
448
+
449
+ ## `proca org add`
450
+
451
+ ```
452
+ USAGE
453
+ $ proca org add [--simplify [--json | --human | --csv]] [--twitter <screen name>]
454
+ [-n <org name>]
455
+
456
+ FLAGS
457
+ -n, --name=<org name> name of the org
458
+ --twitter=<screen name> twitter account
459
+
460
+ OUTPUT FLAGS
461
+ --csv Format output as csv
462
+ --human Format output to be read on screen by a human [default]
463
+ --json Format output as json
464
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
465
+
466
+ EXAMPLES
467
+ $ proca org add --twitter <twitter of the organisation>
468
+ ```
469
+
470
+ ## `proca org crm`
471
+
472
+ view a org crm synchroniser
473
+
474
+ ```
475
+ USAGE
476
+ $ proca org crm -n <org name> [--simplify [--json | --human | --csv]]
477
+ [--synchronize]
478
+
479
+ FLAGS
480
+ -n, --name=<org name> (required) name of the org
481
+ --[no-]synchronize enable or disable the synchronisation queue
482
+
483
+ OUTPUT FLAGS
484
+ --csv Format output as csv
485
+ --human Format output to be read on screen by a human [default]
486
+ --json Format output as json
487
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
488
+
489
+ DESCRIPTION
490
+ view a org crm synchroniser
491
+ ```
492
+
493
+ ## `proca org delete`
494
+
495
+ ```
496
+ USAGE
497
+ $ proca org delete [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
498
+ | -n <org name> | -x <value>]
499
+
500
+ FLAGS
501
+ -i, --id=<value>
502
+ -n, --name=<org name> name of the org
503
+ -x, --dxid=<value> dxid
504
+
505
+ OUTPUT FLAGS
506
+ --csv Format output as csv
507
+ --human Format output to be read on screen by a human [default]
508
+ --json Format output as json
509
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
510
+
511
+ EXAMPLES
512
+ $ proca org delete <organisation_name>
513
+ ```
514
+
515
+ ## `proca org get`
516
+
517
+ view a org
518
+
519
+ ```
520
+ USAGE
521
+ $ proca org get [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-n <org
522
+ name>] [--config] [--keys] [--campaigns] [--widgets] [--users]
523
+
524
+ FLAGS
525
+ -n, --name=<org name> name of the org
526
+ --[no-]campaigns
527
+ --[no-]config display the config
528
+ --[no-]keys
529
+ --[no-]users
530
+ --[no-]widgets
531
+
532
+ OUTPUT FLAGS
533
+ --csv Format output as csv
534
+ --human Format output to be read on screen by a human [default]
535
+ --json Format output as json
536
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
537
+
538
+ DESCRIPTION
539
+ view a org
540
+
541
+ EXAMPLES
542
+ $ proca org get <name of the ngo>
543
+ ```
544
+
545
+ ## `proca org join`
546
+
547
+ let a user join an organisation with a role
548
+
549
+ ```
550
+ USAGE
551
+ $ proca org join -o <org name> [--simplify [--json | --human | --csv]] [--user
552
+ <value>] [--role owner|campaigner|coordinator|translator]
553
+
554
+ FLAGS
555
+ -o, --org=<org name> (required) name of the org
556
+ --role=<option> [default: campaigner] permission level in that org
557
+ <options: owner|campaigner|coordinator|translator>
558
+ --user=<value> user email
559
+
560
+ OUTPUT FLAGS
561
+ --csv Format output as csv
562
+ --human Format output to be read on screen by a human [default]
563
+ --json Format output as json
564
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
565
+
566
+ DESCRIPTION
567
+ let a user join an organisation with a role
568
+
569
+ EXAMPLES
570
+ $ proca org join
571
+ ```
572
+
573
+ ## `proca plugins`
574
+
575
+ List installed plugins.
576
+
577
+ ```
578
+ USAGE
579
+ $ proca plugins [--json] [--core]
580
+
581
+ FLAGS
582
+ --core Show core plugins.
583
+
584
+ GLOBAL FLAGS
585
+ --json Format output as json.
586
+
587
+ DESCRIPTION
588
+ List installed plugins.
589
+
590
+ EXAMPLES
591
+ $ proca plugins
592
+ ```
593
+
594
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
595
+
596
+ ## `proca plugins add PLUGIN`
597
+
598
+ Installs a plugin into proca.
599
+
600
+ ```
601
+ USAGE
602
+ $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
603
+
604
+ ARGUMENTS
605
+ PLUGIN... Plugin to install.
606
+
607
+ FLAGS
608
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
609
+ -h, --help Show CLI help.
610
+ -s, --silent Silences npm output.
611
+ -v, --verbose Show verbose npm output.
612
+
613
+ GLOBAL FLAGS
614
+ --json Format output as json.
615
+
616
+ DESCRIPTION
617
+ Installs a plugin into proca.
618
+
619
+ Uses npm to install plugins.
620
+
621
+ Installation of a user-installed plugin will override a core plugin.
622
+
623
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
624
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
625
+
626
+ ALIASES
627
+ $ proca plugins add
628
+
629
+ EXAMPLES
630
+ Install a plugin from npm registry.
631
+
632
+ $ proca plugins add myplugin
633
+
634
+ Install a plugin from a github url.
635
+
636
+ $ proca plugins add https://github.com/someuser/someplugin
637
+
638
+ Install a plugin from a github slug.
639
+
640
+ $ proca plugins add someuser/someplugin
641
+ ```
642
+
643
+ ## `proca plugins:inspect PLUGIN...`
644
+
645
+ Displays installation properties of a plugin.
646
+
647
+ ```
648
+ USAGE
649
+ $ proca plugins inspect PLUGIN...
650
+
651
+ ARGUMENTS
652
+ PLUGIN... [default: .] Plugin to inspect.
653
+
654
+ FLAGS
655
+ -h, --help Show CLI help.
656
+ -v, --verbose
657
+
658
+ GLOBAL FLAGS
659
+ --json Format output as json.
660
+
661
+ DESCRIPTION
662
+ Displays installation properties of a plugin.
663
+
664
+ EXAMPLES
665
+ $ proca plugins inspect myplugin
666
+ ```
667
+
668
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
669
+
670
+ ## `proca plugins install PLUGIN`
671
+
672
+ Installs a plugin into proca.
673
+
674
+ ```
675
+ USAGE
676
+ $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
677
+
678
+ ARGUMENTS
679
+ PLUGIN... Plugin to install.
680
+
681
+ FLAGS
682
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
683
+ -h, --help Show CLI help.
684
+ -s, --silent Silences npm output.
685
+ -v, --verbose Show verbose npm output.
686
+
687
+ GLOBAL FLAGS
688
+ --json Format output as json.
689
+
690
+ DESCRIPTION
691
+ Installs a plugin into proca.
692
+
693
+ Uses npm to install plugins.
694
+
695
+ Installation of a user-installed plugin will override a core plugin.
696
+
697
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
698
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
699
+
700
+ ALIASES
701
+ $ proca plugins add
702
+
703
+ EXAMPLES
704
+ Install a plugin from npm registry.
705
+
706
+ $ proca plugins install myplugin
707
+
708
+ Install a plugin from a github url.
709
+
710
+ $ proca plugins install https://github.com/someuser/someplugin
711
+
712
+ Install a plugin from a github slug.
713
+
714
+ $ proca plugins install someuser/someplugin
715
+ ```
716
+
717
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
718
+
719
+ ## `proca plugins link PATH`
720
+
721
+ Links a plugin into the CLI for development.
722
+
723
+ ```
724
+ USAGE
725
+ $ proca plugins link PATH [-h] [--install] [-v]
726
+
727
+ ARGUMENTS
728
+ PATH [default: .] path to plugin
729
+
730
+ FLAGS
731
+ -h, --help Show CLI help.
732
+ -v, --verbose
733
+ --[no-]install Install dependencies after linking the plugin.
734
+
735
+ DESCRIPTION
736
+ Links a plugin into the CLI for development.
737
+
738
+ Installation of a linked plugin will override a user-installed or core plugin.
739
+
740
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
741
+ command will override the user-installed or core plugin implementation. This is useful for development work.
742
+
743
+
744
+ EXAMPLES
745
+ $ proca plugins link myplugin
746
+ ```
747
+
748
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
749
+
750
+ ## `proca plugins remove [PLUGIN]`
751
+
752
+ Removes a plugin from the CLI.
753
+
754
+ ```
755
+ USAGE
756
+ $ proca plugins remove [PLUGIN...] [-h] [-v]
757
+
758
+ ARGUMENTS
759
+ PLUGIN... plugin to uninstall
760
+
761
+ FLAGS
762
+ -h, --help Show CLI help.
763
+ -v, --verbose
764
+
765
+ DESCRIPTION
766
+ Removes a plugin from the CLI.
767
+
768
+ ALIASES
769
+ $ proca plugins unlink
770
+ $ proca plugins remove
771
+
772
+ EXAMPLES
773
+ $ proca plugins remove myplugin
774
+ ```
775
+
776
+ ## `proca plugins reset`
777
+
778
+ Remove all user-installed and linked plugins.
779
+
780
+ ```
781
+ USAGE
782
+ $ proca plugins reset [--hard] [--reinstall]
783
+
784
+ FLAGS
785
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
786
+ --reinstall Reinstall all plugins after uninstalling.
787
+ ```
788
+
789
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
790
+
791
+ ## `proca plugins uninstall [PLUGIN]`
792
+
793
+ Removes a plugin from the CLI.
794
+
795
+ ```
796
+ USAGE
797
+ $ proca plugins uninstall [PLUGIN...] [-h] [-v]
798
+
799
+ ARGUMENTS
800
+ PLUGIN... plugin to uninstall
801
+
802
+ FLAGS
803
+ -h, --help Show CLI help.
804
+ -v, --verbose
805
+
806
+ DESCRIPTION
807
+ Removes a plugin from the CLI.
808
+
809
+ ALIASES
810
+ $ proca plugins unlink
811
+ $ proca plugins remove
812
+
813
+ EXAMPLES
814
+ $ proca plugins uninstall myplugin
815
+ ```
816
+
817
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
818
+
819
+ ## `proca plugins unlink [PLUGIN]`
820
+
821
+ Removes a plugin from the CLI.
822
+
823
+ ```
824
+ USAGE
825
+ $ proca plugins unlink [PLUGIN...] [-h] [-v]
826
+
827
+ ARGUMENTS
828
+ PLUGIN... plugin to uninstall
829
+
830
+ FLAGS
831
+ -h, --help Show CLI help.
832
+ -v, --verbose
833
+
834
+ DESCRIPTION
835
+ Removes a plugin from the CLI.
836
+
837
+ ALIASES
838
+ $ proca plugins unlink
839
+ $ proca plugins remove
840
+
841
+ EXAMPLES
842
+ $ proca plugins unlink myplugin
843
+ ```
844
+
845
+ ## `proca plugins update`
846
+
847
+ Update installed plugins.
848
+
849
+ ```
850
+ USAGE
851
+ $ proca plugins update [-h] [-v]
852
+
853
+ FLAGS
854
+ -h, --help Show CLI help.
855
+ -v, --verbose
856
+
857
+ DESCRIPTION
858
+ Update installed plugins.
859
+ ```
860
+
861
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
862
+
863
+ ## `proca supporter count`
864
+
865
+ counter of supporters
866
+
867
+ ```
868
+ USAGE
869
+ $ proca supporter count [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
870
+ | -n <the_short_name> | -x <value>] [--org] [--area] [--number --without <value>]
871
+
872
+ FLAGS
873
+ -i, --id=<value>
874
+ -n, --name=<the_short_name> name
875
+ -x, --dxid=<value> dxid
876
+ --area segment by area
877
+ --number just return the number to add to the partner's counter
878
+ --org segment by partner
879
+ --without=<value> total to add to the partner's counter
880
+
881
+ OUTPUT FLAGS
882
+ --csv Format output as csv
883
+ --human Format output to be read on screen by a human [default]
884
+ --json Format output as json
885
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
886
+
887
+ DESCRIPTION
888
+ counter of supporters
889
+
890
+ EXAMPLES
891
+ $ proca supporter count --id <id of the campaign>
892
+
893
+ $ proca supporter count --name <name of the campaign>
894
+ ```
895
+
896
+ ## `proca user get`
897
+
898
+ fetch the information about a user
899
+
900
+ ```
901
+ USAGE
902
+ $ proca user get [--simplify [--json | --human | --csv]] [--email <value>] [-o <org
903
+ name>] [-i <value>]
904
+
905
+ FLAGS
906
+ -i, --id=<value> id of the user
907
+ -o, --org=<org name> name of the org
908
+ --email=<value> user email
909
+
910
+ OUTPUT FLAGS
911
+ --csv Format output as csv
912
+ --human Format output to be read on screen by a human [default]
913
+ --json Format output as json
914
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
915
+
916
+ DESCRIPTION
917
+ fetch the information about a user
918
+
919
+ EXAMPLES
920
+ $ proca user get
921
+ ```
922
+
923
+ ## `proca user leave`
924
+
925
+ leave a org
926
+
927
+ ```
928
+ USAGE
929
+ $ proca user leave --email <user email> -o <org name> [--simplify [--json | --human |
930
+ --csv]]
931
+
932
+ FLAGS
933
+ -o, --org=<org name> (required) name of the org
934
+ --email=<user email> (required) email
935
+
936
+ OUTPUT FLAGS
937
+ --csv Format output as csv
938
+ --human Format output to be read on screen by a human [default]
939
+ --json Format output as json
940
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
941
+
942
+ DESCRIPTION
943
+ leave a org
944
+
945
+ EXAMPLES
946
+ $ proca user leave -i 42
947
+ ```
948
+
949
+ ## `proca user list`
950
+
951
+ list all the users
952
+
953
+ ```
954
+ USAGE
955
+ $ proca user list -o <value> [--simplify [--json | --human | --csv]]
956
+
957
+ FLAGS
958
+ -o, --org=<value> (required) organisation
959
+
960
+ OUTPUT FLAGS
961
+ --csv Format output as csv
962
+ --human Format output to be read on screen by a human [default]
963
+ --json Format output as json
964
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
965
+
966
+ DESCRIPTION
967
+ list all the users
968
+
969
+ EXAMPLES
970
+ $ proca user list %pizza%
971
+ ```
972
+
973
+ ## `proca widget add`
974
+
975
+ ```
976
+ USAGE
977
+ $ proca widget add -c <campaign name> [--simplify [--json | --human | --csv]] [-o
978
+ <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
979
+
980
+ FLAGS
981
+ -c, --campaign=<campaign name> (required) name of the campaign
982
+ -l, --lang=<en> [default: en] language
983
+ -n, --name=by default <campaign>/<org>/<lang> url slug
984
+ -o, --org=<en> organisation
985
+
986
+ OUTPUT FLAGS
987
+ --csv Format output as csv
988
+ --human Format output to be read on screen by a human [default]
989
+ --json Format output as json
990
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
991
+ ```
992
+
993
+ ## `proca widget get`
994
+
995
+ view a widget
996
+
997
+ ```
998
+ USAGE
999
+ $ proca widget get [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
1000
+ | -n <the_short_name> | -x <value>] [--config]
1001
+
1002
+ FLAGS
1003
+ -i, --id=<value>
1004
+ -n, --name=<the_short_name> name
1005
+ -x, --dxid=<value> dxid
1006
+ --[no-]config display the config
1007
+
1008
+ OUTPUT FLAGS
1009
+ --csv Format output as csv
1010
+ --human Format output to be read on screen by a human [default]
1011
+ --json Format output as json
1012
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
1013
+
1014
+ DESCRIPTION
1015
+ view a widget
1016
+
1017
+ EXAMPLES
1018
+ $ proca widget get <path of the widget>
1019
+ ```
1020
+
1021
+ ## `proca widget list`
1022
+
1023
+ list all the widgets of an org or campaign
1024
+
1025
+ ```
1026
+ USAGE
1027
+ $ proca widget list [--simplify [--json | --human | --csv]] [-o <organisation name>]
1028
+ [-c <campaign name>] [--config]
1029
+
1030
+ FLAGS
1031
+ -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
1032
+ -o, --org=<organisation name> widgets of the organisation (coordinator or partner)
1033
+ --[no-]config get the config
1034
+
1035
+ OUTPUT FLAGS
1036
+ --csv Format output as csv
1037
+ --human Format output to be read on screen by a human [default]
1038
+ --json Format output as json
1039
+ --simplify flatten and filter to output only the most important attributes, mostly relevant for json
1040
+
1041
+ DESCRIPTION
1042
+ list all the widgets of an org or campaign
1043
+
1044
+ EXAMPLES
1045
+ $ proca widget list -o <organisation>
1046
+ ```
1047
+ <!-- commandsstop -->