@proca/cli 3.3.1 → 3.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/README.md +1992 -60
  2. package/package.json +88 -71
  3. package/proca-cli +8 -0
  4. package/src/commands/action/add.mjs +192 -0
  5. package/src/commands/action/confirm.mjs +93 -0
  6. package/src/commands/action/count.mjs +61 -0
  7. package/src/commands/action/list.mjs +204 -0
  8. package/src/commands/action/replay.mjs +56 -0
  9. package/src/commands/action/requeue.mjs +156 -0
  10. package/src/commands/campaign/add.mjs +113 -0
  11. package/src/commands/campaign/copy.mjs +91 -0
  12. package/src/commands/campaign/delete.mjs +41 -0
  13. package/src/commands/campaign/get.mjs +132 -0
  14. package/src/commands/campaign/list.mjs +161 -0
  15. package/src/commands/campaign/mtt.mjs +131 -0
  16. package/src/commands/campaign/queries.graphql +19 -0
  17. package/src/commands/campaign/status.mjs +63 -0
  18. package/src/commands/campaign/widget/archive.mjs +124 -0
  19. package/src/commands/campaign/widget/copy.mjs +175 -0
  20. package/src/commands/campaign/widget/get.mjs +19 -0
  21. package/src/commands/campaign/widget/index.mjs +17 -0
  22. package/src/commands/campaign/widget/rebuild.mjs +50 -0
  23. package/src/commands/config/add.mjs +97 -0
  24. package/src/commands/config/folder.mjs +42 -0
  25. package/src/commands/config/server.mjs +33 -0
  26. package/src/commands/config/set.mjs +103 -0
  27. package/src/commands/config/user.mjs +79 -0
  28. package/src/commands/contact/count.mjs +41 -0
  29. package/src/commands/contact/list.mjs +207 -0
  30. package/src/commands/org/add.mjs +75 -0
  31. package/src/commands/org/crm.mjs +88 -0
  32. package/src/commands/org/delete.mjs +48 -0
  33. package/src/commands/org/email.mjs +111 -0
  34. package/src/commands/org/get.mjs +152 -0
  35. package/src/commands/service/add.mjs +78 -0
  36. package/src/commands/service/list.mjs +24 -0
  37. package/src/commands/target/add.mjs +94 -0
  38. package/src/commands/template/add.mjs +97 -0
  39. package/src/commands/template/list.mjs +61 -0
  40. package/src/commands/user/get.mjs +91 -0
  41. package/src/commands/user/invite.mjs +56 -0
  42. package/src/commands/user/join.mjs +81 -0
  43. package/src/commands/user/leave.mjs +57 -0
  44. package/src/commands/user/list.mjs +80 -0
  45. package/src/commands/user/reset.mjs +83 -0
  46. package/src/commands/widget/add.mjs +116 -0
  47. package/src/commands/widget/delete.mjs +45 -0
  48. package/src/commands/widget/get.mjs +60 -0
  49. package/src/commands/widget/list.mjs +135 -0
  50. package/src/commands/widget/rebuild.mjs +64 -0
  51. package/src/commands/widget/update.mjs +174 -0
  52. package/src/config.mjs +49 -0
  53. package/src/generated/schema.json +10677 -0
  54. package/src/hooks/help.mjs +14 -0
  55. package/src/hooks/init.mjs +41 -0
  56. package/src/index.mjs +1 -0
  57. package/src/procaCommand.mjs +316 -0
  58. package/src/queries/campaign.mjs +35 -0
  59. package/src/queries/widget.mjs +25 -0
  60. package/src/urql.mjs +60 -0
  61. package/src/util/twitter.mjs +23 -0
  62. package/theme.json +29 -0
  63. package/LICENSE +0 -661
  64. package/bin/proca-cli +0 -4
  65. package/dist/a.d.ts +0 -1
  66. package/dist/a.js +0 -21
  67. package/dist/a.js.map +0 -1
  68. package/dist/browser.d.ts +0 -1
  69. package/dist/browser.js +0 -24
  70. package/dist/browser.js.map +0 -1
  71. package/dist/campaign.d.ts +0 -156
  72. package/dist/campaign.js +0 -188
  73. package/dist/campaign.js.map +0 -1
  74. package/dist/cli.d.ts +0 -40
  75. package/dist/cli.js +0 -411
  76. package/dist/cli.js.map +0 -1
  77. package/dist/client.d.ts +0 -2
  78. package/dist/client.js +0 -18
  79. package/dist/client.js.map +0 -1
  80. package/dist/config.d.ts +0 -35
  81. package/dist/config.js +0 -71
  82. package/dist/config.js.map +0 -1
  83. package/dist/crypto.d.ts +0 -40
  84. package/dist/crypto.js +0 -53
  85. package/dist/crypto.js.map +0 -1
  86. package/dist/decrypt.d.ts +0 -7
  87. package/dist/decrypt.js +0 -29
  88. package/dist/decrypt.js.map +0 -1
  89. package/dist/export.d.ts +0 -15
  90. package/dist/export.js +0 -141
  91. package/dist/export.js.map +0 -1
  92. package/dist/format.d.ts +0 -37
  93. package/dist/format.js +0 -200
  94. package/dist/format.js.map +0 -1
  95. package/dist/index.d.ts +0 -8
  96. package/dist/index.js +0 -35
  97. package/dist/index.js.map +0 -1
  98. package/dist/keys.d.ts +0 -4
  99. package/dist/keys.js +0 -38
  100. package/dist/keys.js.map +0 -1
  101. package/dist/org.d.ts +0 -11
  102. package/dist/org.js +0 -93
  103. package/dist/org.js.map +0 -1
  104. package/dist/proca.d.ts +0 -2066
  105. package/dist/proca.js +0 -396
  106. package/dist/proca.js.map +0 -1
  107. package/dist/queue.d.ts +0 -8
  108. package/dist/queue.js +0 -126
  109. package/dist/queue.js.map +0 -1
  110. package/dist/queueMessage.d.ts +0 -102
  111. package/dist/queueMessage.js +0 -109
  112. package/dist/queueMessage.js.map +0 -1
  113. package/dist/scalarLocations.d.ts +0 -4
  114. package/dist/scalarLocations.js +0 -236
  115. package/dist/scalarLocations.js.map +0 -1
  116. package/dist/service/actionnetwork.d.ts +0 -10
  117. package/dist/service/actionnetwork.js +0 -302
  118. package/dist/service/actionnetwork.js.map +0 -1
  119. package/dist/service/distance.d.ts +0 -3
  120. package/dist/service/distance.js +0 -92
  121. package/dist/service/distance.js.map +0 -1
  122. package/dist/service/echo.d.ts +0 -4
  123. package/dist/service/echo.js +0 -19
  124. package/dist/service/echo.js.map +0 -1
  125. package/dist/service/email.d.ts +0 -14
  126. package/dist/service/email.js +0 -67
  127. package/dist/service/email.js.map +0 -1
  128. package/dist/service/identity.d.ts +0 -58
  129. package/dist/service/identity.js +0 -190
  130. package/dist/service/identity.js.map +0 -1
  131. package/dist/service/index.d.ts +0 -14
  132. package/dist/service/index.js +0 -61
  133. package/dist/service/index.js.map +0 -1
  134. package/dist/setup.d.ts +0 -2
  135. package/dist/setup.js +0 -287
  136. package/dist/setup.js.map +0 -1
  137. package/dist/test.d.ts +0 -1
  138. package/dist/test.js +0 -33
  139. package/dist/test.js.map +0 -1
  140. package/dist/util.d.ts +0 -5
  141. package/dist/util.js +0 -30
  142. package/dist/util.js.map +0 -1
  143. package/dist/watch.d.ts +0 -9
  144. package/dist/watch.js +0 -76
  145. package/dist/watch.js.map +0 -1
