proca 0.1.3 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +795 -42
- package/package.json +18 -5
- package/src/commands/action/list.mjs +186 -0
- package/src/commands/action/replay.mjs +54 -0
- package/src/commands/campaign/add.mjs +64 -0
- package/src/commands/campaign/delete.mjs +61 -0
- package/src/commands/campaign/get.mjs +6 -20
- package/src/commands/campaign/list.mjs +3 -12
- package/src/commands/config/add.mjs +3 -10
- package/src/commands/config/get.mjs +33 -0
- package/src/commands/config/user.mjs +77 -0
- package/src/commands/org/add.mjs +63 -0
- package/src/commands/org/crm.mjs +88 -0
- package/src/commands/org/get.mjs +7 -8
- package/src/commands/org/join.mjs +77 -0
- package/src/commands/user/get.mjs +91 -0
- package/src/commands/user/leave.mjs +52 -0
- package/src/commands/user/list.mjs +71 -0
- package/src/commands/widget/add.mjs +113 -0
- package/src/commands/widget/get.mjs +59 -0
- package/src/commands/widget/list.mjs +116 -0
- package/src/config.mjs +1 -1
- package/src/hooks/help.mjs +14 -0
- package/src/hooks/init.mjs +12 -0
- package/src/procaCommand.mjs +90 -21
- package/src/queries/widget.mjs +12 -0
- package/src/urql.mjs +12 -1
- package/src/util/flags.mjs +16 -22
- package/src/util/twitter.mjs +23 -0
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.1
|
|
21
|
+
proca/0.4.1 linux-x64 node-v20.12.2
|
|
22
22
|
$ proca --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ proca COMMAND
|
|
@@ -50,33 +50,169 @@ USAGE
|
|
|
50
50
|
|
|
51
51
|
# Commands
|
|
52
52
|
<!-- commands -->
|
|
53
|
+
* [`proca action list [TITLE]`](#proca-action-list-title)
|
|
54
|
+
* [`proca action replay`](#proca-action-replay)
|
|
55
|
+
* [`proca campaign add [TITLE]`](#proca-campaign-add-title)
|
|
56
|
+
* [`proca campaign delete`](#proca-campaign-delete)
|
|
53
57
|
* [`proca campaign get`](#proca-campaign-get)
|
|
54
58
|
* [`proca campaign list [TITLE]`](#proca-campaign-list-title)
|
|
55
59
|
* [`proca config add [ENVIRONMENT]`](#proca-config-add-environment)
|
|
60
|
+
* [`proca config get`](#proca-config-get)
|
|
56
61
|
* [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
|
|
62
|
+
* [`proca config user`](#proca-config-user)
|
|
63
|
+
* [`proca help [COMMAND]`](#proca-help-command)
|
|
64
|
+
* [`proca org add`](#proca-org-add)
|
|
65
|
+
* [`proca org crm`](#proca-org-crm)
|
|
57
66
|
* [`proca org get`](#proca-org-get)
|
|
67
|
+
* [`proca org join`](#proca-org-join)
|
|
68
|
+
* [`proca plugins`](#proca-plugins)
|
|
69
|
+
* [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
|
|
70
|
+
* [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
|
|
71
|
+
* [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
|
|
72
|
+
* [`proca plugins link PATH`](#proca-plugins-link-path)
|
|
73
|
+
* [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
|
|
74
|
+
* [`proca plugins reset`](#proca-plugins-reset)
|
|
75
|
+
* [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
|
|
76
|
+
* [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
|
|
77
|
+
* [`proca plugins update`](#proca-plugins-update)
|
|
78
|
+
* [`proca user get`](#proca-user-get)
|
|
79
|
+
* [`proca user leave`](#proca-user-leave)
|
|
80
|
+
* [`proca user list`](#proca-user-list)
|
|
81
|
+
* [`proca widget add`](#proca-widget-add)
|
|
82
|
+
* [`proca widget get`](#proca-widget-get)
|
|
83
|
+
* [`proca widget list`](#proca-widget-list)
|
|
84
|
+
|
|
85
|
+
## `proca action list [TITLE]`
|
|
58
86
|
|
|
59
|
-
|
|
87
|
+
```
|
|
88
|
+
USAGE
|
|
89
|
+
$ proca action list [TITLE] -o <organisation name> [--csv] [--simplify []] [-i <value>
|
|
90
|
+
| -n <the_short_name> | -x <value>] [-c <campaign title>] [--limit <value>] [--optin] [--testing] [--doi] [--utm]
|
|
60
91
|
|
|
61
|
-
|
|
92
|
+
ARGUMENTS
|
|
93
|
+
TITLE name of the campaign, % for wildchar
|
|
94
|
+
|
|
95
|
+
FLAGS
|
|
96
|
+
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
97
|
+
-i, --id=<value>
|
|
98
|
+
-n, --name=<the_short_name> name
|
|
99
|
+
-o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
|
|
100
|
+
-x, --dxid=<value> dxid
|
|
101
|
+
--doi only export the double optin actions
|
|
102
|
+
--limit=<value> max number of actions
|
|
103
|
+
--optin only export the optin actions
|
|
104
|
+
--testing also export the test actions
|
|
105
|
+
--[no-]utm display the utm tracking parameters
|
|
106
|
+
|
|
107
|
+
OUTPUT FLAGS
|
|
108
|
+
--csv Format output as csv
|
|
109
|
+
--human Format output to be read on screen by a human [default]
|
|
110
|
+
--json Format output as json
|
|
111
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
112
|
+
|
|
113
|
+
EXAMPLES
|
|
114
|
+
$ proca action list %pizza%
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## `proca action replay`
|
|
62
118
|
|
|
63
119
|
```
|
|
64
120
|
USAGE
|
|
65
|
-
$ proca
|
|
66
|
-
|
|
121
|
+
$ proca action replay -o <organisation name> [--csv] [--simplify []] [-i <value> | -n
|
|
122
|
+
<the_short_name> | -x <value>] [-c <campaign title>]
|
|
123
|
+
|
|
124
|
+
FLAGS
|
|
125
|
+
-c, --campaign=<campaign title> name of the campaign, % for wildchar
|
|
126
|
+
-i, --id=<value>
|
|
127
|
+
-n, --name=<the_short_name> name
|
|
128
|
+
-o, --org=<organisation name> (required) campaigns of the organisation (coordinator or partner)
|
|
129
|
+
-x, --dxid=<value> dxid
|
|
130
|
+
|
|
131
|
+
OUTPUT FLAGS
|
|
132
|
+
--csv Format output as csv
|
|
133
|
+
--human Format output to be read on screen by a human [default]
|
|
134
|
+
--json Format output as json
|
|
135
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
136
|
+
|
|
137
|
+
EXAMPLES
|
|
138
|
+
$ proca action replay %pizza%
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## `proca campaign add [TITLE]`
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
USAGE
|
|
145
|
+
$ proca campaign add [TITLE] [--csv] [--simplify []] [-i <value> | -n <campaign name> |
|
|
146
|
+
-x <value>] [-o <org name>]
|
|
147
|
+
|
|
148
|
+
ARGUMENTS
|
|
149
|
+
TITLE title of the campaign
|
|
150
|
+
|
|
151
|
+
FLAGS
|
|
152
|
+
-i, --id=<value>
|
|
153
|
+
-n, --name=<campaign name> name of the campaign
|
|
154
|
+
-o, --org=<org name> name of the coordinator
|
|
155
|
+
-x, --dxid=<value> dxid
|
|
156
|
+
|
|
157
|
+
OUTPUT FLAGS
|
|
158
|
+
--csv Format output as csv
|
|
159
|
+
--human Format output to be read on screen by a human [default]
|
|
160
|
+
--json Format output as json
|
|
161
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
162
|
+
|
|
163
|
+
EXAMPLES
|
|
164
|
+
$ proca campaign add -n <new_campaign> the full name of the campaign
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## `proca campaign delete`
|
|
168
|
+
|
|
169
|
+
delete a campaign
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
USAGE
|
|
173
|
+
$ proca campaign delete [--csv] [--simplify []] [-i <organisation name>] [-x <value>] [-n
|
|
174
|
+
<campaign name>]
|
|
67
175
|
|
|
68
176
|
FLAGS
|
|
69
177
|
-i, --id=<organisation name> id of the campaign
|
|
70
178
|
-n, --name=<campaign name> name of the campaign
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
179
|
+
-x, --dxid=<value> dxid
|
|
180
|
+
|
|
181
|
+
OUTPUT FLAGS
|
|
182
|
+
--csv Format output as csv
|
|
183
|
+
--human Format output to be read on screen by a human [default]
|
|
184
|
+
--json Format output as json
|
|
185
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
186
|
+
|
|
187
|
+
DESCRIPTION
|
|
188
|
+
delete a campaign
|
|
189
|
+
|
|
190
|
+
EXAMPLES
|
|
191
|
+
$ proca campaign delete -i 42
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
## `proca campaign get`
|
|
195
|
+
|
|
196
|
+
view a campaign
|
|
197
|
+
|
|
198
|
+
```
|
|
199
|
+
USAGE
|
|
200
|
+
$ proca campaign get [ID_NAME_DXID] [--csv] [--simplify []] [-i <value> | -n
|
|
201
|
+
<the_short_name> | -x <value>] [--config] [--stats] [--locale <value>]
|
|
202
|
+
|
|
203
|
+
FLAGS
|
|
204
|
+
-i, --id=<value>
|
|
205
|
+
-n, --name=<the_short_name> name
|
|
206
|
+
-x, --dxid=<value> dxid
|
|
207
|
+
--[no-]config display the config
|
|
208
|
+
--locale=<value> display a locale
|
|
209
|
+
--[no-]stats display the stats
|
|
74
210
|
|
|
75
211
|
OUTPUT FLAGS
|
|
76
212
|
--csv Format output as csv
|
|
213
|
+
--human Format output to be read on screen by a human [default]
|
|
77
214
|
--json Format output as json
|
|
78
|
-
--simplify flatten and filter to output only the most important attributes
|
|
79
|
-
--table Format output as table [default]
|
|
215
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
80
216
|
|
|
81
217
|
DESCRIPTION
|
|
82
218
|
view a campaign
|
|
@@ -91,22 +227,25 @@ list all the campaigns
|
|
|
91
227
|
|
|
92
228
|
```
|
|
93
229
|
USAGE
|
|
94
|
-
$ proca campaign list [TITLE] [--
|
|
95
|
-
name>
|
|
230
|
+
$ proca campaign list [TITLE] [--csv] [--simplify []] [-i <value> | -n <the_short_name>
|
|
231
|
+
| -x <value>] [-o <organisation name>] [-t <campaign title>] [--stats]
|
|
96
232
|
|
|
97
233
|
ARGUMENTS
|
|
98
234
|
TITLE name of the campaign, % for wildchar
|
|
99
235
|
|
|
100
236
|
FLAGS
|
|
237
|
+
-i, --id=<value>
|
|
238
|
+
-n, --name=<the_short_name> name
|
|
101
239
|
-o, --org=<organisation name> campaigns of the organisation (coordinator or partner)
|
|
102
240
|
-t, --title=<campaign title> name of the campaign, % for wildchar
|
|
241
|
+
-x, --dxid=<value> dxid
|
|
103
242
|
--[no-]stats display the stats
|
|
104
243
|
|
|
105
244
|
OUTPUT FLAGS
|
|
106
245
|
--csv Format output as csv
|
|
246
|
+
--human Format output to be read on screen by a human [default]
|
|
107
247
|
--json Format output as json
|
|
108
|
-
--simplify flatten and filter to output only the most important attributes
|
|
109
|
-
--table Format output as table [default]
|
|
248
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
110
249
|
|
|
111
250
|
DESCRIPTION
|
|
112
251
|
list all the campaigns
|
|
@@ -121,27 +260,30 @@ create setting to access the server authentication
|
|
|
121
260
|
|
|
122
261
|
```
|
|
123
262
|
USAGE
|
|
124
|
-
$ proca config add [ENVIRONMENT] --token <API-token> [--
|
|
125
|
-
|
|
126
|
-
[--supabase-secrey-key <value>]
|
|
263
|
+
$ proca config add [ENVIRONMENT] --token <API-token> [--csv] [--simplify []] [-i
|
|
264
|
+
<value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
|
|
265
|
+
[--supabase-anon-key <value>] [--supabase-secrey-key <value>]
|
|
127
266
|
|
|
128
267
|
ARGUMENTS
|
|
129
268
|
ENVIRONMENT [default: default] environment
|
|
130
269
|
|
|
131
270
|
FLAGS
|
|
132
|
-
--
|
|
133
|
-
--
|
|
134
|
-
--
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
271
|
+
-i, --id=<value>
|
|
272
|
+
-n, --name=<the_short_name> name
|
|
273
|
+
-x, --dxid=<value> dxid
|
|
274
|
+
--force write over an existing configuration
|
|
275
|
+
--n8n=<n8n api> api access on the n8n server
|
|
276
|
+
--supabase=<url> url of the supabase
|
|
277
|
+
--supabase-anon-key=<value> anonymous key
|
|
278
|
+
--supabase-secrey-key=<value> secret service key
|
|
279
|
+
--token=<API-token> (required) user token on proca server
|
|
280
|
+
--url=<url> [default: https://api.proca.app/api] url of the proca server api
|
|
139
281
|
|
|
140
282
|
OUTPUT FLAGS
|
|
141
283
|
--csv Format output as csv
|
|
284
|
+
--human Format output to be read on screen by a human [default]
|
|
142
285
|
--json Format output as json
|
|
143
|
-
--simplify flatten and filter to output only the most important attributes
|
|
144
|
-
--table Format output as table [default]
|
|
286
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
145
287
|
|
|
146
288
|
DESCRIPTION
|
|
147
289
|
create setting to access the server authentication
|
|
@@ -153,33 +295,60 @@ EXAMPLES
|
|
|
153
295
|
$ proca config add --user=xavier@example.org --token=API-12345789
|
|
154
296
|
```
|
|
155
297
|
|
|
298
|
+
## `proca config get`
|
|
299
|
+
|
|
300
|
+
get the server config
|
|
301
|
+
|
|
302
|
+
```
|
|
303
|
+
USAGE
|
|
304
|
+
$ proca config get [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
|
|
305
|
+
<value>]
|
|
306
|
+
|
|
307
|
+
FLAGS
|
|
308
|
+
-i, --id=<value>
|
|
309
|
+
-n, --name=<the_short_name> name
|
|
310
|
+
-x, --dxid=<value> dxid
|
|
311
|
+
|
|
312
|
+
OUTPUT FLAGS
|
|
313
|
+
--csv Format output as csv
|
|
314
|
+
--human Format output to be read on screen by a human [default]
|
|
315
|
+
--json Format output as json
|
|
316
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
317
|
+
|
|
318
|
+
DESCRIPTION
|
|
319
|
+
get the server config
|
|
320
|
+
```
|
|
321
|
+
|
|
156
322
|
## `proca config setup [ENVIRONMENT]`
|
|
157
323
|
|
|
158
324
|
create setting to access the server authentication
|
|
159
325
|
|
|
160
326
|
```
|
|
161
327
|
USAGE
|
|
162
|
-
$ proca config setup [ENVIRONMENT] --token <API-token> [--
|
|
163
|
-
|
|
164
|
-
[--supabase-secrey-key <value>]
|
|
328
|
+
$ proca config setup [ENVIRONMENT] --token <API-token> [--csv] [--simplify []] [-i
|
|
329
|
+
<value> | -n <the_short_name> | -x <value>] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>]
|
|
330
|
+
[--supabase-anon-key <value>] [--supabase-secrey-key <value>]
|
|
165
331
|
|
|
166
332
|
ARGUMENTS
|
|
167
333
|
ENVIRONMENT [default: default] environment
|
|
168
334
|
|
|
169
335
|
FLAGS
|
|
170
|
-
--
|
|
171
|
-
--
|
|
172
|
-
--
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
336
|
+
-i, --id=<value>
|
|
337
|
+
-n, --name=<the_short_name> name
|
|
338
|
+
-x, --dxid=<value> dxid
|
|
339
|
+
--force write over an existing configuration
|
|
340
|
+
--n8n=<n8n api> api access on the n8n server
|
|
341
|
+
--supabase=<url> url of the supabase
|
|
342
|
+
--supabase-anon-key=<value> anonymous key
|
|
343
|
+
--supabase-secrey-key=<value> secret service key
|
|
344
|
+
--token=<API-token> (required) user token on proca server
|
|
345
|
+
--url=<url> [default: https://api.proca.app/api] url of the proca server api
|
|
177
346
|
|
|
178
347
|
OUTPUT FLAGS
|
|
179
348
|
--csv Format output as csv
|
|
349
|
+
--human Format output to be read on screen by a human [default]
|
|
180
350
|
--json Format output as json
|
|
181
|
-
--simplify flatten and filter to output only the most important attributes
|
|
182
|
-
--table Format output as table [default]
|
|
351
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
183
352
|
|
|
184
353
|
DESCRIPTION
|
|
185
354
|
create setting to access the server authentication
|
|
@@ -191,17 +360,114 @@ EXAMPLES
|
|
|
191
360
|
$ proca config setup --user=xavier@example.org --token=API-12345789
|
|
192
361
|
```
|
|
193
362
|
|
|
363
|
+
## `proca config user`
|
|
364
|
+
|
|
365
|
+
fetch the information about the current user (based on the token)
|
|
366
|
+
|
|
367
|
+
```
|
|
368
|
+
USAGE
|
|
369
|
+
$ proca config user [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
|
|
370
|
+
<value>]
|
|
371
|
+
|
|
372
|
+
FLAGS
|
|
373
|
+
-i, --id=<value>
|
|
374
|
+
-n, --name=<the_short_name> name
|
|
375
|
+
-x, --dxid=<value> dxid
|
|
376
|
+
|
|
377
|
+
OUTPUT FLAGS
|
|
378
|
+
--csv Format output as csv
|
|
379
|
+
--human Format output to be read on screen by a human [default]
|
|
380
|
+
--json Format output as json
|
|
381
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
382
|
+
|
|
383
|
+
DESCRIPTION
|
|
384
|
+
fetch the information about the current user (based on the token)
|
|
385
|
+
|
|
386
|
+
EXAMPLES
|
|
387
|
+
$ proca config user
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
## `proca help [COMMAND]`
|
|
391
|
+
|
|
392
|
+
Display help for proca.
|
|
393
|
+
|
|
394
|
+
```
|
|
395
|
+
USAGE
|
|
396
|
+
$ proca help [COMMAND...] [-n]
|
|
397
|
+
|
|
398
|
+
ARGUMENTS
|
|
399
|
+
COMMAND... Command to show help for.
|
|
400
|
+
|
|
401
|
+
FLAGS
|
|
402
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
403
|
+
|
|
404
|
+
DESCRIPTION
|
|
405
|
+
Display help for proca.
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
|
|
409
|
+
|
|
410
|
+
## `proca org add`
|
|
411
|
+
|
|
412
|
+
```
|
|
413
|
+
USAGE
|
|
414
|
+
$ proca org add [--csv] [--simplify []] [-i <value> | -n <org name> | -x <value>]
|
|
415
|
+
[--twitter <screen name>]
|
|
416
|
+
|
|
417
|
+
FLAGS
|
|
418
|
+
-i, --id=<value>
|
|
419
|
+
-n, --name=<org name> name of the org
|
|
420
|
+
-x, --dxid=<value> dxid
|
|
421
|
+
--twitter=<screen name> twitter account
|
|
422
|
+
|
|
423
|
+
OUTPUT FLAGS
|
|
424
|
+
--csv Format output as csv
|
|
425
|
+
--human Format output to be read on screen by a human [default]
|
|
426
|
+
--json Format output as json
|
|
427
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
428
|
+
|
|
429
|
+
EXAMPLES
|
|
430
|
+
$ proca org add --twitter <twitter of the organisation>
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
## `proca org crm`
|
|
434
|
+
|
|
435
|
+
view a org crm synchroniser
|
|
436
|
+
|
|
437
|
+
```
|
|
438
|
+
USAGE
|
|
439
|
+
$ proca org crm [--csv] [--simplify []] (-i <value> | -n <org name> | -x <value>)
|
|
440
|
+
[--synchronize]
|
|
441
|
+
|
|
442
|
+
FLAGS
|
|
443
|
+
-i, --id=<value>
|
|
444
|
+
-n, --name=<org name> (required) name of the org
|
|
445
|
+
-x, --dxid=<value> dxid
|
|
446
|
+
--[no-]synchronize enable or disable the synchronisation queue
|
|
447
|
+
|
|
448
|
+
OUTPUT FLAGS
|
|
449
|
+
--csv Format output as csv
|
|
450
|
+
--human Format output to be read on screen by a human [default]
|
|
451
|
+
--json Format output as json
|
|
452
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
453
|
+
|
|
454
|
+
DESCRIPTION
|
|
455
|
+
view a org crm synchroniser
|
|
456
|
+
```
|
|
457
|
+
|
|
194
458
|
## `proca org get`
|
|
195
459
|
|
|
196
460
|
view a org
|
|
197
461
|
|
|
198
462
|
```
|
|
199
463
|
USAGE
|
|
200
|
-
$ proca org get [--
|
|
201
|
-
[--keys] [--campaigns] [--widgets] [--users]
|
|
464
|
+
$ proca org get [--csv] [--simplify []] [-i <value> | -n <org name> | -x <value>]
|
|
465
|
+
[--config] [--keys] [--campaigns] [--widgets] [--users]
|
|
202
466
|
|
|
203
467
|
FLAGS
|
|
468
|
+
-i, --id=<value>
|
|
204
469
|
-n, --name=<org name> name of the org
|
|
470
|
+
-x, --dxid=<value> dxid
|
|
205
471
|
--[no-]campaigns
|
|
206
472
|
--[no-]config display the config
|
|
207
473
|
--[no-]keys
|
|
@@ -210,9 +476,9 @@ FLAGS
|
|
|
210
476
|
|
|
211
477
|
OUTPUT FLAGS
|
|
212
478
|
--csv Format output as csv
|
|
479
|
+
--human Format output to be read on screen by a human [default]
|
|
213
480
|
--json Format output as json
|
|
214
|
-
--simplify flatten and filter to output only the most important attributes
|
|
215
|
-
--table Format output as table [default]
|
|
481
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
216
482
|
|
|
217
483
|
DESCRIPTION
|
|
218
484
|
view a org
|
|
@@ -220,4 +486,491 @@ DESCRIPTION
|
|
|
220
486
|
EXAMPLES
|
|
221
487
|
$ proca org get <name of the ngo>
|
|
222
488
|
```
|
|
489
|
+
|
|
490
|
+
## `proca org join`
|
|
491
|
+
|
|
492
|
+
let a user join an organisation with a role
|
|
493
|
+
|
|
494
|
+
```
|
|
495
|
+
USAGE
|
|
496
|
+
$ proca org join -o <org name> [--csv] [--simplify []] [-i <value> | -n
|
|
497
|
+
<the_short_name> | -x <value>] [--user <value>] [--role owner|campaigner|coordinator|translator]
|
|
498
|
+
|
|
499
|
+
FLAGS
|
|
500
|
+
-i, --id=<value>
|
|
501
|
+
-n, --name=<the_short_name> name
|
|
502
|
+
-o, --org=<org name> (required) name of the org
|
|
503
|
+
-x, --dxid=<value> dxid
|
|
504
|
+
--role=<option> [default: campaigner] permission level in that org
|
|
505
|
+
<options: owner|campaigner|coordinator|translator>
|
|
506
|
+
--user=<value> user email
|
|
507
|
+
|
|
508
|
+
OUTPUT FLAGS
|
|
509
|
+
--csv Format output as csv
|
|
510
|
+
--human Format output to be read on screen by a human [default]
|
|
511
|
+
--json Format output as json
|
|
512
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
513
|
+
|
|
514
|
+
DESCRIPTION
|
|
515
|
+
let a user join an organisation with a role
|
|
516
|
+
|
|
517
|
+
EXAMPLES
|
|
518
|
+
$ proca org join
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
## `proca plugins`
|
|
522
|
+
|
|
523
|
+
List installed plugins.
|
|
524
|
+
|
|
525
|
+
```
|
|
526
|
+
USAGE
|
|
527
|
+
$ proca plugins [--json] [--core]
|
|
528
|
+
|
|
529
|
+
FLAGS
|
|
530
|
+
--core Show core plugins.
|
|
531
|
+
|
|
532
|
+
GLOBAL FLAGS
|
|
533
|
+
--json Format output as json.
|
|
534
|
+
|
|
535
|
+
DESCRIPTION
|
|
536
|
+
List installed plugins.
|
|
537
|
+
|
|
538
|
+
EXAMPLES
|
|
539
|
+
$ proca plugins
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/index.ts)_
|
|
543
|
+
|
|
544
|
+
## `proca plugins add PLUGIN`
|
|
545
|
+
|
|
546
|
+
Installs a plugin into proca.
|
|
547
|
+
|
|
548
|
+
```
|
|
549
|
+
USAGE
|
|
550
|
+
$ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
551
|
+
|
|
552
|
+
ARGUMENTS
|
|
553
|
+
PLUGIN... Plugin to install.
|
|
554
|
+
|
|
555
|
+
FLAGS
|
|
556
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
557
|
+
-h, --help Show CLI help.
|
|
558
|
+
-s, --silent Silences npm output.
|
|
559
|
+
-v, --verbose Show verbose npm output.
|
|
560
|
+
|
|
561
|
+
GLOBAL FLAGS
|
|
562
|
+
--json Format output as json.
|
|
563
|
+
|
|
564
|
+
DESCRIPTION
|
|
565
|
+
Installs a plugin into proca.
|
|
566
|
+
|
|
567
|
+
Uses npm to install plugins.
|
|
568
|
+
|
|
569
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
570
|
+
|
|
571
|
+
Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
572
|
+
Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
|
|
573
|
+
|
|
574
|
+
ALIASES
|
|
575
|
+
$ proca plugins add
|
|
576
|
+
|
|
577
|
+
EXAMPLES
|
|
578
|
+
Install a plugin from npm registry.
|
|
579
|
+
|
|
580
|
+
$ proca plugins add myplugin
|
|
581
|
+
|
|
582
|
+
Install a plugin from a github url.
|
|
583
|
+
|
|
584
|
+
$ proca plugins add https://github.com/someuser/someplugin
|
|
585
|
+
|
|
586
|
+
Install a plugin from a github slug.
|
|
587
|
+
|
|
588
|
+
$ proca plugins add someuser/someplugin
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
## `proca plugins:inspect PLUGIN...`
|
|
592
|
+
|
|
593
|
+
Displays installation properties of a plugin.
|
|
594
|
+
|
|
595
|
+
```
|
|
596
|
+
USAGE
|
|
597
|
+
$ proca plugins inspect PLUGIN...
|
|
598
|
+
|
|
599
|
+
ARGUMENTS
|
|
600
|
+
PLUGIN... [default: .] Plugin to inspect.
|
|
601
|
+
|
|
602
|
+
FLAGS
|
|
603
|
+
-h, --help Show CLI help.
|
|
604
|
+
-v, --verbose
|
|
605
|
+
|
|
606
|
+
GLOBAL FLAGS
|
|
607
|
+
--json Format output as json.
|
|
608
|
+
|
|
609
|
+
DESCRIPTION
|
|
610
|
+
Displays installation properties of a plugin.
|
|
611
|
+
|
|
612
|
+
EXAMPLES
|
|
613
|
+
$ proca plugins inspect myplugin
|
|
614
|
+
```
|
|
615
|
+
|
|
616
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/inspect.ts)_
|
|
617
|
+
|
|
618
|
+
## `proca plugins install PLUGIN`
|
|
619
|
+
|
|
620
|
+
Installs a plugin into proca.
|
|
621
|
+
|
|
622
|
+
```
|
|
623
|
+
USAGE
|
|
624
|
+
$ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
|
|
625
|
+
|
|
626
|
+
ARGUMENTS
|
|
627
|
+
PLUGIN... Plugin to install.
|
|
628
|
+
|
|
629
|
+
FLAGS
|
|
630
|
+
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
631
|
+
-h, --help Show CLI help.
|
|
632
|
+
-s, --silent Silences npm output.
|
|
633
|
+
-v, --verbose Show verbose npm output.
|
|
634
|
+
|
|
635
|
+
GLOBAL FLAGS
|
|
636
|
+
--json Format output as json.
|
|
637
|
+
|
|
638
|
+
DESCRIPTION
|
|
639
|
+
Installs a plugin into proca.
|
|
640
|
+
|
|
641
|
+
Uses npm to install plugins.
|
|
642
|
+
|
|
643
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
644
|
+
|
|
645
|
+
Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
646
|
+
Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
|
|
647
|
+
|
|
648
|
+
ALIASES
|
|
649
|
+
$ proca plugins add
|
|
650
|
+
|
|
651
|
+
EXAMPLES
|
|
652
|
+
Install a plugin from npm registry.
|
|
653
|
+
|
|
654
|
+
$ proca plugins install myplugin
|
|
655
|
+
|
|
656
|
+
Install a plugin from a github url.
|
|
657
|
+
|
|
658
|
+
$ proca plugins install https://github.com/someuser/someplugin
|
|
659
|
+
|
|
660
|
+
Install a plugin from a github slug.
|
|
661
|
+
|
|
662
|
+
$ proca plugins install someuser/someplugin
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/install.ts)_
|
|
666
|
+
|
|
667
|
+
## `proca plugins link PATH`
|
|
668
|
+
|
|
669
|
+
Links a plugin into the CLI for development.
|
|
670
|
+
|
|
671
|
+
```
|
|
672
|
+
USAGE
|
|
673
|
+
$ proca plugins link PATH [-h] [--install] [-v]
|
|
674
|
+
|
|
675
|
+
ARGUMENTS
|
|
676
|
+
PATH [default: .] path to plugin
|
|
677
|
+
|
|
678
|
+
FLAGS
|
|
679
|
+
-h, --help Show CLI help.
|
|
680
|
+
-v, --verbose
|
|
681
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
682
|
+
|
|
683
|
+
DESCRIPTION
|
|
684
|
+
Links a plugin into the CLI for development.
|
|
685
|
+
|
|
686
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
687
|
+
|
|
688
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
689
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
EXAMPLES
|
|
693
|
+
$ proca plugins link myplugin
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/link.ts)_
|
|
697
|
+
|
|
698
|
+
## `proca plugins remove [PLUGIN]`
|
|
699
|
+
|
|
700
|
+
Removes a plugin from the CLI.
|
|
701
|
+
|
|
702
|
+
```
|
|
703
|
+
USAGE
|
|
704
|
+
$ proca plugins remove [PLUGIN...] [-h] [-v]
|
|
705
|
+
|
|
706
|
+
ARGUMENTS
|
|
707
|
+
PLUGIN... plugin to uninstall
|
|
708
|
+
|
|
709
|
+
FLAGS
|
|
710
|
+
-h, --help Show CLI help.
|
|
711
|
+
-v, --verbose
|
|
712
|
+
|
|
713
|
+
DESCRIPTION
|
|
714
|
+
Removes a plugin from the CLI.
|
|
715
|
+
|
|
716
|
+
ALIASES
|
|
717
|
+
$ proca plugins unlink
|
|
718
|
+
$ proca plugins remove
|
|
719
|
+
|
|
720
|
+
EXAMPLES
|
|
721
|
+
$ proca plugins remove myplugin
|
|
722
|
+
```
|
|
723
|
+
|
|
724
|
+
## `proca plugins reset`
|
|
725
|
+
|
|
726
|
+
Remove all user-installed and linked plugins.
|
|
727
|
+
|
|
728
|
+
```
|
|
729
|
+
USAGE
|
|
730
|
+
$ proca plugins reset [--hard] [--reinstall]
|
|
731
|
+
|
|
732
|
+
FLAGS
|
|
733
|
+
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
734
|
+
--reinstall Reinstall all plugins after uninstalling.
|
|
735
|
+
```
|
|
736
|
+
|
|
737
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/reset.ts)_
|
|
738
|
+
|
|
739
|
+
## `proca plugins uninstall [PLUGIN]`
|
|
740
|
+
|
|
741
|
+
Removes a plugin from the CLI.
|
|
742
|
+
|
|
743
|
+
```
|
|
744
|
+
USAGE
|
|
745
|
+
$ proca plugins uninstall [PLUGIN...] [-h] [-v]
|
|
746
|
+
|
|
747
|
+
ARGUMENTS
|
|
748
|
+
PLUGIN... plugin to uninstall
|
|
749
|
+
|
|
750
|
+
FLAGS
|
|
751
|
+
-h, --help Show CLI help.
|
|
752
|
+
-v, --verbose
|
|
753
|
+
|
|
754
|
+
DESCRIPTION
|
|
755
|
+
Removes a plugin from the CLI.
|
|
756
|
+
|
|
757
|
+
ALIASES
|
|
758
|
+
$ proca plugins unlink
|
|
759
|
+
$ proca plugins remove
|
|
760
|
+
|
|
761
|
+
EXAMPLES
|
|
762
|
+
$ proca plugins uninstall myplugin
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/uninstall.ts)_
|
|
766
|
+
|
|
767
|
+
## `proca plugins unlink [PLUGIN]`
|
|
768
|
+
|
|
769
|
+
Removes a plugin from the CLI.
|
|
770
|
+
|
|
771
|
+
```
|
|
772
|
+
USAGE
|
|
773
|
+
$ proca plugins unlink [PLUGIN...] [-h] [-v]
|
|
774
|
+
|
|
775
|
+
ARGUMENTS
|
|
776
|
+
PLUGIN... plugin to uninstall
|
|
777
|
+
|
|
778
|
+
FLAGS
|
|
779
|
+
-h, --help Show CLI help.
|
|
780
|
+
-v, --verbose
|
|
781
|
+
|
|
782
|
+
DESCRIPTION
|
|
783
|
+
Removes a plugin from the CLI.
|
|
784
|
+
|
|
785
|
+
ALIASES
|
|
786
|
+
$ proca plugins unlink
|
|
787
|
+
$ proca plugins remove
|
|
788
|
+
|
|
789
|
+
EXAMPLES
|
|
790
|
+
$ proca plugins unlink myplugin
|
|
791
|
+
```
|
|
792
|
+
|
|
793
|
+
## `proca plugins update`
|
|
794
|
+
|
|
795
|
+
Update installed plugins.
|
|
796
|
+
|
|
797
|
+
```
|
|
798
|
+
USAGE
|
|
799
|
+
$ proca plugins update [-h] [-v]
|
|
800
|
+
|
|
801
|
+
FLAGS
|
|
802
|
+
-h, --help Show CLI help.
|
|
803
|
+
-v, --verbose
|
|
804
|
+
|
|
805
|
+
DESCRIPTION
|
|
806
|
+
Update installed plugins.
|
|
807
|
+
```
|
|
808
|
+
|
|
809
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/update.ts)_
|
|
810
|
+
|
|
811
|
+
## `proca user get`
|
|
812
|
+
|
|
813
|
+
fetch the information about a user
|
|
814
|
+
|
|
815
|
+
```
|
|
816
|
+
USAGE
|
|
817
|
+
$ proca user get [--csv] [--simplify []] [-i <value>] [-x <value>] [-n
|
|
818
|
+
<the_short_name>] [--email <value>] [-o <org name>]
|
|
819
|
+
|
|
820
|
+
FLAGS
|
|
821
|
+
-i, --id=<value> id of the user
|
|
822
|
+
-n, --name=<the_short_name> name
|
|
823
|
+
-o, --org=<org name> name of the org
|
|
824
|
+
-x, --dxid=<value> dxid
|
|
825
|
+
--email=<value> user email
|
|
826
|
+
|
|
827
|
+
OUTPUT FLAGS
|
|
828
|
+
--csv Format output as csv
|
|
829
|
+
--human Format output to be read on screen by a human [default]
|
|
830
|
+
--json Format output as json
|
|
831
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
832
|
+
|
|
833
|
+
DESCRIPTION
|
|
834
|
+
fetch the information about a user
|
|
835
|
+
|
|
836
|
+
EXAMPLES
|
|
837
|
+
$ proca user get
|
|
838
|
+
```
|
|
839
|
+
|
|
840
|
+
## `proca user leave`
|
|
841
|
+
|
|
842
|
+
leave a org
|
|
843
|
+
|
|
844
|
+
```
|
|
845
|
+
USAGE
|
|
846
|
+
$ proca user leave --email <user email> -o <org name> [--csv] [--simplify []] [-i
|
|
847
|
+
<value> | -n <the_short_name> | -x <value>]
|
|
848
|
+
|
|
849
|
+
FLAGS
|
|
850
|
+
-i, --id=<value>
|
|
851
|
+
-n, --name=<the_short_name> name
|
|
852
|
+
-o, --org=<org name> (required) name of the org
|
|
853
|
+
-x, --dxid=<value> dxid
|
|
854
|
+
--email=<user email> (required) email
|
|
855
|
+
|
|
856
|
+
OUTPUT FLAGS
|
|
857
|
+
--csv Format output as csv
|
|
858
|
+
--human Format output to be read on screen by a human [default]
|
|
859
|
+
--json Format output as json
|
|
860
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
861
|
+
|
|
862
|
+
DESCRIPTION
|
|
863
|
+
leave a org
|
|
864
|
+
|
|
865
|
+
EXAMPLES
|
|
866
|
+
$ proca user leave -i 42
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
## `proca user list`
|
|
870
|
+
|
|
871
|
+
list all the users
|
|
872
|
+
|
|
873
|
+
```
|
|
874
|
+
USAGE
|
|
875
|
+
$ proca user list -o <value> [--csv] [--simplify []] [-i <value> | -n
|
|
876
|
+
<the_short_name> | -x <value>]
|
|
877
|
+
|
|
878
|
+
FLAGS
|
|
879
|
+
-i, --id=<value>
|
|
880
|
+
-n, --name=<the_short_name> name
|
|
881
|
+
-o, --org=<value> (required) organisation
|
|
882
|
+
-x, --dxid=<value> dxid
|
|
883
|
+
|
|
884
|
+
OUTPUT FLAGS
|
|
885
|
+
--csv Format output as csv
|
|
886
|
+
--human Format output to be read on screen by a human [default]
|
|
887
|
+
--json Format output as json
|
|
888
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
889
|
+
|
|
890
|
+
DESCRIPTION
|
|
891
|
+
list all the users
|
|
892
|
+
|
|
893
|
+
EXAMPLES
|
|
894
|
+
$ proca user list %pizza%
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
## `proca widget add`
|
|
898
|
+
|
|
899
|
+
```
|
|
900
|
+
USAGE
|
|
901
|
+
$ proca widget add -c <campaign name> [--csv] [--simplify []] [-i <value> | -n by
|
|
902
|
+
default <campaign>/<org>/<lang> | -x <value>] [-o <en>] [-l <en>]
|
|
903
|
+
|
|
904
|
+
FLAGS
|
|
905
|
+
-c, --campaign=<campaign name> (required) name of the campaign
|
|
906
|
+
-i, --id=<value>
|
|
907
|
+
-l, --lang=<en> [default: en] language
|
|
908
|
+
-n, --name=by default <campaign>/<org>/<lang> url slug
|
|
909
|
+
-o, --org=<en> organisation
|
|
910
|
+
-x, --dxid=<value> dxid
|
|
911
|
+
|
|
912
|
+
OUTPUT FLAGS
|
|
913
|
+
--csv Format output as csv
|
|
914
|
+
--human Format output to be read on screen by a human [default]
|
|
915
|
+
--json Format output as json
|
|
916
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
917
|
+
```
|
|
918
|
+
|
|
919
|
+
## `proca widget get`
|
|
920
|
+
|
|
921
|
+
view a widget
|
|
922
|
+
|
|
923
|
+
```
|
|
924
|
+
USAGE
|
|
925
|
+
$ proca widget get [ID_NAME_DXID] [--csv] [--simplify []] [-i <value> | -n
|
|
926
|
+
<the_short_name> | -x <value>] [--config]
|
|
927
|
+
|
|
928
|
+
FLAGS
|
|
929
|
+
-i, --id=<value>
|
|
930
|
+
-n, --name=<the_short_name> name
|
|
931
|
+
-x, --dxid=<value> dxid
|
|
932
|
+
--[no-]config display the config
|
|
933
|
+
|
|
934
|
+
OUTPUT FLAGS
|
|
935
|
+
--csv Format output as csv
|
|
936
|
+
--human Format output to be read on screen by a human [default]
|
|
937
|
+
--json Format output as json
|
|
938
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
939
|
+
|
|
940
|
+
DESCRIPTION
|
|
941
|
+
view a widget
|
|
942
|
+
|
|
943
|
+
EXAMPLES
|
|
944
|
+
$ proca widget get <path of the widget>
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
## `proca widget list`
|
|
948
|
+
|
|
949
|
+
list all the widgets of an org or campaign
|
|
950
|
+
|
|
951
|
+
```
|
|
952
|
+
USAGE
|
|
953
|
+
$ proca widget list [--csv] [--simplify []] [-i <value> | -n <the_short_name> | -x
|
|
954
|
+
<value>] [-o <organisation name>] [-c <campaign name>] [--config]
|
|
955
|
+
|
|
956
|
+
FLAGS
|
|
957
|
+
-c, --campaign=<campaign name> widgets of the campaign (coordinator or partner)
|
|
958
|
+
-i, --id=<value>
|
|
959
|
+
-n, --name=<the_short_name> name
|
|
960
|
+
-o, --org=<organisation name> widgets of the organisation (coordinator or partner)
|
|
961
|
+
-x, --dxid=<value> dxid
|
|
962
|
+
--[no-]config get the config
|
|
963
|
+
|
|
964
|
+
OUTPUT FLAGS
|
|
965
|
+
--csv Format output as csv
|
|
966
|
+
--human Format output to be read on screen by a human [default]
|
|
967
|
+
--json Format output as json
|
|
968
|
+
--simplify flatten and filter to output only the most important attributes, mostly relevant for json
|
|
969
|
+
|
|
970
|
+
DESCRIPTION
|
|
971
|
+
list all the widgets of an org or campaign
|
|
972
|
+
|
|
973
|
+
EXAMPLES
|
|
974
|
+
$ proca widget list -o <organisation>
|
|
975
|
+
```
|
|
223
976
|
<!-- commandsstop -->
|