proca 0.2.0 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +337 -97
- package/package.json +5 -7
- package/src/commands/action/count.mjs +61 -0
- package/src/commands/action/replay.mjs +54 -0
- package/src/commands/campaign/add.mjs +64 -0
- package/src/commands/campaign/get.mjs +2 -16
- package/src/commands/org/add.mjs +0 -1
- package/src/commands/org/crm.mjs +88 -0
- package/src/commands/org/get.mjs +1 -0
- package/src/commands/org/join.mjs +28 -1
- package/src/commands/supporter/count.mjs +96 -0
- package/src/commands/widget/add.mjs +113 -0
- package/src/commands/widget/get.mjs +59 -0
- package/src/hooks/help.mjs +6 -2
- package/src/hooks/init.mjs +4 -2
- package/src/procaCommand.mjs +82 -11
- package/src/util/flags.mjs +16 -22
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g proca
|
|
|
18
18
|
$ proca COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ proca (--version)
|
|
21
|
-
proca/0.2
|
|
21
|
+
proca/0.4.2 linux-x64 node-v20.12.2
|
|
22
22
|
$ proca --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ proca COMMAND
|
|
@@ -50,7 +50,10 @@ USAGE
|
|
|
50
50
|
|
|
51
51
|
# Commands
|
|
52
52
|
<!-- commands -->
|
|
53
|
+
* [`proca action count`](#proca-action-count)
|
|
53
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)
|
|
54
57
|
* [`proca campaign delete`](#proca-campaign-delete)
|
|
55
58
|
* [`proca campaign get`](#proca-campaign-get)
|
|
56
59
|
* [`proca campaign list [TITLE]`](#proca-campaign-list-title)
|
|
@@ -60,6 +63,7 @@ USAGE
|
|
|
60
63
|
* [`proca config user`](#proca-config-user)
|
|
61
64
|
* [`proca help [COMMAND]`](#proca-help-command)
|
|
62
65
|
* [`proca org add`](#proca-org-add)
|
|
66
|
+
* [`proca org crm`](#proca-org-crm)
|
|
63
67
|
* [`proca org get`](#proca-org-get)
|
|
64
68
|
* [`proca org join`](#proca-org-join)
|
|
65
69
|
* [`proca plugins`](#proca-plugins)
|
|
@@ -72,24 +76,60 @@ USAGE
|
|
|
72
76
|
* [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
|
|
73
77
|
* [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
|
|
74
78
|
* [`proca plugins update`](#proca-plugins-update)
|
|
79
|
+
* [`proca supporter count`](#proca-supporter-count)
|
|
75
80
|
* [`proca user get`](#proca-user-get)
|
|
76
81
|
* [`proca user leave`](#proca-user-leave)
|
|
77
82
|
* [`proca user list`](#proca-user-list)
|
|
83
|
+
* [`proca widget add`](#proca-widget-add)
|
|
84
|
+
* [`proca widget get`](#proca-widget-get)
|
|
78
85
|
* [`proca widget list`](#proca-widget-list)
|
|
79
86
|
|
|
87
|
+
## `proca action count`
|
|
88
|
+
|
|
89
|
+
counter of actions
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
USAGE
|
|
93
|
+
$ proca action count [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
|
|
94
|
+
| -n <the_short_name> | -x <value>]
|
|
95
|
+
|
|
96
|
+
FLAGS
|
|
97
|
+
-i, --id=<value>
|
|
98
|
+
-n, --name=<the_short_name> name
|
|
99
|
+
-x, --dxid=<value> dxid
|
|
100
|
+
|
|
101
|
+
OUTPUT FLAGS
|
|
102
|
+
--csv Format output as csv
|
|
103
|
+
--human Format output to be read on screen by a human [default]
|
|
104
|
+
--json Format output as json
|
|
105
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
106
|
+
|
|
107
|
+
DESCRIPTION
|
|
108
|
+
counter of actions
|
|
109
|
+
|
|
110
|
+
EXAMPLES
|
|
111
|
+
$ proca action count --id <id of the campaign>
|
|
112
|
+
|
|
113
|
+
$ proca action count --name <name of the campaign>
|
|
114
|
+
```
|
|
115
|
+
|
|
80
116
|
## `proca action list [TITLE]`
|
|
81
117
|
|
|
82
118
|
```
|
|
83
119
|
USAGE
|
|
84
|
-
$ proca action list [TITLE] -o <organisation name> [--simplify [--json | --
|
|
85
|
-
--
|
|
120
|
+
$ proca action list [TITLE] -o <organisation name> [--simplify [--json | --human |
|
|
121
|
+
--csv]] [-i <value> | -n <the_short_name> | -x <value>] [-c <campaign title>] [--limit <value>] [--optin]
|
|
122
|
+
[--testing] [--doi] [--utm]
|
|
86
123
|
|
|
87
124
|
ARGUMENTS
|
|
88
125
|
TITLE name of the campaign, % for wildchar
|
|
89
126
|
|
|
90
127
|
FLAGS
|
|
91
128
|
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
129
|
+
-i, --id=<value>
|
|
130
|
+
-n, --name=<the_short_name> name
|
|
92
131
|
-o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
|
|
132
|
+
-x, --dxid=<value> dxid
|
|
93
133
|
--doi only export the double optin actions
|
|
94
134
|
--limit=<value> max number of actions
|
|
95
135
|
--optin only export the optin actions
|
|
@@ -98,32 +138,83 @@ FLAGS
|
|
|
98
138
|
|
|
99
139
|
OUTPUT FLAGS
|
|
100
140
|
--csv Format output as csv
|
|
141
|
+
--human Format output to be read on screen by a human [default]
|
|
101
142
|
--json Format output as json
|
|
102
|
-
--simplify flatten and filter to output only the most important attributes
|
|
103
|
-
--table Format output as table [default]
|
|
143
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
104
144
|
|
|
105
145
|
EXAMPLES
|
|
106
146
|
$ proca action list %pizza%
|
|
107
147
|
```
|
|
108
148
|
|
|
149
|
+
## `proca action replay`
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
USAGE
|
|
153
|
+
$ proca action replay -o <organisation name> [--simplify [--json | --human | --csv]] [-i
|
|
154
|
+
<value> | -n <the_short_name> | -x <value>] [-c <campaign title>]
|
|
155
|
+
|
|
156
|
+
FLAGS
|
|
157
|
+
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
158
|
+
-i, --id=<value>
|
|
159
|
+
-n, --name=<the_short_name> name
|
|
160
|
+
-o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
|
|
161
|
+
-x, --dxid=<value> dxid
|
|
162
|
+
|
|
163
|
+
OUTPUT FLAGS
|
|
164
|
+
--csv Format output as csv
|
|
165
|
+
--human Format output to be read on screen by a human [default]
|
|
166
|
+
--json Format output as json
|
|
167
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
168
|
+
|
|
169
|
+
EXAMPLES
|
|
170
|
+
$ proca action replay %pizza%
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## `proca campaign add [TITLE]`
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
USAGE
|
|
177
|
+
$ proca campaign add [TITLE] [--simplify [--json | --human | --csv]] [-i <value> | -n
|
|
178
|
+
<campaign name> | -x <value>] [-o <org name>]
|
|
179
|
+
|
|
180
|
+
ARGUMENTS
|
|
181
|
+
TITLE title of the campaign
|
|
182
|
+
|
|
183
|
+
FLAGS
|
|
184
|
+
-i, --id=<value>
|
|
185
|
+
-n, --name=<campaign name> name of the campaign
|
|
186
|
+
-o, --org=<org name> name of the coordinator
|
|
187
|
+
-x, --dxid=<value> dxid
|
|
188
|
+
|
|
189
|
+
OUTPUT FLAGS
|
|
190
|
+
--csv Format output as csv
|
|
191
|
+
--human Format output to be read on screen by a human [default]
|
|
192
|
+
--json Format output as json
|
|
193
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
194
|
+
|
|
195
|
+
EXAMPLES
|
|
196
|
+
$ proca campaign add -n <new_campaign> the full name of the campaign
|
|
197
|
+
```
|
|
198
|
+
|
|
109
199
|
## `proca campaign delete`
|
|
110
200
|
|
|
111
201
|
delete a campaign
|
|
112
202
|
|
|
113
203
|
```
|
|
114
204
|
USAGE
|
|
115
|
-
$ proca campaign delete [--simplify [--json | --
|
|
116
|
-
[-n <campaign name>]
|
|
205
|
+
$ proca campaign delete [--simplify [--json | --human | --csv]] [-i <organisation name>]
|
|
206
|
+
[-x <value>] [-n <campaign name>]
|
|
117
207
|
|
|
118
208
|
FLAGS
|
|
119
209
|
-i, --id=<organisation name> id of the campaign
|
|
120
210
|
-n, --name=<campaign name> name of the campaign
|
|
211
|
+
-x, --dxid=<value> dxid
|
|
121
212
|
|
|
122
213
|
OUTPUT FLAGS
|
|
123
214
|
--csv Format output as csv
|
|
215
|
+
--human Format output to be read on screen by a human [default]
|
|
124
216
|
--json Format output as json
|
|
125
|
-
--simplify flatten and filter to output only the most important attributes
|
|
126
|
-
--table Format output as table [default]
|
|
217
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
127
218
|
|
|
128
219
|
DESCRIPTION
|
|
129
220
|
delete a campaign
|
|
@@ -138,21 +229,22 @@ view a campaign
|
|
|
138
229
|
|
|
139
230
|
```
|
|
140
231
|
USAGE
|
|
141
|
-
$ proca campaign get [--simplify [--json | --
|
|
142
|
-
|
|
232
|
+
$ proca campaign get [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
|
|
233
|
+
| -n <the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
|
|
143
234
|
|
|
144
235
|
FLAGS
|
|
145
|
-
-i, --id=<
|
|
146
|
-
-n, --name=<
|
|
147
|
-
|
|
148
|
-
--
|
|
149
|
-
--
|
|
236
|
+
-i, --id=<value>
|
|
237
|
+
-n, --name=<the_short_name> name
|
|
238
|
+
-x, --dxid=<value> dxid
|
|
239
|
+
--[no-]config display the config
|
|
240
|
+
--locale=<value> display a locale
|
|
241
|
+
--[no-]stats display the stats
|
|
150
242
|
|
|
151
243
|
OUTPUT FLAGS
|
|
152
244
|
--csv Format output as csv
|
|
245
|
+
--human Format output to be read on screen by a human [default]
|
|
153
246
|
--json Format output as json
|
|
154
|
-
--simplify flatten and filter to output only the most important attributes
|
|
155
|
-
--table Format output as table [default]
|
|
247
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
156
248
|
|
|
157
249
|
DESCRIPTION
|
|
158
250
|
view a campaign
|
|
@@ -167,22 +259,25 @@ list all the campaigns
|
|
|
167
259
|
|
|
168
260
|
```
|
|
169
261
|
USAGE
|
|
170
|
-
$ proca campaign list [TITLE] [--simplify [--json | --
|
|
171
|
-
name>] [-t <campaign title>] [--stats]
|
|
262
|
+
$ proca campaign list [TITLE] [--simplify [--json | --human | --csv]] [-i <value> | -n
|
|
263
|
+
<the_short_name> | -x <value>] [-o <organisation name>] [-t <campaign title>] [--stats]
|
|
172
264
|
|
|
173
265
|
ARGUMENTS
|
|
174
266
|
TITLE name of the campaign, % for wildchar
|
|
175
267
|
|
|
176
268
|
FLAGS
|
|
269
|
+
-i, --id=<value>
|
|
270
|
+
-n, --name=<the_short_name> name
|
|
177
271
|
-o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
|
|
178
272
|
-t, --title=<campaign title> name of the campaign, % for wildchar
|
|
273
|
+
-x, --dxid=<value> dxid
|
|
179
274
|
--[no-]stats display the stats
|
|
180
275
|
|
|
181
276
|
OUTPUT FLAGS
|
|
182
277
|
--csv Format output as csv
|
|
278
|
+
--human Format output to be read on screen by a human [default]
|
|
183
279
|
--json Format output as json
|
|
184
|
-
--simplify flatten and filter to output only the most important attributes
|
|
185
|
-
--table Format output as table [default]
|
|
280
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
186
281
|
|
|
187
282
|
DESCRIPTION
|
|
188
283
|
list all the campaigns
|
|
@@ -197,27 +292,30 @@ create setting to access the server authentication
|
|
|
197
292
|
|
|
198
293
|
```
|
|
199
294
|
USAGE
|
|
200
|
-
$ proca config add [ENVIRONMENT] --token <API-token> [--simplify [--json | --
|
|
201
|
-
--
|
|
202
|
-
[--supabase-secrey-key <value>]
|
|
295
|
+
$ proca config add [ENVIRONMENT] --token <API-token> [--simplify [--json | --human |
|
|
296
|
+
--csv]] [-i <value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
|
|
297
|
+
[--supabase-anon-key <value>] [--supabase-secrey-key <value>]
|
|
203
298
|
|
|
204
299
|
ARGUMENTS
|
|
205
300
|
ENVIRONMENT [default: default] environment
|
|
206
301
|
|
|
207
302
|
FLAGS
|
|
208
|
-
--
|
|
209
|
-
--
|
|
210
|
-
--
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
303
|
+
-i, --id=<value>
|
|
304
|
+
-n, --name=<the_short_name> name
|
|
305
|
+
-x, --dxid=<value> dxid
|
|
306
|
+
--force write over an existing configuration
|
|
307
|
+
--n8n=<n8n api> api access on the n8n server
|
|
308
|
+
--supabase=<url> url of the supabase
|
|
309
|
+
--supabase-anon-key=<value> anonymous key
|
|
310
|
+
--supabase-secrey-key=<value> secret service key
|
|
311
|
+
--token=<API-token> (required) user token on proca server
|
|
312
|
+
--url=<url> [default: https://api.proca.app/api] url of the proca server api
|
|
215
313
|
|
|
216
314
|
OUTPUT FLAGS
|
|
217
315
|
--csv Format output as csv
|
|
316
|
+
--human Format output to be read on screen by a human [default]
|
|
218
317
|
--json Format output as json
|
|
219
|
-
--simplify flatten and filter to output only the most important attributes
|
|
220
|
-
--table Format output as table [default]
|
|
318
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
221
319
|
|
|
222
320
|
DESCRIPTION
|
|
223
321
|
create setting to access the server authentication
|
|
@@ -235,13 +333,19 @@ get the server config
|
|
|
235
333
|
|
|
236
334
|
```
|
|
237
335
|
USAGE
|
|
238
|
-
$ proca config get [--simplify [--json | --
|
|
336
|
+
$ proca config get [--simplify [--json | --human | --csv]] [-i <value> | -n
|
|
337
|
+
<the_short_name> | -x <value>]
|
|
338
|
+
|
|
339
|
+
FLAGS
|
|
340
|
+
-i, --id=<value>
|
|
341
|
+
-n, --name=<the_short_name> name
|
|
342
|
+
-x, --dxid=<value> dxid
|
|
239
343
|
|
|
240
344
|
OUTPUT FLAGS
|
|
241
345
|
--csv Format output as csv
|
|
346
|
+
--human Format output to be read on screen by a human [default]
|
|
242
347
|
--json Format output as json
|
|
243
|
-
--simplify flatten and filter to output only the most important attributes
|
|
244
|
-
--table Format output as table [default]
|
|
348
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
245
349
|
|
|
246
350
|
DESCRIPTION
|
|
247
351
|
get the server config
|
|
@@ -253,27 +357,30 @@ create setting to access the server authentication
|
|
|
253
357
|
|
|
254
358
|
```
|
|
255
359
|
USAGE
|
|
256
|
-
$ proca config setup [ENVIRONMENT] --token <API-token> [--simplify [--json | --
|
|
257
|
-
--
|
|
258
|
-
[--supabase-secrey-key <value>]
|
|
360
|
+
$ proca config setup [ENVIRONMENT] --token <API-token> [--simplify [--json | --human |
|
|
361
|
+
--csv]] [-i <value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
|
|
362
|
+
[--supabase-anon-key <value>] [--supabase-secrey-key <value>]
|
|
259
363
|
|
|
260
364
|
ARGUMENTS
|
|
261
365
|
ENVIRONMENT [default: default] environment
|
|
262
366
|
|
|
263
367
|
FLAGS
|
|
264
|
-
--
|
|
265
|
-
--
|
|
266
|
-
--
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
368
|
+
-i, --id=<value>
|
|
369
|
+
-n, --name=<the_short_name> name
|
|
370
|
+
-x, --dxid=<value> dxid
|
|
371
|
+
--force write over an existing configuration
|
|
372
|
+
--n8n=<n8n api> api access on the n8n server
|
|
373
|
+
--supabase=<url> url of the supabase
|
|
374
|
+
--supabase-anon-key=<value> anonymous key
|
|
375
|
+
--supabase-secrey-key=<value> secret service key
|
|
376
|
+
--token=<API-token> (required) user token on proca server
|
|
377
|
+
--url=<url> [default: https://api.proca.app/api] url of the proca server api
|
|
271
378
|
|
|
272
379
|
OUTPUT FLAGS
|
|
273
380
|
--csv Format output as csv
|
|
381
|
+
--human Format output to be read on screen by a human [default]
|
|
274
382
|
--json Format output as json
|
|
275
|
-
--simplify flatten and filter to output only the most important attributes
|
|
276
|
-
--table Format output as table [default]
|
|
383
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
277
384
|
|
|
278
385
|
DESCRIPTION
|
|
279
386
|
create setting to access the server authentication
|
|
@@ -291,13 +398,19 @@ fetch the information about the current user (based on the token)
|
|
|
291
398
|
|
|
292
399
|
```
|
|
293
400
|
USAGE
|
|
294
|
-
$ proca config user [--simplify [--json | --
|
|
401
|
+
$ proca config user [--simplify [--json | --human | --csv]] [-i <value> | -n
|
|
402
|
+
<the_short_name> | -x <value>]
|
|
403
|
+
|
|
404
|
+
FLAGS
|
|
405
|
+
-i, --id=<value>
|
|
406
|
+
-n, --name=<the_short_name> name
|
|
407
|
+
-x, --dxid=<value> dxid
|
|
295
408
|
|
|
296
409
|
OUTPUT FLAGS
|
|
297
410
|
--csv Format output as csv
|
|
411
|
+
--human Format output to be read on screen by a human [default]
|
|
298
412
|
--json Format output as json
|
|
299
|
-
--simplify flatten and filter to output only the most important attributes
|
|
300
|
-
--table Format output as table [default]
|
|
413
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
301
414
|
|
|
302
415
|
DESCRIPTION
|
|
303
416
|
fetch the information about the current user (based on the token)
|
|
@@ -324,40 +437,69 @@ DESCRIPTION
|
|
|
324
437
|
Display help for proca.
|
|
325
438
|
```
|
|
326
439
|
|
|
327
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
440
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
|
|
328
441
|
|
|
329
442
|
## `proca org add`
|
|
330
443
|
|
|
331
444
|
```
|
|
332
445
|
USAGE
|
|
333
|
-
$ proca org add [--simplify [--json | --
|
|
334
|
-
|
|
446
|
+
$ proca org add [--simplify [--json | --human | --csv]] [-i <value> | -n <org
|
|
447
|
+
name> | -x <value>] [--twitter <screen name>]
|
|
335
448
|
|
|
336
449
|
FLAGS
|
|
450
|
+
-i, --id=<value>
|
|
337
451
|
-n, --name=<org name> name of the org
|
|
452
|
+
-x, --dxid=<value> dxid
|
|
338
453
|
--twitter=<screen name> twitter account
|
|
339
454
|
|
|
340
455
|
OUTPUT FLAGS
|
|
341
456
|
--csv Format output as csv
|
|
457
|
+
--human Format output to be read on screen by a human [default]
|
|
342
458
|
--json Format output as json
|
|
343
|
-
--simplify flatten and filter to output only the most important attributes
|
|
344
|
-
--table Format output as table [default]
|
|
459
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
345
460
|
|
|
346
461
|
EXAMPLES
|
|
347
462
|
$ proca org add --twitter <twitter of the organisation>
|
|
348
463
|
```
|
|
349
464
|
|
|
465
|
+
## `proca org crm`
|
|
466
|
+
|
|
467
|
+
view a org crm synchroniser
|
|
468
|
+
|
|
469
|
+
```
|
|
470
|
+
USAGE
|
|
471
|
+
$ proca org crm [--simplify [--json | --human | --csv]] (-i <value> | -n <org
|
|
472
|
+
name> | -x <value>) [--synchronize]
|
|
473
|
+
|
|
474
|
+
FLAGS
|
|
475
|
+
-i, --id=<value>
|
|
476
|
+
-n, --name=<org name> (required) name of the org
|
|
477
|
+
-x, --dxid=<value> dxid
|
|
478
|
+
--[no-]synchronize enable or disable the synchronisation queue
|
|
479
|
+
|
|
480
|
+
OUTPUT FLAGS
|
|
481
|
+
--csv Format output as csv
|
|
482
|
+
--human Format output to be read on screen by a human [default]
|
|
483
|
+
--json Format output as json
|
|
484
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
485
|
+
|
|
486
|
+
DESCRIPTION
|
|
487
|
+
view a org crm synchroniser
|
|
488
|
+
```
|
|
489
|
+
|
|
350
490
|
## `proca org get`
|
|
351
491
|
|
|
352
492
|
view a org
|
|
353
493
|
|
|
354
494
|
```
|
|
355
495
|
USAGE
|
|
356
|
-
$ proca org get [--simplify [--json | --
|
|
357
|
-
[--keys] [--campaigns] [--widgets] [--users]
|
|
496
|
+
$ proca org get [--simplify [--json | --human | --csv]] [-i <value> | -n <org
|
|
497
|
+
name> | -x <value>] [--config] [--keys] [--campaigns] [--widgets] [--users]
|
|
358
498
|
|
|
359
499
|
FLAGS
|
|
500
|
+
-i, --id=<value>
|
|
360
501
|
-n, --name=<org name> name of the org
|
|
502
|
+
-x, --dxid=<value> dxid
|
|
361
503
|
--[no-]campaigns
|
|
362
504
|
--[no-]config display the config
|
|
363
505
|
--[no-]keys
|
|
@@ -366,9 +508,9 @@ FLAGS
|
|
|
366
508
|
|
|
367
509
|
OUTPUT FLAGS
|
|
368
510
|
--csv Format output as csv
|
|
511
|
+
--human Format output to be read on screen by a human [default]
|
|
369
512
|
--json Format output as json
|
|
370
|
-
--simplify flatten and filter to output only the most important attributes
|
|
371
|
-
--table Format output as table [default]
|
|
513
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
372
514
|
|
|
373
515
|
DESCRIPTION
|
|
374
516
|
view a org
|
|
@@ -383,20 +525,23 @@ let a user join an organisation with a role
|
|
|
383
525
|
|
|
384
526
|
```
|
|
385
527
|
USAGE
|
|
386
|
-
$ proca org join [--simplify [--json | --
|
|
387
|
-
|
|
528
|
+
$ proca org join -o <org name> [--simplify [--json | --human | --csv]] [-i <value>
|
|
529
|
+
| -n <the_short_name> | -x <value>] [--user <value>] [--role owner|campaigner|coordinator|translator]
|
|
388
530
|
|
|
389
531
|
FLAGS
|
|
390
|
-
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
532
|
+
-i, --id=<value>
|
|
533
|
+
-n, --name=<the_short_name> name
|
|
534
|
+
-o, --org=<org name> (required) name of the org
|
|
535
|
+
-x, --dxid=<value> dxid
|
|
536
|
+
--role=<option> [default: campaigner] permission level in that org
|
|
537
|
+
<options: owner|campaigner|coordinator|translator>
|
|
538
|
+
--user=<value> user email
|
|
394
539
|
|
|
395
540
|
OUTPUT FLAGS
|
|
396
541
|
--csv Format output as csv
|
|
542
|
+
--human Format output to be read on screen by a human [default]
|
|
397
543
|
--json Format output as json
|
|
398
|
-
--simplify flatten and filter to output only the most important attributes
|
|
399
|
-
--table Format output as table [default]
|
|
544
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
400
545
|
|
|
401
546
|
DESCRIPTION
|
|
402
547
|
let a user join an organisation with a role
|
|
@@ -426,7 +571,7 @@ EXAMPLES
|
|
|
426
571
|
$ proca plugins
|
|
427
572
|
```
|
|
428
573
|
|
|
429
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
574
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/index.ts)_
|
|
430
575
|
|
|
431
576
|
## `proca plugins add PLUGIN`
|
|
432
577
|
|
|
@@ -500,7 +645,7 @@ EXAMPLES
|
|
|
500
645
|
$ proca plugins inspect myplugin
|
|
501
646
|
```
|
|
502
647
|
|
|
503
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
648
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/inspect.ts)_
|
|
504
649
|
|
|
505
650
|
## `proca plugins install PLUGIN`
|
|
506
651
|
|
|
@@ -549,7 +694,7 @@ EXAMPLES
|
|
|
549
694
|
$ proca plugins install someuser/someplugin
|
|
550
695
|
```
|
|
551
696
|
|
|
552
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
697
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/install.ts)_
|
|
553
698
|
|
|
554
699
|
## `proca plugins link PATH`
|
|
555
700
|
|
|
@@ -580,7 +725,7 @@ EXAMPLES
|
|
|
580
725
|
$ proca plugins link myplugin
|
|
581
726
|
```
|
|
582
727
|
|
|
583
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
728
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/link.ts)_
|
|
584
729
|
|
|
585
730
|
## `proca plugins remove [PLUGIN]`
|
|
586
731
|
|
|
@@ -621,7 +766,7 @@ FLAGS
|
|
|
621
766
|
--reinstall Reinstall all plugins after uninstalling.
|
|
622
767
|
```
|
|
623
768
|
|
|
624
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
769
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/reset.ts)_
|
|
625
770
|
|
|
626
771
|
## `proca plugins uninstall [PLUGIN]`
|
|
627
772
|
|
|
@@ -649,7 +794,7 @@ EXAMPLES
|
|
|
649
794
|
$ proca plugins uninstall myplugin
|
|
650
795
|
```
|
|
651
796
|
|
|
652
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
797
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/uninstall.ts)_
|
|
653
798
|
|
|
654
799
|
## `proca plugins unlink [PLUGIN]`
|
|
655
800
|
|
|
@@ -693,7 +838,40 @@ DESCRIPTION
|
|
|
693
838
|
Update installed plugins.
|
|
694
839
|
```
|
|
695
840
|
|
|
696
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
841
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/update.ts)_
|
|
842
|
+
|
|
843
|
+
## `proca supporter count`
|
|
844
|
+
|
|
845
|
+
counter of supporters
|
|
846
|
+
|
|
847
|
+
```
|
|
848
|
+
USAGE
|
|
849
|
+
$ proca supporter count [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
|
|
850
|
+
| -n <the_short_name> | -x <value>] [--org] [--area] [--number --without <value>]
|
|
851
|
+
|
|
852
|
+
FLAGS
|
|
853
|
+
-i, --id=<value>
|
|
854
|
+
-n, --name=<the_short_name> name
|
|
855
|
+
-x, --dxid=<value> dxid
|
|
856
|
+
--area segment by area
|
|
857
|
+
--number just return the number to add to the partner's counter
|
|
858
|
+
--org segment by partner
|
|
859
|
+
--without=<value> total to add to the partner's counter
|
|
860
|
+
|
|
861
|
+
OUTPUT FLAGS
|
|
862
|
+
--csv Format output as csv
|
|
863
|
+
--human Format output to be read on screen by a human [default]
|
|
864
|
+
--json Format output as json
|
|
865
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
866
|
+
|
|
867
|
+
DESCRIPTION
|
|
868
|
+
counter of supporters
|
|
869
|
+
|
|
870
|
+
EXAMPLES
|
|
871
|
+
$ proca supporter count --id <id of the campaign>
|
|
872
|
+
|
|
873
|
+
$ proca supporter count --name <name of the campaign>
|
|
874
|
+
```
|
|
697
875
|
|
|
698
876
|
## `proca user get`
|
|
699
877
|
|
|
@@ -701,19 +879,21 @@ fetch the information about a user
|
|
|
701
879
|
|
|
702
880
|
```
|
|
703
881
|
USAGE
|
|
704
|
-
$ proca user get [--simplify [--json | --
|
|
705
|
-
|
|
882
|
+
$ proca user get [--simplify [--json | --human | --csv]] [-i <value>] [-x <value>]
|
|
883
|
+
[-n <the_short_name>] [--email <value>] [-o <org name>]
|
|
706
884
|
|
|
707
885
|
FLAGS
|
|
708
|
-
-i, --id=<value>
|
|
709
|
-
-
|
|
710
|
-
|
|
886
|
+
-i, --id=<value> id of the user
|
|
887
|
+
-n, --name=<the_short_name> name
|
|
888
|
+
-o, --org=<org name> name of the org
|
|
889
|
+
-x, --dxid=<value> dxid
|
|
890
|
+
--email=<value> user email
|
|
711
891
|
|
|
712
892
|
OUTPUT FLAGS
|
|
713
893
|
--csv Format output as csv
|
|
894
|
+
--human Format output to be read on screen by a human [default]
|
|
714
895
|
--json Format output as json
|
|
715
|
-
--simplify flatten and filter to output only the most important attributes
|
|
716
|
-
--table Format output as table [default]
|
|
896
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
717
897
|
|
|
718
898
|
DESCRIPTION
|
|
719
899
|
fetch the information about a user
|
|
@@ -728,18 +908,21 @@ leave a org
|
|
|
728
908
|
|
|
729
909
|
```
|
|
730
910
|
USAGE
|
|
731
|
-
$ proca user leave --email <user email> -o <org name> [--simplify [--json | --
|
|
732
|
-
--
|
|
911
|
+
$ proca user leave --email <user email> -o <org name> [--simplify [--json | --human |
|
|
912
|
+
--csv]] [-i <value> | -n <the_short_name> | -x <value>]
|
|
733
913
|
|
|
734
914
|
FLAGS
|
|
735
|
-
-
|
|
736
|
-
|
|
915
|
+
-i, --id=<value>
|
|
916
|
+
-n, --name=<the_short_name> name
|
|
917
|
+
-o, --org=<org name> (required) name of the org
|
|
918
|
+
-x, --dxid=<value> dxid
|
|
919
|
+
--email=<user email> (required) email
|
|
737
920
|
|
|
738
921
|
OUTPUT FLAGS
|
|
739
922
|
--csv Format output as csv
|
|
923
|
+
--human Format output to be read on screen by a human [default]
|
|
740
924
|
--json Format output as json
|
|
741
|
-
--simplify flatten and filter to output only the most important attributes
|
|
742
|
-
--table Format output as table [default]
|
|
925
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
743
926
|
|
|
744
927
|
DESCRIPTION
|
|
745
928
|
leave a org
|
|
@@ -754,16 +937,20 @@ list all the users
|
|
|
754
937
|
|
|
755
938
|
```
|
|
756
939
|
USAGE
|
|
757
|
-
$ proca user list -o <value> [--simplify [--json | --
|
|
940
|
+
$ proca user list -o <value> [--simplify [--json | --human | --csv]] [-i <value> |
|
|
941
|
+
-n <the_short_name> | -x <value>]
|
|
758
942
|
|
|
759
943
|
FLAGS
|
|
760
|
-
-
|
|
944
|
+
-i, --id=<value>
|
|
945
|
+
-n, --name=<the_short_name> name
|
|
946
|
+
-o, --org=<value> (required) organisation
|
|
947
|
+
-x, --dxid=<value> dxid
|
|
761
948
|
|
|
762
949
|
OUTPUT FLAGS
|
|
763
950
|
--csv Format output as csv
|
|
951
|
+
--human Format output to be read on screen by a human [default]
|
|
764
952
|
--json Format output as json
|
|
765
|
-
--simplify flatten and filter to output only the most important attributes
|
|
766
|
-
--table Format output as table [default]
|
|
953
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
767
954
|
|
|
768
955
|
DESCRIPTION
|
|
769
956
|
list all the users
|
|
@@ -772,25 +959,78 @@ EXAMPLES
|
|
|
772
959
|
$ proca user list %pizza%
|
|
773
960
|
```
|
|
774
961
|
|
|
962
|
+
## `proca widget add`
|
|
963
|
+
|
|
964
|
+
```
|
|
965
|
+
USAGE
|
|
966
|
+
$ proca widget add -c <campaign name> [--simplify [--json | --human | --csv]] [-i
|
|
967
|
+
<value> | -n by default <campaign>/<org>/<lang> | -x <value>] [-o <en>] [-l <en>]
|
|
968
|
+
|
|
969
|
+
FLAGS
|
|
970
|
+
-c, --campaign=<campaign name> (required) name of the campaign
|
|
971
|
+
-i, --id=<value>
|
|
972
|
+
-l, --lang=<en> [default: en] language
|
|
973
|
+
-n, --name=by default <campaign>/<org>/<lang> url slug
|
|
974
|
+
-o, --org=<en> organisation
|
|
975
|
+
-x, --dxid=<value> dxid
|
|
976
|
+
|
|
977
|
+
OUTPUT FLAGS
|
|
978
|
+
--csv Format output as csv
|
|
979
|
+
--human Format output to be read on screen by a human [default]
|
|
980
|
+
--json Format output as json
|
|
981
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
982
|
+
```
|
|
983
|
+
|
|
984
|
+
## `proca widget get`
|
|
985
|
+
|
|
986
|
+
view a widget
|
|
987
|
+
|
|
988
|
+
```
|
|
989
|
+
USAGE
|
|
990
|
+
$ proca widget get [ID_NAME_DXID] [--simplify [--json | --human | --csv]] [-i <value>
|
|
991
|
+
| -n <the_short_name> | -x <value>] [--config]
|
|
992
|
+
|
|
993
|
+
FLAGS
|
|
994
|
+
-i, --id=<value>
|
|
995
|
+
-n, --name=<the_short_name> name
|
|
996
|
+
-x, --dxid=<value> dxid
|
|
997
|
+
--[no-]config display the config
|
|
998
|
+
|
|
999
|
+
OUTPUT FLAGS
|
|
1000
|
+
--csv Format output as csv
|
|
1001
|
+
--human Format output to be read on screen by a human [default]
|
|
1002
|
+
--json Format output as json
|
|
1003
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
1004
|
+
|
|
1005
|
+
DESCRIPTION
|
|
1006
|
+
view a widget
|
|
1007
|
+
|
|
1008
|
+
EXAMPLES
|
|
1009
|
+
$ proca widget get <path of the widget>
|
|
1010
|
+
```
|
|
1011
|
+
|
|
775
1012
|
## `proca widget list`
|
|
776
1013
|
|
|
777
1014
|
list all the widgets of an org or campaign
|
|
778
1015
|
|
|
779
1016
|
```
|
|
780
1017
|
USAGE
|
|
781
|
-
$ proca widget list [--simplify [--json | --
|
|
782
|
-
[-c <campaign name>] [--config]
|
|
1018
|
+
$ proca widget list [--simplify [--json | --human | --csv]] [-i <value> | -n
|
|
1019
|
+
<the_short_name> | -x <value>] [-o <organisation name>] [-c <campaign name>] [--config]
|
|
783
1020
|
|
|
784
1021
|
FLAGS
|
|
785
1022
|
-c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
|
|
1023
|
+
-i, --id=<value>
|
|
1024
|
+
-n, --name=<the_short_name> name
|
|
786
1025
|
-o, --org=<organisation name> widgets of the organisation (coordinator or partner)
|
|
1026
|
+
-x, --dxid=<value> dxid
|
|
787
1027
|
--[no-]config get the config
|
|
788
1028
|
|
|
789
1029
|
OUTPUT FLAGS
|
|
790
1030
|
--csv Format output as csv
|
|
1031
|
+
--human Format output to be read on screen by a human [default]
|
|
791
1032
|
--json Format output as json
|
|
792
|
-
--simplify flatten and filter to output only the most important attributes
|
|
793
|
-
--table Format output as table [default]
|
|
1033
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
794
1034
|
|
|
795
1035
|
DESCRIPTION
|
|
796
1036
|
list all the widgets of an org or campaign
|