package/README.md CHANGED
@@ -1,101 +1,2033 @@
1
+ # Command line access the proca api
2
+
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
+
5
+ ## Proca: Progressive Campaigning
6
+
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.
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.
10
+
11
+ ## usage
12
+
13
+ ### global installation
14
+
15
+ if you have or plan to have multiple servers (eg. production and staging) or multiple users, you can setup multiple environments. each proca command support a --env <environment> param (optional, 'default' if not specified.
16
+
17
+ All the examples are using the default environment, add --env=staging if you need to access another server than your default one. By convention, we keep default for production.
18
+
19
+ ```sh-session
20
+ $ npm install -g proca
21
+ $# if you don't have your API token, generate one
22
+ $ proca user reset --email <your_email> --passowrd <your password>
23
+ $ proca config init --token=<API-token>
24
+ ```
25
+
26
+ you can set up the config folder the widget builder will use to store the caches. skip unless you want a different one than the default (your/widget/folder/config).
27
+
28
+ ### local development
29
+
30
+ ```sh-session
31
+ $ git clone https://github.com/fixthestatusquo/proca-cli.git
32
+ $ cd proca-cli
33
+ $ npm install
34
+ $ npm link # let the proca widget and other use the local version
35
+ $./proca-cli config add --env=local --url=http://localhost:4000/api
36
+ $./proca-cli config server --env=local #check if the config is working
37
+ $./proca-cli config user #check if the config is working
38
+ ```
39
+
40
+ you should also use the local proca-api in your [widget generator](https://github.com/fixthestatusquo/proca)
41
+
42
+ ```sh-session
43
+ $ cd /your/path/to/proca
44
+ $ npm link proca # use the local proca-cli repo
45
+ ```
46
+
47
+ # Commands
48
+
49
+ <!-- commands -->
50
+ * [`proca action add`](#proca-action-add)
51
+ * [`proca action confirm`](#proca-action-confirm)
52
+ * [`proca action count`](#proca-action-count)
53
+ * [`proca action list [TITLE]`](#proca-action-list-title)
54
+ * [`proca action replay`](#proca-action-replay)
55
+ * [`proca action requeue`](#proca-action-requeue)
56
+ * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
57
+ * [`proca campaign close`](#proca-campaign-close)
58
+ * [`proca campaign copy`](#proca-campaign-copy)
59
+ * [`proca campaign delete`](#proca-campaign-delete)
60
+ * [`proca campaign get`](#proca-campaign-get)
61
+ * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
62
+ * [`proca campaign mtt`](#proca-campaign-mtt)
63
+ * [`proca campaign status`](#proca-campaign-status)
64
+ * [`proca campaign widget archive`](#proca-campaign-widget-archive)
65
+ * [`proca campaign widget copy`](#proca-campaign-widget-copy)
66
+ * [`proca campaign widget get`](#proca-campaign-widget-get)
67
+ * [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
68
+ * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
69
+ * [`proca config folder`](#proca-config-folder)
70
+ * [`proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-init-env-human-json-csv-markdown-simplify)
71
+ * [`proca config server`](#proca-config-server)
72
+ * [`proca config set [KEY] [VALUE]`](#proca-config-set-key-value)
73
+ * [`proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-setup-env-human-json-csv-markdown-simplify)
74
+ * [`proca config user`](#proca-config-user)
75
+ * [`proca contact count`](#proca-contact-count)
76
+ * [`proca contact list [TITLE]`](#proca-contact-list-title)
77
+ * [`proca help [COMMAND]`](#proca-help-command)
78
+ * [`proca org add`](#proca-org-add)
79
+ * [`proca org crm`](#proca-org-crm)
80
+ * [`proca org delete`](#proca-org-delete)
81
+ * [`proca org email`](#proca-org-email)
82
+ * [`proca org get`](#proca-org-get)
83
+ * [`proca org user get`](#proca-org-user-get)
84
+ * [`proca plugins`](#proca-plugins)
85
+ * [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
86
+ * [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
87
+ * [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
88
+ * [`proca plugins link PATH`](#proca-plugins-link-path)
89
+ * [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
90
+ * [`proca plugins reset`](#proca-plugins-reset)
91
+ * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
92
+ * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
93
+ * [`proca plugins update`](#proca-plugins-update)
94
+ * [`proca service add`](#proca-service-add)
95
+ * [`proca service list`](#proca-service-list)
96
+ * [`proca target add`](#proca-target-add)
97
+ * [`proca template add`](#proca-template-add)
98
+ * [`proca template list`](#proca-template-list)
99
+ * [`proca user get`](#proca-user-get)
100
+ * [`proca user invite`](#proca-user-invite)
101
+ * [`proca user join`](#proca-user-join)
102
+ * [`proca user leave`](#proca-user-leave)
103
+ * [`proca user list`](#proca-user-list)
104
+ * [`proca user me`](#proca-user-me)
105
+ * [`proca user reset [USER]`](#proca-user-reset-user)
106
+ * [`proca user whoami`](#proca-user-whoami)
107
+ * [`proca widget add`](#proca-widget-add)
108
+ * [`proca widget delete`](#proca-widget-delete)
109
+ * [`proca widget get`](#proca-widget-get)
110
+ * [`proca widget list`](#proca-widget-list)
111
+ * [`proca widget rebuild`](#proca-widget-rebuild)
112
+ * [`proca widget update`](#proca-widget-update)
113
+
114
+ ## `proca action add`
115
+
116
+ ```
117
+ USAGE
118
+ $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
119
+ [--json | --human | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing]
120
+ [--optin] [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>]
121
+ [--country <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
122
+
123
+ FLAGS
124
+ -i, --id=<value> (required) widget's id
125
+ -n, --name=<the_short_name> name
126
+ -x, --dxid=<value> dxid
127
+ --action_type=<value> [default: register]
128
+ --body=<value> [mtt] body of the email
129
+ --country=<value> 2-letter country iso code
130
+ --email=<value> (required) email
131
+ --env=<value> [default: default] allow to switch between configurations (server or users)
132
+ --firstname=<value> (required) supporter's firstname
133
+ --lastname=<value>
134
+ --locality=<value>
135
+ --[no-]optin Whether the user opts in (default: false). Use --optin to enable or --no-optin to
136
+ explicitly disable.
137
+ --region=<value>
138
+ --street=<value>
139
+ --subject=<value> [mtt] subject of the email
140
+ --target=<value> [mtt] uid of the target
141
+ --[no-]testing Run action in testing mode (default: true). Use --no-testing to disable.
142
+ --utm=<value> utm=campaign.source.medium
143
+
144
+ OUTPUT FLAGS
145
+ --csv Format output as csv
146
+ --human Format output to be read on screen by a human [default]
147
+ --json Format output as json
148
+ --markdown Format output as markdown table
149
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
150
+
151
+ EXAMPLES
152
+ $ proca action add -i <widget_id> --firstname=John --email=john@example.org
153
+
154
+ $ proca action add -i <widget_id> --firstname=John --email=john@example.org --country=FR custom1=A custom2=B
155
+
156
+ $ proca action add -i <widget_id> --firstname=John --email=john@example.org target=715a9580-cfe6-4005-9e23-61a62ddecfea --subject='MTT subject' --body='message MTT'
157
+ ```
158
+
159
+ ## `proca action confirm`
160
+
161
+ Should the supporter confirm the action? it can be set either for all the widgets or an organisation or all the widgets of a campaign
162
+
163
+ ```
164
+ USAGE
165
+ $ proca action confirm [--json | --human | --csv | --markdown] [--env <value>]
166
+ [--simplify] [--org <value>] [--campaign <value>] [--confirm] [--template <value>]
167
+
168
+ FLAGS
169
+ --campaign=<value> campaign collecting the action
170
+ --[no-]confirm should the supporters confirm each action
171
+ --env=<value> [default: default] allow to switch between configurations (server or users)
172
+ --org=<value> organisation collecting the action
173
+ --template=<value> template for sending the message
174
+
175
+ OUTPUT FLAGS
176
+ --csv Format output as csv
177
+ --human Format output to be read on screen by a human [default]
178
+ --json Format output as json
179
+ --markdown Format output as markdown table
180
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
181
+
182
+ DESCRIPTION
183
+ Should the supporter confirm the action? it can be set either for all the widgets or an organisation or all the
184
+ widgets of a campaign
185
+ ```
186
+
187
+ ## `proca action count`
188
+
189
+ counter of actions
190
+
191
+ ```
192
+ USAGE
193
+ $ proca action count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
194
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
195
+
196
+ FLAGS
197
+ -i, --id=<value>
198
+ -n, --name=<the_short_name> name
199
+ -x, --dxid=<value> dxid
200
+ --env=<value> [default: default] allow to switch between configurations (server or users)
201
+
202
+ OUTPUT FLAGS
203
+ --csv Format output as csv
204
+ --human Format output to be read on screen by a human [default]
205
+ --json Format output as json
206
+ --markdown Format output as markdown table
207
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
208
+
209
+ DESCRIPTION
210
+ counter of actions
211
+
212
+ EXAMPLES
213
+ $ proca action count --id <id of the campaign>
214
+
215
+ $ proca action count --name <name of the campaign>
216
+ ```
217
+
218
+ ## `proca action list [TITLE]`
219
+
220
+ ```
221
+ USAGE
222
+ $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv |
223
+ --markdown] [--env <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
224
+ [--testing] [--doi] [--utm | --simplify] [--comment | ]
225
+
226
+ ARGUMENTS
227
+ TITLE name of the campaign, % for wildchar
228
+
229
+ FLAGS
230
+ -c, --campaign=<campaign name> name of the campaign, % for wildchar
231
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
232
+ --after=2025-04-09 only actions after a date
233
+ --[no-]comment display the comment
234
+ --doi only export the double optin actions
235
+ --env=<value> [default: default] allow to switch between configurations (server or users)
236
+ --limit=<value> max number of actions
237
+ --optin only export the optin actions
238
+ --testing also export the test actions
239
+ --today only actions today
240
+ --[no-]utm display the utm tracking parameters
241
+
242
+ OUTPUT FLAGS
243
+ --csv Format output as csv
244
+ --human Format output to be read on screen by a human [default]
245
+ --json Format output as json
246
+ --markdown Format output as markdown table
247
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
248
+
249
+ EXAMPLES
250
+ $ proca action list %pizza%
251
+ ```
252
+
253
+ ## `proca action replay`
254
+
255
+ ```
256
+ USAGE
257
+ $ proca action replay -o <organisation name> [--json | --human | --csv | --markdown]
258
+ [--env <value>] [--simplify] [-c <campaign title>]
259
+
260
+ FLAGS
261
+ -c, --campaign=<campaign title> name of the campaign, % for wildchar
262
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
263
+ --env=<value> [default: default] allow to switch between configurations (server or users)
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
+ --markdown Format output as markdown table
270
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
271
+
272
+ EXAMPLES
273
+ $ proca action replay %pizza%
274
+ ```
275
+
276
+ ## `proca action requeue`
277
+
278
+ requeue actions
279
+
280
+ ```
281
+ USAGE
282
+ $ proca action requeue -o <org name> -q
283
+ CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --human |
284
+ --csv | --markdown] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after
285
+ 2025-04-09] [--optin] [--testing] [--doi]
286
+
287
+ FLAGS
288
+ -c, --campaign=<campaign name> name of the campaign, % for wildchar
289
+ -o, --org=<org name> (required) name of the org
290
+ -q, --queue=<option> (required) [default: CUSTOM_ACTION_DELIVER] queue to redeliver to
291
+ <options: CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_S
292
+ UPPORTER|SQS|WEBHOOK>
293
+ --after=2025-04-09 only actions after a date
294
+ --doi only export the double optin actions
295
+ --env=<value> [default: default] allow to switch between configurations (server or users)
296
+ --limit=<value> [default: 1000] how many actions per page
297
+ --optin only export the optin actions
298
+ --testing also export the test actions
299
+ --today only actions today
300
+
301
+ OUTPUT FLAGS
302
+ --csv Format output as csv
303
+ --human Format output to be read on screen by a human [default]
304
+ --json Format output as json
305
+ --markdown Format output as markdown table
306
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
307
+
308
+ DESCRIPTION
309
+ requeue actions
310
+
311
+ EXAMPLES
312
+ $ proca action requeue
313
+ ```
314
+
315
+ ## `proca campaign add [TITLE]`
316
+
317
+ ```
318
+ USAGE
319
+ $ proca campaign add [TITLE] -n <campaign name> -o <org name> [--json | --human | --csv
320
+ | --markdown] [--env <value>] [--simplify]
321
+
322
+ ARGUMENTS
323
+ TITLE title of the campaign
324
+
325
+ FLAGS
326
+ -n, --name=<campaign name> (required) name of the campaign
327
+ -o, --org=<org name> (required) name of the coordinator
328
+ --env=<value> [default: default] allow to switch between configurations (server or users)
329
+
330
+ OUTPUT FLAGS
331
+ --csv Format output as csv
332
+ --human Format output to be read on screen by a human [default]
333
+ --json Format output as json
334
+ --markdown Format output as markdown table
335
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
336
+
337
+ EXAMPLES
338
+ $ proca campaign add -n <new_campaign> the full name of the campaign
339
+ ```
340
+
341
+ ## `proca campaign close`
342
+
343
+ ```
344
+ USAGE
345
+ $ proca campaign close [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
346
+ --human | --csv | --markdown] [--env <value>] [--simplify]
347
+
348
+ FLAGS
349
+ --env=<value> [default: default] allow to switch between configurations (server or users)
350
+ --status=<option> (required) Status to set
351
+ <options: draft|live|closed|ignored>
352
+
353
+ OUTPUT FLAGS
354
+ --csv Format output as csv
355
+ --human Format output to be read on screen by a human [default]
356
+ --json Format output as json
357
+ --markdown Format output as markdown table
358
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
359
+
360
+ ALIASES
361
+ $ proca campaign close
362
+
363
+ EXAMPLES
364
+ $ proca campaign close -name <campaign>
365
+
366
+ $ proca campaign close -i <campaign_id>
367
+ ```
368
+
369
+ ## `proca campaign copy`
370
+
371
+ Copy campaign settings to a new campaign
372
+
373
+ ```
374
+ USAGE
375
+ $ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
376
+ --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title
377
+ <campaign title>] [--dry-run]
378
+
379
+ FLAGS
380
+ -i, --id=<value>
381
+ -n, --name=<the_short_name> name
382
+ -o, --org=<org name> organization for the new campaign (defaults to source campaign org)
383
+ -t, --to=<campaign name> (required) new campaign name
384
+ -x, --dxid=<value> dxid
385
+ --dry-run preview changes without executing
386
+ --env=<value> [default: default] allow to switch between configurations (server or users)
387
+ --title=<campaign title> title for the new campaign (defaults to source campaign title)
388
+
389
+ OUTPUT FLAGS
390
+ --csv Format output as csv
391
+ --human Format output to be read on screen by a human [default]
392
+ --json Format output as json
393
+ --markdown Format output as markdown table
394
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
395
+
396
+ DESCRIPTION
397
+ Copy campaign settings to a new campaign
398
+
399
+ EXAMPLES
400
+ $ proca campaign copy test_2025 --to test_2026
401
+
402
+ $ proca campaign copy -n old_campaign --to new_campaign -o different_org
403
+ ```
404
+
405
+ ## `proca campaign delete`
406
+
407
+ delete a campaign
408
+
409
+ ```
410
+ USAGE
411
+ $ proca campaign delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
412
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
413
+
414
+ FLAGS
415
+ -i, --id=<value>
416
+ -n, --name=<the_short_name> name
417
+ -x, --dxid=<value> dxid
418
+ --env=<value> [default: default] allow to switch between configurations (server or users)
419
+
420
+ OUTPUT FLAGS
421
+ --csv Format output as csv
422
+ --human Format output to be read on screen by a human [default]
423
+ --json Format output as json
424
+ --markdown Format output as markdown table
425
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
426
+
427
+ DESCRIPTION
428
+ delete a campaign
429
+
430
+ EXAMPLES
431
+ $ proca campaign delete 42
432
+
433
+ $ proca campaign delete -i 42
434
+
435
+ $ proca campaign delete my_campaign
436
+
437
+ $ proca campaign delete -n my_campaign
438
+ ```
439
+
440
+ ## `proca campaign get`
441
+
442
+ view a campaign
443
+
444
+ ```
445
+ USAGE
446
+ $ proca campaign get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
447
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
448
+
449
+ FLAGS
450
+ -i, --id=<value>
451
+ -n, --name=<the_short_name> name
452
+ -x, --dxid=<value> dxid
453
+ --[no-]config display the config
454
+ --env=<value> [default: default] allow to switch between configurations (server or users)
455
+ --locale=<value> display a locale
456
+ --[no-]stats display the stats
457
+
458
+ OUTPUT FLAGS
459
+ --csv Format output as csv
460
+ --human Format output to be read on screen by a human [default]
461
+ --json Format output as json
462
+ --markdown Format output as markdown table
463
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
464
+
465
+ DESCRIPTION
466
+ view a campaign
467
+
468
+ EXAMPLES
469
+ $ proca campaign get -i 42
470
+ ```
471
+
472
+ ## `proca campaign list [TITLE]`
473
+
474
+ list all the campaigns
475
+
476
+ ```
477
+ USAGE
478
+ $ proca campaign list [TITLE] [--json | --human | --csv | --markdown] [--env <value>]
479
+ [--simplify] [-o <organisation name>] [-t <campaign title>] [--stats]
480
+
481
+ ARGUMENTS
482
+ TITLE name of the campaign, % for wildchar
483
+
484
+ FLAGS
485
+ -o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
486
+ -t, --title=<campaign title> name of the campaign, % for wildchar
487
+ --env=<value> [default: default] allow to switch between configurations (server or users)
488
+ --[no-]stats display the stats
489
+
490
+ OUTPUT FLAGS
491
+ --csv Format output as csv
492
+ --human Format output to be read on screen by a human [default]
493
+ --json Format output as json
494
+ --markdown Format output as markdown table
495
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
496
+
497
+ DESCRIPTION
498
+ list all the campaigns
499
+
500
+ EXAMPLES
501
+ $ proca campaign list %pizza%
502
+ ```
503
+
504
+ ## `proca campaign mtt`
505
+
506
+ set the mail to target (mtt) params
507
+
508
+ ```
509
+ USAGE
510
+ $ proca campaign mtt [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
511
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--from <value>] [--to <value>] [--template
512
+ <value>] [--period <value>] [--email <value>] [--cc <value>] [--sender] [--drip]
513
+
514
+ FLAGS
515
+ -i, --id=<value>
516
+ -n, --name=<the_short_name> name
517
+ -x, --dxid=<value> dxid
518
+ --cc=<value> comma-separated list of CC email addresses
519
+ --drip drip delivery or deliver as fast as possible
520
+ --email=<value> test email address
521
+ --env=<value> [default: default] allow to switch between configurations (server or users)
522
+ --from=<value> start date (yyyy-mm-dd)
523
+ --period=<value> [default: 09:09-18:18] period of the day (HH:HH-HH:HH)
524
+ --sender add sender to CC
525
+ --template=<value> mtt template to use
526
+ --to=<value> end date (yyyy-mm-dd)
527
+
528
+ OUTPUT FLAGS
529
+ --csv Format output as csv
530
+ --human Format output to be read on screen by a human [default]
531
+ --json Format output as json
532
+ --markdown Format output as markdown table
533
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
534
+
535
+ DESCRIPTION
536
+ set the mail to target (mtt) params
537
+
538
+ EXAMPLES
539
+ $ proca campaign mtt -n <test-mtt-campaign>
540
+ ```
541
+
542
+ ## `proca campaign status`
543
+
544
+ ```
545
+ USAGE
546
+ $ proca campaign status [ID_NAME_DXID] --status draft|live|closed|ignored [--json |
547
+ --human | --csv | --markdown] [--env <value>] [--simplify]
548
+
549
+ FLAGS
550
+ --env=<value> [default: default] allow to switch between configurations (server or users)
551
+ --status=<option> (required) Status to set
552
+ <options: draft|live|closed|ignored>
553
+
554
+ OUTPUT FLAGS
555
+ --csv Format output as csv
556
+ --human Format output to be read on screen by a human [default]
557
+ --json Format output as json
558
+ --markdown Format output as markdown table
559
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
560
+
561
+ ALIASES
562
+ $ proca campaign close
563
+
564
+ EXAMPLES
565
+ $ proca campaign status -name <campaign>
566
+
567
+ $ proca campaign status -i <campaign_id>
568
+ ```
569
+
570
+ ## `proca campaign widget archive`
571
+
572
+ Archive all widgets in the campaign by adding suffix
573
+
574
+ ```
575
+ USAGE
576
+ $ proca campaign widget archive [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
577
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
578
+
579
+ FLAGS
580
+ -i, --id=<value>
581
+ -n, --name=<the_short_name> name
582
+ -s, --suffix=<suffix> [default: _archive] custom suffix to append (default: _archive)
583
+ -x, --dxid=<value> dxid
584
+ --dry-run preview changes without executing
585
+ --env=<value> [default: default] allow to switch between configurations (server or users)
586
+
587
+ OUTPUT FLAGS
588
+ --csv Format output as csv
589
+ --human Format output to be read on screen by a human [default]
590
+ --json Format output as json
591
+ --markdown Format output as markdown table
592
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
593
+
594
+ DESCRIPTION
595
+ Archive all widgets in the campaign by adding suffix
596
+
597
+ EXAMPLES
598
+ $ proca campaign widget archive old_campaign
599
+
600
+ $ proca campaign widget archive -n old_campaign --suffix _backup
601
+
602
+ $ proca campaign widget archive old_campaign --dry-run
603
+ ```
604
+
605
+ ## `proca campaign widget copy`
606
+
607
+ Copy widgets from one campaign to another
608
+
609
+ ```
610
+ USAGE
611
+ $ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
612
+ --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
613
+
614
+ FLAGS
615
+ -i, --id=<value>
616
+ -n, --name=<the_short_name> name
617
+ -s, --suffix=<suffix> [default: _archive] suffix to remove from widget names (e.g., _archive, -v1)
618
+ -t, --to=<campaign name> (required) destination campaign name
619
+ -x, --dxid=<value> dxid
620
+ --dry-run preview changes without executing
621
+ --env=<value> [default: default] allow to switch between configurations (server or users)
622
+
623
+ OUTPUT FLAGS
624
+ --csv Format output as csv
625
+ --human Format output to be read on screen by a human [default]
626
+ --json Format output as json
627
+ --markdown Format output as markdown table
628
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
629
+
630
+ DESCRIPTION
631
+ Copy widgets from one campaign to another
632
+
633
+ EXAMPLES
634
+ $ proca campaign widget copy old_campaign --to new_campaign
635
+
636
+ $ proca campaign widget copy -n old_campaign --to new_campaign
637
+
638
+ $ proca campaign widget copy old_campaign --to new_campaign --suffix _archive
639
+
640
+ $ proca campaign widget copy old_campaign --to new_campaign --dry-run
641
+ ```
642
+
643
+ ## `proca campaign widget get`
644
+
645
+ List widgets in a campaign
646
+
647
+ ```
648
+ USAGE
649
+ $ proca campaign widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
650
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
651
+
652
+ FLAGS
653
+ -i, --id=<value>
654
+ -n, --name=<the_short_name> name
655
+ -x, --dxid=<value> dxid
656
+ --env=<value> [default: default] allow to switch between configurations (server or users)
657
+
658
+ OUTPUT FLAGS
659
+ --csv Format output as csv
660
+ --human Format output to be read on screen by a human [default]
661
+ --json Format output as json
662
+ --markdown Format output as markdown table
663
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
664
+
665
+ DESCRIPTION
666
+ List widgets in a campaign
667
+ ```
668
+
669
+ ## `proca campaign widget rebuild`
670
+
671
+ (re)build all the widgets of a campaign
672
+
673
+ ```
674
+ USAGE
675
+ $ proca campaign widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
676
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
677
+
678
+ FLAGS
679
+ -i, --id=<value>
680
+ -n, --name=<the_short_name> name
681
+ -x, --dxid=<value> dxid
682
+ --env=<value> [default: default] allow to switch between configurations (server or users)
683
+
684
+ OUTPUT FLAGS
685
+ --csv Format output as csv
686
+ --human Format output to be read on screen by a human [default]
687
+ --json Format output as json
688
+ --markdown Format output as markdown table
689
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
690
+
691
+ DESCRIPTION
692
+ (re)build all the widgets of a campaign
693
+
694
+ EXAMPLES
695
+ $ proca-cli campaign widget rebuild climate-action
696
+ ```
697
+
698
+ ## `proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
699
+
700
+ create setting to access to a server
701
+
702
+ ```
703
+ USAGE
704
+ $ proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
705
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
706
+ you@example.org] [--folder /var/www/proca/config.example]
707
+
708
+ ARGUMENTS
709
+ ENV [default: default] allow to switch between configurations (server or users)
710
+ HUMAN [default: true] Format output to be read on screen by a human [default]
711
+ JSON Format output as json
712
+ CSV Format output as csv
713
+ MARKDOWN Format output as markdown table
714
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
715
+
716
+ FLAGS
717
+ --email=you@example.org user email on proca server
718
+ --env=<value> [default: default] allow to switch between configurations (server or users)
719
+ --folder=/var/www/proca/config.example config folder (in the proca widget generator)
720
+ --token=API-token> user token on proca server
721
+ --url=http://localhost:4000 [default: https://api.proca.app/api] url of the proca server api
722
+
723
+ OUTPUT FLAGS
724
+ --csv Format output as csv
725
+ --human Format output to be read on screen by a human [default]
726
+ --json Format output as json
727
+ --markdown Format output as markdown table
728
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
729
+
730
+ DESCRIPTION
731
+ create setting to access to a server
732
+
733
+ ALIASES
734
+ $ proca config setup
735
+ $ proca config init
736
+
737
+ EXAMPLES
738
+ $ proca config add --user=xavier@example.org --token=API-12345789
739
+ ```
740
+
741
+ ## `proca config folder`
742
+
743
+ Check and create config folders
744
+
745
+ ```
746
+ USAGE
747
+ $ proca config folder [--json | --human | --csv | --markdown] [--env <value>]
748
+ [--simplify]
749
+
750
+ FLAGS
751
+ --env=<value> [default: default] allow to switch between configurations (server or users)
752
+
753
+ OUTPUT FLAGS
754
+ --csv Format output as csv
755
+ --human Format output to be read on screen by a human [default]
756
+ --json Format output as json
757
+ --markdown Format output as markdown table
758
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
759
+
760
+ DESCRIPTION
761
+ Check and create config folders
762
+
763
+ Check if the PROCA_CONFIG_FOLDER is set up, if it is, check if the required subfolders exists and create if not
764
+ ```
765
+
766
+ ## `proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
767
+
768
+ create setting to access to a server
769
+
770
+ ```
771
+ USAGE
772
+ $ proca config init [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
773
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
774
+ you@example.org] [--folder /var/www/proca/config.example]
775
+
776
+ ARGUMENTS
777
+ ENV [default: default] allow to switch between configurations (server or users)
778
+ HUMAN [default: true] Format output to be read on screen by a human [default]
779
+ JSON Format output as json
780
+ CSV Format output as csv
781
+ MARKDOWN Format output as markdown table
782
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
783
+
784
+ FLAGS
785
+ --email=you@example.org user email on proca server
786
+ --env=<value> [default: default] allow to switch between configurations (server or users)
787
+ --folder=/var/www/proca/config.example config folder (in the proca widget generator)
788
+ --token=API-token> user token on proca server
789
+ --url=http://localhost:4000 [default: https://api.proca.app/api] url of the proca server api
790
+
791
+ OUTPUT FLAGS
792
+ --csv Format output as csv
793
+ --human Format output to be read on screen by a human [default]
794
+ --json Format output as json
795
+ --markdown Format output as markdown table
796
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
797
+
798
+ DESCRIPTION
799
+ create setting to access to a server
800
+
801
+ ALIASES
802
+ $ proca config setup
803
+ $ proca config init
804
+
805
+ EXAMPLES
806
+ $ proca config init --user=xavier@example.org --token=API-12345789
807
+ ```
808
+
809
+ ## `proca config server`
810
+
811
+ get the server config
812
+
813
+ ```
814
+ USAGE
815
+ $ proca config server [--json | --human | --csv | --markdown] [--env <value>]
816
+ [--simplify]
817
+
818
+ FLAGS
819
+ --env=<value> [default: default] allow to switch between configurations (server or users)
820
+
821
+ OUTPUT FLAGS
822
+ --csv Format output as csv
823
+ --human Format output to be read on screen by a human [default]
824
+ --json Format output as json
825
+ --markdown Format output as markdown table
826
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
827
+
828
+ DESCRIPTION
829
+ get the server config
830
+ ```
831
+
832
+ ## `proca config set [KEY] [VALUE]`
833
+
834
+ update the setting used to authenticate to the servers and services
835
+
836
+ ```
837
+ USAGE
838
+ $ proca config set [KEY] [VALUE] [--json | --human | --csv | --markdown] [--env
839
+ <value>] [--simplify] [--environment <value>] [--url <url>] [--token <API-token>]
840
+
841
+ ARGUMENTS
842
+ KEY variable name
843
+ VALUE value
844
+
845
+ FLAGS
846
+ --env=<value> [default: default] allow to switch between configurations (server or users)
847
+ --environment=<value> [default: default] environment
848
+ --token=<API-token> user token on proca server
849
+ --url=<url> [default: https://api.proca.app/api] url of the proca server api
850
+
851
+ OUTPUT FLAGS
852
+ --csv Format output as csv
853
+ --human Format output to be read on screen by a human [default]
854
+ --json Format output as json
855
+ --markdown Format output as markdown table
856
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
857
+
858
+ DESCRIPTION
859
+ update the setting used to authenticate to the servers and services
860
+
861
+ ALIASES
862
+ $ proca config setup
863
+
864
+ EXAMPLES
865
+ $ proca config set --user=xavier@example.org --token=API-12345789
866
+
867
+ $ proca config set VAR1 VALUE
868
+ ```
869
+
870
+ ## `proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`
871
+
872
+ create setting to access to a server
873
+
874
+ ```
875
+ USAGE
876
+ $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY] [--json | --human
877
+ | --csv | --markdown] [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email
878
+ you@example.org] [--folder /var/www/proca/config.example]
879
+
880
+ ARGUMENTS
881
+ ENV [default: default] allow to switch between configurations (server or users)
882
+ HUMAN [default: true] Format output to be read on screen by a human [default]
883
+ JSON Format output as json
884
+ CSV Format output as csv
885
+ MARKDOWN Format output as markdown table
886
+ SIMPLIFY flatten and filter to output only the most important attributes, mostly relevant for json
887
+
888
+ FLAGS
889
+ --email=you@example.org user email on proca server
890
+ --env=<value> [default: default] allow to switch between configurations (server or users)
891
+ --folder=/var/www/proca/config.example config folder (in the proca widget generator)
892
+ --token=API-token> user token on proca server
893
+ --url=http://localhost:4000 [default: https://api.proca.app/api] url of the proca server api
894
+
895
+ OUTPUT FLAGS
896
+ --csv Format output as csv
897
+ --human Format output to be read on screen by a human [default]
898
+ --json Format output as json
899
+ --markdown Format output as markdown table
900
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
901
+
902
+ DESCRIPTION
903
+ create setting to access to a server
904
+
905
+ ALIASES
906
+ $ proca config setup
907
+ $ proca config init
908
+
909
+ EXAMPLES
910
+ $ proca config setup --user=xavier@example.org --token=API-12345789
911
+ ```
912
+
913
+ ## `proca config user`
914
+
915
+ fetch the information about the current user (based on the token)
916
+
917
+ ```
918
+ USAGE
919
+ $ proca config user [--json | --human | --csv | --markdown] [--env <value>]
920
+ [--simplify]
921
+
922
+ FLAGS
923
+ --env=<value> [default: default] allow to switch between configurations (server or users)
924
+
925
+ OUTPUT FLAGS
926
+ --csv Format output as csv
927
+ --human Format output to be read on screen by a human [default]
928
+ --json Format output as json
929
+ --markdown Format output as markdown table
930
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
931
+
932
+ DESCRIPTION
933
+ fetch the information about the current user (based on the token)
934
+
935
+ ALIASES
936
+ $ proca user whoami
937
+ $ proca user me
938
+
939
+ EXAMPLES
940
+ $ proca config user
941
+ ```
942
+
943
+ ## `proca contact count`
944
+
945
+ counter of supporters
946
+
947
+ ```
948
+ USAGE
949
+ $ proca contact count [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
950
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
951
+
952
+ FLAGS
953
+ -i, --id=<value>
954
+ -n, --name=<the_short_name> name
955
+ -x, --dxid=<value> dxid
956
+ --env=<value> [default: default] allow to switch between configurations (server or users)
957
+
958
+ OUTPUT FLAGS
959
+ --csv Format output as csv
960
+ --human Format output to be read on screen by a human [default]
961
+ --json Format output as json
962
+ --markdown Format output as markdown table
963
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
964
+
965
+ DESCRIPTION
966
+ counter of supporters
967
+
968
+ EXAMPLES
969
+ $ proca contact count --name <name of the campaign>
970
+ ```
971
+
972
+ ## `proca contact list [TITLE]`
973
+
974
+ ```
975
+ USAGE
976
+ $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv |
977
+ --markdown] [--env <value>] [-c <campaign title>] [-n <value>] [--today | --after 2025-04-09] [--optin] [--testing]
978
+ [--doi] [--utm | --simplify] [--comment | ]
979
+
980
+ ARGUMENTS
981
+ TITLE name of the campaign, % for wildchar
982
+
983
+ FLAGS
984
+ -c, --campaign=<campaign title> name of the campaign, % for wildchar
985
+ -n, --limit=<value> max number of actions
986
+ -o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
987
+ --after=2025-04-09 only actions after a date
988
+ --[no-]comment display the comment
989
+ --doi only export the double optin actions
990
+ --env=<value> [default: default] allow to switch between configurations (server or users)
991
+ --optin only export the optin actions
992
+ --testing also export the test actions
993
+ --today only actions today
994
+ --[no-]utm display the utm tracking parameters
995
+
996
+ OUTPUT FLAGS
997
+ --csv Format output as csv
998
+ --human Format output to be read on screen by a human [default]
999
+ --json Format output as json
1000
+ --markdown Format output as markdown table
1001
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1002
+
1003
+ EXAMPLES
1004
+ $ proca contact list %pizza%
1005
+ ```
1006
+
1007
+ ## `proca help [COMMAND]`
1008
+
1009
+ Display help for proca.
1010
+
1011
+ ```
1012
+ USAGE
1013
+ $ proca help [COMMAND...] [-n]
1014
+
1015
+ ARGUMENTS
1016
+ COMMAND... Command to show help for.
1017
+
1018
+ FLAGS
1019
+ -n, --nested-commands Include all nested commands in the output.
1020
+
1021
+ DESCRIPTION
1022
+ Display help for proca.
1023
+ ```
1024
+
1025
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
1026
+
1027
+ ## `proca org add`
1028
+
1029
+ ```
1030
+ USAGE
1031
+ $ proca org add [--json | --human | --csv | --markdown] [--env <value>]
1032
+ [--simplify] [--twitter <screen name>] [-n <org acronym/name>] [-t <org full name>]
1033
+
1034
+ FLAGS
1035
+ -n, --name=<org acronym/name> short name of the org
1036
+ -t, --title=<org full name> title/full name of the org
1037
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1038
+ --twitter=<screen name> twitter account
1039
+
1040
+ OUTPUT FLAGS
1041
+ --csv Format output as csv
1042
+ --human Format output to be read on screen by a human [default]
1043
+ --json Format output as json
1044
+ --markdown Format output as markdown table
1045
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1046
+
1047
+ EXAMPLES
1048
+ $ proca org add --name <twitter of the organisation> --title='this is an organisation'
1049
+
1050
+ $ proca org add --twitter <twitter of the organisation>
1051
+ ```
1052
+
1053
+ ## `proca org crm`
1054
+
1055
+ view a org crm synchroniser
1056
+
1057
+ ```
1058
+ USAGE
1059
+ $ proca org crm -n <org name> [--json | --human | --csv | --markdown] [--env
1060
+ <value>] [--simplify] [--synchronize]
1061
+
1062
+ FLAGS
1063
+ -n, --name=<org name> (required) name of the org
1064
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1065
+ --[no-]synchronize enable or disable the synchronisation queue
1066
+
1067
+ OUTPUT FLAGS
1068
+ --csv Format output as csv
1069
+ --human Format output to be read on screen by a human [default]
1070
+ --json Format output as json
1071
+ --markdown Format output as markdown table
1072
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1073
+
1074
+ DESCRIPTION
1075
+ view a org crm synchroniser
1076
+ ```
1077
+
1078
+ ## `proca org delete`
1079
+
1080
+ ```
1081
+ USAGE
1082
+ $ proca org delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1083
+ <value>] [--simplify] [-i <value> | -n <org name> | -x <value>]
1084
+
1085
+ FLAGS
1086
+ -i, --id=<value>
1087
+ -n, --name=<org name> name of the org
1088
+ -x, --dxid=<value> dxid
1089
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1090
+
1091
+ OUTPUT FLAGS
1092
+ --csv Format output as csv
1093
+ --human Format output to be read on screen by a human [default]
1094
+ --json Format output as json
1095
+ --markdown Format output as markdown table
1096
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1097
+
1098
+ EXAMPLES
1099
+ $ proca org delete <organisation_name>
1100
+ ```
1101
+
1102
+ ## `proca org email`
1103
+
1104
+ Set email service and supporter confirmation for an org
1105
+
1106
+ ```
1107
+ USAGE
1108
+ $ proca org email [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1109
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe
1110
+ system preview webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm]
1111
+ [--supporter-confirm-template <value>]
1112
+
1113
+ FLAGS
1114
+ -i, --id=<value>
1115
+ -n, --name=<the_short_name> name
1116
+ -x, --dxid=<value> dxid
1117
+ --env=<value> [default: default] allow to switch
1118
+ between configurations (server or
1119
+ users)
1120
+ --from=default <org>@proca.app Email address to send from
1121
+ --mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp [default: system] service to send
1122
+ emails
1123
+ --[no-]supporter-confirm enable/disable action confirmation
1124
+ emails
1125
+ --supporter-confirm-template=<value> add confirmation template
1126
+
1127
+ OUTPUT FLAGS
1128
+ --csv Format output as csv
1129
+ --human Format output to be read on screen by a human [default]
1130
+ --json Format output as json
1131
+ --markdown Format output as markdown table
1132
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1133
+
1134
+ DESCRIPTION
1135
+ Set email service and supporter confirmation for an org
1136
+ ```
1137
+
1138
+ ## `proca org get`
1139
+
1140
+ view a org
1141
+
1142
+ ```
1143
+ USAGE
1144
+ $ proca org get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1145
+ <value>] [--simplify] [-n <org name>] [--config] [--personaldata] [--processing] [--keys] [--campaigns] [--users]
1146
+
1147
+ FLAGS
1148
+ -n, --name=<org name> name of the org
1149
+ --[no-]campaigns
1150
+ --[no-]config display the config
1151
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1152
+ --[no-]keys
1153
+ --[no-]personaldata how are the personal data of the supporter processed
1154
+ --[no-]processing additional processing workflows on the actions
1155
+ --[no-]users
1156
+
1157
+ OUTPUT FLAGS
1158
+ --csv Format output as csv
1159
+ --human Format output to be read on screen by a human [default]
1160
+ --json Format output as json
1161
+ --markdown Format output as markdown table
1162
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1163
+
1164
+ DESCRIPTION
1165
+ view a org
1166
+
1167
+ EXAMPLES
1168
+ $ proca org get <name of the ngo>
1169
+ ```
1170
+
1171
+ ## `proca org user get`
1172
+
1173
+ list all the users
1174
+
1175
+ ```
1176
+ USAGE
1177
+ $ proca org user get -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1178
+ [--simplify]
1179
+
1180
+ FLAGS
1181
+ -o, --org=<value> (required) organisation
1182
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1183
+
1184
+ OUTPUT FLAGS
1185
+ --csv Format output as csv
1186
+ --human Format output to be read on screen by a human [default]
1187
+ --json Format output as json
1188
+ --markdown Format output as markdown table
1189
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1190
+
1191
+ DESCRIPTION
1192
+ list all the users
1193
+
1194
+ ALIASES
1195
+ $ proca org user get
1196
+
1197
+ EXAMPLES
1198
+ $ proca org user get %pizza%
1199
+ ```
1200
+
1201
+ ## `proca plugins`
1202
+
1203
+ List installed plugins.
1204
+
1205
+ ```
1206
+ USAGE
1207
+ $ proca plugins [--json] [--core]
1208
+
1209
+ FLAGS
1210
+ --core Show core plugins.
1211
+
1212
+ GLOBAL FLAGS
1213
+ --json Format output as json.
1214
+
1215
+ DESCRIPTION
1216
+ List installed plugins.
1217
+
1218
+ EXAMPLES
1219
+ $ proca plugins
1220
+ ```
1221
+
1222
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
1223
+
1224
+ ## `proca plugins add PLUGIN`
1225
+
1226
+ Installs a plugin into proca.
1227
+
1228
+ ```
1229
+ USAGE
1230
+ $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
1231
+
1232
+ ARGUMENTS
1233
+ PLUGIN... Plugin to install.
1234
+
1235
+ FLAGS
1236
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1237
+ -h, --help Show CLI help.
1238
+ -s, --silent Silences npm output.
1239
+ -v, --verbose Show verbose npm output.
1240
+
1241
+ GLOBAL FLAGS
1242
+ --json Format output as json.
1243
+
1244
+ DESCRIPTION
1245
+ Installs a plugin into proca.
1246
+
1247
+ Uses npm to install plugins.
1248
+
1249
+ Installation of a user-installed plugin will override a core plugin.
1250
+
1251
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1252
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1253
+
1254
+ ALIASES
1255
+ $ proca plugins add
1256
+
1257
+ EXAMPLES
1258
+ Install a plugin from npm registry.
1259
+
1260
+ $ proca plugins add myplugin
1261
+
1262
+ Install a plugin from a github url.
1263
+
1264
+ $ proca plugins add https://github.com/someuser/someplugin
1265
+
1266
+ Install a plugin from a github slug.
1267
+
1268
+ $ proca plugins add someuser/someplugin
1269
+ ```
1270
+
1271
+ ## `proca plugins:inspect PLUGIN...`
1272
+
1273
+ Displays installation properties of a plugin.
1274
+
1275
+ ```
1276
+ USAGE
1277
+ $ proca plugins inspect PLUGIN...
1278
+
1279
+ ARGUMENTS
1280
+ PLUGIN... [default: .] Plugin to inspect.
1281
+
1282
+ FLAGS
1283
+ -h, --help Show CLI help.
1284
+ -v, --verbose
1285
+
1286
+ GLOBAL FLAGS
1287
+ --json Format output as json.
1288
+
1289
+ DESCRIPTION
1290
+ Displays installation properties of a plugin.
1291
+
1292
+ EXAMPLES
1293
+ $ proca plugins inspect myplugin
1294
+ ```
1295
+
1296
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
1297
+
1298
+ ## `proca plugins install PLUGIN`
1299
+
1300
+ Installs a plugin into proca.
1301
+
1302
+ ```
1303
+ USAGE
1304
+ $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
1305
+
1306
+ ARGUMENTS
1307
+ PLUGIN... Plugin to install.
1308
+
1309
+ FLAGS
1310
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
1311
+ -h, --help Show CLI help.
1312
+ -s, --silent Silences npm output.
1313
+ -v, --verbose Show verbose npm output.
1314
+
1315
+ GLOBAL FLAGS
1316
+ --json Format output as json.
1317
+
1318
+ DESCRIPTION
1319
+ Installs a plugin into proca.
1320
+
1321
+ Uses npm to install plugins.
1322
+
1323
+ Installation of a user-installed plugin will override a core plugin.
1324
+
1325
+ Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1326
+ Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
1327
+
1328
+ ALIASES
1329
+ $ proca plugins add
1330
+
1331
+ EXAMPLES
1332
+ Install a plugin from npm registry.
1333
+
1334
+ $ proca plugins install myplugin
1335
+
1336
+ Install a plugin from a github url.
1337
+
1338
+ $ proca plugins install https://github.com/someuser/someplugin
1339
+
1340
+ Install a plugin from a github slug.
1341
+
1342
+ $ proca plugins install someuser/someplugin
1343
+ ```
1344
+
1345
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
1346
+
1347
+ ## `proca plugins link PATH`
1348
+
1349
+ Links a plugin into the CLI for development.
1350
+
1351
+ ```
1352
+ USAGE
1353
+ $ proca plugins link PATH [-h] [--install] [-v]
1354
+
1355
+ ARGUMENTS
1356
+ PATH [default: .] path to plugin
1357
+
1358
+ FLAGS
1359
+ -h, --help Show CLI help.
1360
+ -v, --verbose
1361
+ --[no-]install Install dependencies after linking the plugin.
1362
+
1363
+ DESCRIPTION
1364
+ Links a plugin into the CLI for development.
1365
+
1366
+ Installation of a linked plugin will override a user-installed or core plugin.
1367
+
1368
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
1369
+ command will override the user-installed or core plugin implementation. This is useful for development work.
1370
+
1371
+
1372
+ EXAMPLES
1373
+ $ proca plugins link myplugin
1374
+ ```
1375
+
1376
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
1377
+
1378
+ ## `proca plugins remove [PLUGIN]`
1379
+
1380
+ Removes a plugin from the CLI.
1381
+
1382
+ ```
1383
+ USAGE
1384
+ $ proca plugins remove [PLUGIN...] [-h] [-v]
1385
+
1386
+ ARGUMENTS
1387
+ PLUGIN... plugin to uninstall
1388
+
1389
+ FLAGS
1390
+ -h, --help Show CLI help.
1391
+ -v, --verbose
1392
+
1393
+ DESCRIPTION
1394
+ Removes a plugin from the CLI.
1395
+
1396
+ ALIASES
1397
+ $ proca plugins unlink
1398
+ $ proca plugins remove
1399
+
1400
+ EXAMPLES
1401
+ $ proca plugins remove myplugin
1402
+ ```
1403
+
1404
+ ## `proca plugins reset`
1405
+
1406
+ Remove all user-installed and linked plugins.
1407
+
1408
+ ```
1409
+ USAGE
1410
+ $ proca plugins reset [--hard] [--reinstall]
1411
+
1412
+ FLAGS
1413
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1414
+ --reinstall Reinstall all plugins after uninstalling.
1415
+ ```
1416
+
1417
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
1418
+
1419
+ ## `proca plugins uninstall [PLUGIN]`
1420
+
1421
+ Removes a plugin from the CLI.
1422
+
1423
+ ```
1424
+ USAGE
1425
+ $ proca plugins uninstall [PLUGIN...] [-h] [-v]
1426
+
1427
+ ARGUMENTS
1428
+ PLUGIN... plugin to uninstall
1429
+
1430
+ FLAGS
1431
+ -h, --help Show CLI help.
1432
+ -v, --verbose
1433
+
1434
+ DESCRIPTION
1435
+ Removes a plugin from the CLI.
1436
+
1437
+ ALIASES
1438
+ $ proca plugins unlink
1439
+ $ proca plugins remove
1440
+
1441
+ EXAMPLES
1442
+ $ proca plugins uninstall myplugin
1443
+ ```
1444
+
1445
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
1446
+
1447
+ ## `proca plugins unlink [PLUGIN]`
1448
+
1449
+ Removes a plugin from the CLI.
1450
+
1451
+ ```
1452
+ USAGE
1453
+ $ proca plugins unlink [PLUGIN...] [-h] [-v]
1454
+
1455
+ ARGUMENTS
1456
+ PLUGIN... plugin to uninstall
1457
+
1458
+ FLAGS
1459
+ -h, --help Show CLI help.
1460
+ -v, --verbose
1461
+
1462
+ DESCRIPTION
1463
+ Removes a plugin from the CLI.
1464
+
1465
+ ALIASES
1466
+ $ proca plugins unlink
1467
+ $ proca plugins remove
1468
+
1469
+ EXAMPLES
1470
+ $ proca plugins unlink myplugin
1471
+ ```
1472
+
1473
+ ## `proca plugins update`
1474
+
1475
+ Update installed plugins.
1476
+
1477
+ ```
1478
+ USAGE
1479
+ $ proca plugins update [-h] [-v]
1480
+
1481
+ FLAGS
1482
+ -h, --help Show CLI help.
1483
+ -v, --verbose
1484
+
1485
+ DESCRIPTION
1486
+ Update installed plugins.
1487
+ ```
1488
+
1489
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
1490
+
1491
+ ## `proca service add`
1492
+
1493
+ Set service, usually email backend for an org, the specific meaning of each param is dependant on the service
1494
+
1495
+ ```
1496
+ USAGE
1497
+ $ proca service add -o <value> --type
1498
+ mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp [--json | --human | --csv | --markdown] [--env <value>]
1499
+ [--simplify] [--user <value>] [--password <value>] [--host <value>] [--path <value>]
1500
+
1501
+ FLAGS
1502
+ -o, --org=<value> (required) organisation running the service
1503
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1504
+ --host=<value> server of the service
1505
+ --password=<value> credential of the account on the service
1506
+ --path=<value> path on the service
1507
+ --type=<option> (required) [default: system] type of the service
1508
+ <options: mailjet|ses|stripe|test_stripe|preview|webhook|supabase|smtp>
1509
+ --user=<value> credential of the account on the service
1510
+
1511
+ OUTPUT FLAGS
1512
+ --csv Format output as csv
1513
+ --human Format output to be read on screen by a human [default]
1514
+ --json Format output as json
1515
+ --markdown Format output as markdown table
1516
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1517
+
1518
+ DESCRIPTION
1519
+ Set service, usually email backend for an org, the specific meaning of each param is dependant on the service
1520
+ ```
1521
+
1522
+ ## `proca service list`
1523
+
1524
+ list services set for an organisation
1525
+
1526
+ ```
1527
+ USAGE
1528
+ $ proca service list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1529
+ [--simplify]
1530
+
1531
+ FLAGS
1532
+ -o, --org=<value> (required) organisation running the service
1533
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1534
+
1535
+ OUTPUT FLAGS
1536
+ --csv Format output as csv
1537
+ --human Format output to be read on screen by a human [default]
1538
+ --json Format output as json
1539
+ --markdown Format output as markdown table
1540
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1541
+
1542
+ DESCRIPTION
1543
+ list services set for an organisation
1544
+ ```
1545
+
1546
+ ## `proca target add`
1547
+
1548
+ ```
1549
+ USAGE
1550
+ $ proca target add -c <value> --name <value> --email <value> [--json | --human |
1551
+ --csv | --markdown] [--env <value>] [--simplify] [--external_id <value>]
1552
+
1553
+ FLAGS
1554
+ -c, --campaign=<value> (required) mtt campaign to add the target
1555
+ --email=<value> (required) email of the target
1556
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1557
+ --external_id=<value> external id of the target
1558
+ --name=<value> (required) name of the target
1559
+
1560
+ OUTPUT FLAGS
1561
+ --csv Format output as csv
1562
+ --human Format output to be read on screen by a human [default]
1563
+ --json Format output as json
1564
+ --markdown Format output as markdown table
1565
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1566
+ ```
1567
+
1568
+ ## `proca template add`
1569
+
1570
+ ```
1571
+ USAGE
1572
+ $ proca template add -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1573
+ [--simplify] [--type thankyou|doi|confirm|doi_thankyou|doi_confirm] [-l <locale>] [-n by default type@language] [-s
1574
+ 'template:' + type]
1575
+
1576
+ FLAGS
1577
+ -l, --lang=<locale> [default: en] language
1578
+ -n, --name=by default type@language name
1579
+ -o, --org=<value> (required) organisation
1580
+ -s, --subject='template:' + type subject
1581
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1582
+ --type=<option> [default: thankyou]
1583
+ <options: thankyou|doi|confirm|doi_thankyou|doi_confirm>
1584
+
1585
+ OUTPUT FLAGS
1586
+ --csv Format output as csv
1587
+ --human Format output to be read on screen by a human [default]
1588
+ --json Format output as json
1589
+ --markdown Format output as markdown table
1590
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1591
+ ```
1592
+
1593
+ ## `proca template list`
1594
+
1595
+ list services set for an organisation
1596
+
1597
+ ```
1598
+ USAGE
1599
+ $ proca template list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1600
+ [--simplify]
1601
+
1602
+ FLAGS
1603
+ -o, --org=<value> (required) organisation having the templates
1604
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1605
+
1606
+ OUTPUT FLAGS
1607
+ --csv Format output as csv
1608
+ --human Format output to be read on screen by a human [default]
1609
+ --json Format output as json
1610
+ --markdown Format output as markdown table
1611
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1612
+
1613
+ DESCRIPTION
1614
+ list services set for an organisation
1615
+ ```
1616
+
1617
+ ## `proca user get`
1618
+
1619
+ fetch the information about a user
1620
+
1621
+ ```
1622
+ USAGE
1623
+ $ proca user get [--json | --human | --csv | --markdown] [--env <value>]
1624
+ [--simplify] [--email <value>] [-o <org name>] [-i <value>]
1625
+
1626
+ FLAGS
1627
+ -i, --id=<value> id of the user
1628
+ -o, --org=<org name> name of the org
1629
+ --email=<value> user email
1630
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1631
+
1632
+ OUTPUT FLAGS
1633
+ --csv Format output as csv
1634
+ --human Format output to be read on screen by a human [default]
1635
+ --json Format output as json
1636
+ --markdown Format output as markdown table
1637
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1638
+
1639
+ DESCRIPTION
1640
+ fetch the information about a user
1641
+
1642
+ EXAMPLES
1643
+ $ proca user get
1644
+ ```
1645
+
1646
+ ## `proca user invite`
1647
+
1648
+ invite a user to join an organisation with a role
1649
+
1650
+ ```
1651
+ USAGE
1652
+ $ proca user invite -o <org name> -u <user email> [--json | --human | --csv |
1653
+ --markdown] [--env <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
1654
+
1655
+ FLAGS
1656
+ -o, --org=<org name> (required) name of the org
1657
+ -u, --user=<user email> (required) email
1658
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1659
+ --role=<option> [default: campaigner] permission level in that org
1660
+ <options: owner|campaigner|coordinator|translator>
1661
+
1662
+ OUTPUT FLAGS
1663
+ --csv Format output as csv
1664
+ --human Format output to be read on screen by a human [default]
1665
+ --json Format output as json
1666
+ --markdown Format output as markdown table
1667
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1668
+
1669
+ DESCRIPTION
1670
+ invite a user to join an organisation with a role
1671
+
1672
+ EXAMPLES
1673
+ $ proca user invite
1674
+ ```
1675
+
1676
+ ## `proca user join`
1677
+
1678
+ let a user join an organisation with a role
1679
+
1680
+ ```
1681
+ USAGE
1682
+ $ proca user join -o <org name> [--json | --human | --csv | --markdown] [--env
1683
+ <value>] [--simplify] [--role owner|campaigner|coordinator|translator] [-u <user email>]
1684
+
1685
+ FLAGS
1686
+ -o, --org=<org name> (required) name of the org
1687
+ -u, --user=<user email> email
1688
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1689
+ --role=<option> [default: campaigner] permission level in that org
1690
+ <options: owner|campaigner|coordinator|translator>
1691
+
1692
+ OUTPUT FLAGS
1693
+ --csv Format output as csv
1694
+ --human Format output to be read on screen by a human [default]
1695
+ --json Format output as json
1696
+ --markdown Format output as markdown table
1697
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1698
+
1699
+ DESCRIPTION
1700
+ let a user join an organisation with a role
1701
+
1702
+ EXAMPLES
1703
+ $ proca user join
1704
+ ```
1705
+
1706
+ ## `proca user leave`
1707
+
1708
+ leave a org
1709
+
1710
+ ```
1711
+ USAGE
1712
+ $ proca user leave -o <org name> [--json | --human | --csv | --markdown] [--env
1713
+ <value>] [--simplify] [-u <user email>]
1714
+
1715
+ FLAGS
1716
+ -o, --org=<org name> (required) name of the org
1717
+ -u, --user=<user email> email
1718
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1719
+
1720
+ OUTPUT FLAGS
1721
+ --csv Format output as csv
1722
+ --human Format output to be read on screen by a human [default]
1723
+ --json Format output as json
1724
+ --markdown Format output as markdown table
1725
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1726
+
1727
+ DESCRIPTION
1728
+ leave a org
1729
+
1730
+ EXAMPLES
1731
+ $ proca user leave -i 42
1732
+ ```
1733
+
1734
+ ## `proca user list`
1735
+
1736
+ list all the users
1737
+
1738
+ ```
1739
+ USAGE
1740
+ $ proca user list -o <value> [--json | --human | --csv | --markdown] [--env <value>]
1741
+ [--simplify]
1742
+
1743
+ FLAGS
1744
+ -o, --org=<value> (required) organisation
1745
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1746
+
1747
+ OUTPUT FLAGS
1748
+ --csv Format output as csv
1749
+ --human Format output to be read on screen by a human [default]
1750
+ --json Format output as json
1751
+ --markdown Format output as markdown table
1752
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1753
+
1754
+ DESCRIPTION
1755
+ list all the users
1756
+
1757
+ ALIASES
1758
+ $ proca org user get
1759
+
1760
+ EXAMPLES
1761
+ $ proca user list %pizza%
1762
+ ```
1763
+
1764
+ ## `proca user me`
1765
+
1766
+ fetch the information about the current user (based on the token)
1767
+
1768
+ ```
1769
+ USAGE
1770
+ $ proca user me [--json | --human | --csv | --markdown] [--env <value>]
1771
+ [--simplify]
1772
+
1773
+ FLAGS
1774
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1775
+
1776
+ OUTPUT FLAGS
1777
+ --csv Format output as csv
1778
+ --human Format output to be read on screen by a human [default]
1779
+ --json Format output as json
1780
+ --markdown Format output as markdown table
1781
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1782
+
1783
+ DESCRIPTION
1784
+ fetch the information about the current user (based on the token)
1785
+
1786
+ ALIASES
1787
+ $ proca user whoami
1788
+ $ proca user me
1789
+
1790
+ EXAMPLES
1791
+ $ proca user me
1792
+ ```
1793
+
1794
+ ## `proca user reset [USER]`
1795
+
1796
+ Reset user API token
1797
+
1798
+ ```
1799
+ USAGE
1800
+ $ proca user reset [USER] [--json | --human | --csv | --markdown] [--env <value>]
1801
+ [--simplify] [--password <value>] [--url <value>]
1802
+
1803
+ ARGUMENTS
1804
+ USER Username (email)
1805
+
1806
+ FLAGS
1807
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1808
+ --password=<value> Password
1809
+ --url=<value> URL of the Proca server API
1810
+
1811
+ OUTPUT FLAGS
1812
+ --csv Format output as csv
1813
+ --human Format output to be read on screen by a human [default]
1814
+ --json Format output as json
1815
+ --markdown Format output as markdown table
1816
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1817
+
1818
+ DESCRIPTION
1819
+ Reset user API token
1
1820
  ```
2
- ,,\\\\\\,,
3
- ,\\\\\\\\\\\
4
- ▲▲▲▲▲▲\\\\\\\\ FIX THE STATUS QUO
5
- ▲▲▲▲▲▲▲▲\\\\\\`
6
- ▼▼▼▼▼▼▼▼\\\\\`
7
- ▼▼▼▼▼▼`^^``
8
- ```
9
-
10
- # Proca CLI[ent]
11
1821
 
12
- Library and CLI tool for querying Proca GraphQL API.
1822
+ ## `proca user whoami`
13
1823
 
14
- ## Installation
1824
+ fetch the information about the current user (based on the token)
15
1825
 
16
- it needs a recent version of nodejs installed (that will install npm too). Follow the specific instructions for your operating system
1826
+ ```
1827
+ USAGE
1828
+ $ proca user whoami [--json | --human | --csv | --markdown] [--env <value>]
1829
+ [--simplify]
17
1830
 
18
- `npm install --global proca_cli`
1831
+ FLAGS
1832
+ --env=<value> [default: default] allow to switch between configurations (server or users)
19
1833
 
20
- ## Usage
21
- ### Setup
1834
+ OUTPUT FLAGS
1835
+ --csv Format output as csv
1836
+ --human Format output to be read on screen by a human [default]
1837
+ --json Format output as json
1838
+ --markdown Format output as markdown table
1839
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
22
1840
 
23
- Proca CLI needs connection configuration, which is:
24
- - url of proca backend
25
- - org name you're connecting to
26
- - user email
27
- - user password
1841
+ DESCRIPTION
1842
+ fetch the information about the current user (based on the token)
28
1843
 
29
- You can provide these attributes as:
30
- - `.env` file, in dotfile format
31
- - environment variables (same as in `.env` file)
32
- - command line switches
1844
+ ALIASES
1845
+ $ proca user whoami
1846
+ $ proca user me
33
1847
 
34
- Environment variables are:
1848
+ EXAMPLES
1849
+ $ proca user whoami
35
1850
  ```
36
- ORG_NAME=someorg
37
- AUTH_USER=user@domain.com
38
- AUTH_PASSWORD=secret123
39
- API_URL=https://api.proca.app
40
- KEYS=keys.json
1851
+
1852
+ ## `proca widget add`
1853
+
41
1854
  ```
1855
+ USAGE
1856
+ $ proca widget add -c <campaign name> [--json | --human | --csv | --markdown] [--env
1857
+ <value>] [--simplify] [-o <en>] [-l <en>] [-n by default <campaign>/<org>/<lang>]
42
1858
 
43
- Keys are sto is also allowedred in a JSON (map of public to private keys in base64url format). The format printed by `proca-cli keys`
1859
+ FLAGS
1860
+ -c, --campaign=<campaign name> (required) name of the campaign
1861
+ -l, --lang=<en> [default: en] language
1862
+ -n, --name=by default <campaign>/<org>/<lang> url slug
1863
+ -o, --org=<en> organisation
1864
+ --env=<value> [default: default] allow to switch between configurations (server or
1865
+ users)
1866
+
1867
+ OUTPUT FLAGS
1868
+ --csv Format output as csv
1869
+ --human Format output to be read on screen by a human [default]
1870
+ --json Format output as json
1871
+ --markdown Format output as markdown table
1872
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1873
+ ```
44
1874
 
45
- You can run `proca-cli setup` to create or update .env file interactively. At the moment only one keypair is supported.
1875
+ ## `proca widget delete`
46
1876
 
47
- ### Commands
1877
+ Delete a widget
48
1878
 
49
- Common options:
50
- - `-X` - CSV output
51
- - `-J` - JSON output
52
- -
1879
+ ```
1880
+ USAGE
1881
+ $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1882
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
53
1883
 
1884
+ FLAGS
1885
+ -i, --id=<value>
1886
+ -n, --name=<the_short_name> name
1887
+ -x, --dxid=<value> dxid
1888
+ --env=<value> [default: default] allow to switch between configurations (server or users)
54
1889
 
55
- `setup` - creates .env file with configuration variables
1890
+ OUTPUT FLAGS
1891
+ --csv Format output as csv
1892
+ --human Format output to be read on screen by a human [default]
1893
+ --json Format output as json
1894
+ --markdown Format output as markdown table
1895
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
56
1896
 
57
- `token` - show authorization header used
1897
+ DESCRIPTION
1898
+ Delete a widget
1899
+ ```
58
1900
 
59
- `campaigns` - list campaigns
1901
+ ## `proca widget get`
60
1902
 
61
- `campaign -c id` - gets info about campaign
1903
+ view a widget
62
1904
 
63
- `pages` - lists action pages
1905
+ ```
1906
+ USAGE
1907
+ $ proca widget get [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1908
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--config]
64
1909
 
65
- `page -c id` - gets info about action page
1910
+ FLAGS
1911
+ -i, --id=<value>
1912
+ -n, --name=<the_short_name> name
1913
+ -x, --dxid=<value> dxid
1914
+ --[no-]config display the config
1915
+ --env=<value> [default: default] allow to switch between configurations (server or users)
66
1916
 
67
- `page:set -c id` - sets info in action page
1917
+ OUTPUT FLAGS
1918
+ --csv Format output as csv
1919
+ --human Format output to be read on screen by a human [default]
1920
+ --json Format output as json
1921
+ --markdown Format output as markdown table
1922
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
68
1923
 
1924
+ DESCRIPTION
1925
+ view a widget
1926
+ ```
69
1927
 
1928
+ ## `proca widget list`
70
1929
 
71
- `export` - exports actions.
72
- - `-i campaignId` - just export for this campaign
73
- - `-b number` - batch size
74
- - `-s start` - start from id
75
- - `-t stop` - stop at id
76
- - `-a date_time` - actions created after (greater-equal) date_time (json format)
77
- - `-e date_time` - actions created before (less-then) date_time
1930
+ list all the widgets of an org or campaign
78
1931
 
1932
+ ```
1933
+ USAGE
1934
+ $ proca widget list [--json | --human | --csv | --markdown] [--env <value>]
1935
+ [--simplify] [-o <organisation name>] [-c <campaign name>] [--config]
79
1936
 
1937
+ FLAGS
1938
+ -c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
1939
+ -o, --org=<organisation name> widgets of the organisation (coordinator or partner)
1940
+ --[no-]config get the config
1941
+ --env=<value> [default: default] allow to switch between configurations (server or users)
80
1942
 
1943
+ OUTPUT FLAGS
1944
+ --csv Format output as csv
1945
+ --human Format output to be read on screen by a human [default]
1946
+ --json Format output as json
1947
+ --markdown Format output as markdown table
1948
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
81
1949
 
82
- ## Library usage
1950
+ DESCRIPTION
1951
+ list all the widgets of an org or campaign
83
1952
 
84
- You can use this package as library, with:
1953
+ EXAMPLES
1954
+ $ proca widget list -o <organisation>
85
1955
  ```
86
- import {api, crypto} from 'proca_cli'
1956
+
1957
+ ## `proca widget rebuild`
1958
+
1959
+ (re)build a widget
1960
+
87
1961
  ```
1962
+ USAGE
1963
+ $ proca widget rebuild [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1964
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
1965
+
1966
+ FLAGS
1967
+ -i, --id=<value>
1968
+ -n, --name=<the_short_name> name
1969
+ -x, --dxid=<value> dxid
1970
+ --env=<value> [default: default] allow to switch between configurations (server or users)
1971
+
1972
+ OUTPUT FLAGS
1973
+ --csv Format output as csv
1974
+ --human Format output to be read on screen by a human [default]
1975
+ --json Format output as json
1976
+ --markdown Format output as markdown table
1977
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
1978
+
1979
+ DESCRIPTION
1980
+ (re)build a widget
1981
+
1982
+ EXAMPLES
1983
+ $ proca widget rebuild 42
88
1984
 
89
- First, create a client object:
1985
+ $ proca widget rebuild climate-action/my-org/en
90
1986
 
1987
+ SEE ALSO:
1988
+
1989
+ $ proca campaign widget rebuild Rebuild all the widgets of a campaign
91
1990
  ```
92
- const c = api.client({api: "https://api.proca.foundation", user: 'me@lol.pe', password: 'qwerty1234'})
1991
+
1992
+ ## `proca widget update`
1993
+
1994
+ Update a widget's properties
1995
+
93
1996
  ```
1997
+ USAGE
1998
+ $ proca widget update [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
1999
+ <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-n <widget name>] [-l <locale>] [--color <hex
2000
+ code>] [--confirm-optin] [--confirm-action] [--dry-run]
94
2001
 
95
- Methods accept client as first paramter, and are async:
2002
+ FLAGS
2003
+ -i, --id=<value>
2004
+ -l, --locale=<locale> change the locale
2005
+ -n, --name=<the_short_name> name
2006
+ -n, --rename=<widget name> new name for the widget
2007
+ -x, --dxid=<value> dxid
2008
+ --color=<hex code> update color (not yet implemented)
2009
+ --confirm-action add actionConfirm (check email snack) to consent.email component
2010
+ --confirm-optin add confirmOptIn (check email snack) to consent.email component
2011
+ --dry-run Show changes without updating the widget
2012
+ --env=<value> [default: default] allow to switch between configurations (server or users)
96
2013
 
97
- `api.campaigns(client, org)` - fetch campaign list for client
2014
+ OUTPUT FLAGS
2015
+ --csv Format output as csv
2016
+ --human Format output to be read on screen by a human [default]
2017
+ --json Format output as json
2018
+ --markdown Format output as markdown table
2019
+ --[no-]simplify flatten and filter to output only the most important attributes, mostly relevant for json
98
2020
 
99
- `api.streamSignatures(client, org, campaignId, callback)` - downloads signatures for campaign `campaignId` and call `callback({publicKey: "source-public-key", list: [....]})` with proca server public key, and list of supporter data (contacts encrypted).
2021
+ DESCRIPTION
2022
+ Update a widget's properties
100
2023
 
101
- To decrypt such stream pass `{publicKey, list}` to `crypto.decryptSignatures` method, which will return a list of supporter data with contact decrypted and JSON.parsed.
2024
+ EXAMPLES
2025
+ $ proca widget update 4454 --name new_widget_name
2026
+
2027
+ $ proca widget update 4454 --locale fr
2028
+
2029
+ $ proca widget update 4454 --confirm-optin
2030
+
2031
+ $ proca widget update 4454 --confirm-optin --dry-run
2032
+ ```
2033
+ <!-- commandsstop -->