@knocklabs/cli 0.1.0 → 0.1.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.
- package/README.md +136 -59
- package/dist/commands/commit/index.js +6 -3
- package/dist/commands/commit/promote.js +5 -2
- package/dist/commands/knock.js +102 -0
- package/dist/commands/ping.js +0 -4
- package/dist/commands/translation/get.js +13 -9
- package/dist/commands/translation/list.js +7 -3
- package/dist/commands/translation/pull.js +18 -9
- package/dist/commands/translation/push.js +10 -6
- package/dist/commands/translation/validate.js +11 -7
- package/dist/commands/whoami.js +3 -0
- package/dist/commands/workflow/activate.js +19 -8
- package/dist/commands/workflow/get.js +14 -10
- package/dist/commands/workflow/list.js +7 -3
- package/dist/commands/workflow/new.js +4 -5
- package/dist/commands/workflow/pull.js +17 -9
- package/dist/commands/workflow/push.js +9 -6
- package/dist/commands/workflow/run.js +58 -0
- package/dist/commands/workflow/validate.js +9 -6
- package/dist/lib/api-v1.js +12 -0
- package/dist/lib/base-command.js +8 -4
- package/dist/lib/helpers/flag.js +12 -1
- package/dist/lib/helpers/page.js +7 -2
- package/dist/lib/helpers/request.js +1 -1
- package/dist/lib/helpers/ux.js +2 -2
- package/dist/lib/marshal/translation/helpers.js +11 -5
- package/dist/lib/marshal/translation/reader.js +1 -1
- package/dist/lib/marshal/workflow/helpers.js +5 -5
- package/dist/lib/marshal/workflow/reader.js +1 -1
- package/dist/lib/run-context/helpers.js +2 -2
- package/oclif.manifest.json +170 -25
- package/package.json +22 -16
package/oclif.manifest.json
CHANGED
|
@@ -1,23 +1,45 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.1.
|
|
2
|
+
"version": "0.1.3",
|
|
3
3
|
"commands": {
|
|
4
|
+
"knock": {
|
|
5
|
+
"id": "knock",
|
|
6
|
+
"strict": true,
|
|
7
|
+
"pluginName": "@knocklabs/cli",
|
|
8
|
+
"pluginAlias": "@knocklabs/cli",
|
|
9
|
+
"pluginType": "core",
|
|
10
|
+
"hidden": true,
|
|
11
|
+
"aliases": [],
|
|
12
|
+
"flags": {
|
|
13
|
+
"service-token": {
|
|
14
|
+
"name": "service-token",
|
|
15
|
+
"type": "option",
|
|
16
|
+
"summary": "The service token to authenticate with.",
|
|
17
|
+
"required": true,
|
|
18
|
+
"multiple": false
|
|
19
|
+
},
|
|
20
|
+
"api-origin": {
|
|
21
|
+
"name": "api-origin",
|
|
22
|
+
"type": "option",
|
|
23
|
+
"hidden": true,
|
|
24
|
+
"required": false,
|
|
25
|
+
"multiple": false
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"args": {}
|
|
29
|
+
},
|
|
4
30
|
"ping": {
|
|
5
31
|
"id": "ping",
|
|
6
|
-
"description": "Ping the Knock management API to verify access.",
|
|
7
32
|
"strict": true,
|
|
8
33
|
"pluginName": "@knocklabs/cli",
|
|
9
34
|
"pluginAlias": "@knocklabs/cli",
|
|
10
35
|
"pluginType": "core",
|
|
11
36
|
"hidden": true,
|
|
12
37
|
"aliases": [],
|
|
13
|
-
"examples": [
|
|
14
|
-
"<%= config.bin %> <%= command.id %>"
|
|
15
|
-
],
|
|
16
38
|
"flags": {
|
|
17
39
|
"service-token": {
|
|
18
40
|
"name": "service-token",
|
|
19
41
|
"type": "option",
|
|
20
|
-
"summary": "The service token to authenticate with",
|
|
42
|
+
"summary": "The service token to authenticate with.",
|
|
21
43
|
"required": true,
|
|
22
44
|
"multiple": false
|
|
23
45
|
},
|
|
@@ -33,6 +55,7 @@
|
|
|
33
55
|
},
|
|
34
56
|
"whoami": {
|
|
35
57
|
"id": "whoami",
|
|
58
|
+
"summary": "Verify the provided service token.",
|
|
36
59
|
"strict": true,
|
|
37
60
|
"pluginName": "@knocklabs/cli",
|
|
38
61
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -42,7 +65,7 @@
|
|
|
42
65
|
"service-token": {
|
|
43
66
|
"name": "service-token",
|
|
44
67
|
"type": "option",
|
|
45
|
-
"summary": "The service token to authenticate with",
|
|
68
|
+
"summary": "The service token to authenticate with.",
|
|
46
69
|
"required": true,
|
|
47
70
|
"multiple": false
|
|
48
71
|
},
|
|
@@ -65,6 +88,7 @@
|
|
|
65
88
|
},
|
|
66
89
|
"commit": {
|
|
67
90
|
"id": "commit",
|
|
91
|
+
"summary": "Commit all changes in development environment.",
|
|
68
92
|
"strict": true,
|
|
69
93
|
"pluginName": "@knocklabs/cli",
|
|
70
94
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -74,7 +98,7 @@
|
|
|
74
98
|
"service-token": {
|
|
75
99
|
"name": "service-token",
|
|
76
100
|
"type": "option",
|
|
77
|
-
"summary": "The service token to authenticate with",
|
|
101
|
+
"summary": "The service token to authenticate with.",
|
|
78
102
|
"required": true,
|
|
79
103
|
"multiple": false
|
|
80
104
|
},
|
|
@@ -88,7 +112,7 @@
|
|
|
88
112
|
"environment": {
|
|
89
113
|
"name": "environment",
|
|
90
114
|
"type": "option",
|
|
91
|
-
"summary": "Committing changes applies to the development environment only, use `commit promote` to promote changes to a
|
|
115
|
+
"summary": "Committing changes applies to the development environment only, use `commit promote` to promote changes to a subsequent environment.",
|
|
92
116
|
"multiple": false,
|
|
93
117
|
"options": [
|
|
94
118
|
"development"
|
|
@@ -99,12 +123,13 @@
|
|
|
99
123
|
"name": "commit-message",
|
|
100
124
|
"type": "option",
|
|
101
125
|
"char": "m",
|
|
102
|
-
"summary": "Use the given value as the commit message",
|
|
126
|
+
"summary": "Use the given value as the commit message.",
|
|
103
127
|
"multiple": false
|
|
104
128
|
},
|
|
105
129
|
"force": {
|
|
106
130
|
"name": "force",
|
|
107
131
|
"type": "boolean",
|
|
132
|
+
"summary": "Remove the confirmation prompt.",
|
|
108
133
|
"allowNo": false
|
|
109
134
|
}
|
|
110
135
|
},
|
|
@@ -112,6 +137,7 @@
|
|
|
112
137
|
},
|
|
113
138
|
"commit:promote": {
|
|
114
139
|
"id": "commit:promote",
|
|
140
|
+
"summary": "Promote all changes to the destination environment.",
|
|
115
141
|
"strict": true,
|
|
116
142
|
"pluginName": "@knocklabs/cli",
|
|
117
143
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -121,7 +147,7 @@
|
|
|
121
147
|
"service-token": {
|
|
122
148
|
"name": "service-token",
|
|
123
149
|
"type": "option",
|
|
124
|
-
"summary": "The service token to authenticate with",
|
|
150
|
+
"summary": "The service token to authenticate with.",
|
|
125
151
|
"required": true,
|
|
126
152
|
"multiple": false
|
|
127
153
|
},
|
|
@@ -135,13 +161,14 @@
|
|
|
135
161
|
"to": {
|
|
136
162
|
"name": "to",
|
|
137
163
|
"type": "option",
|
|
138
|
-
"summary": "The destination environment to promote changes from the preceding environment",
|
|
164
|
+
"summary": "The destination environment to promote changes from the preceding environment.",
|
|
139
165
|
"required": true,
|
|
140
166
|
"multiple": false
|
|
141
167
|
},
|
|
142
168
|
"force": {
|
|
143
169
|
"name": "force",
|
|
144
170
|
"type": "boolean",
|
|
171
|
+
"summary": "Remove the confirmation prompt.",
|
|
145
172
|
"allowNo": false
|
|
146
173
|
}
|
|
147
174
|
},
|
|
@@ -149,6 +176,7 @@
|
|
|
149
176
|
},
|
|
150
177
|
"translation:get": {
|
|
151
178
|
"id": "translation:get",
|
|
179
|
+
"summary": "Display a single translation from an environment.",
|
|
152
180
|
"strict": true,
|
|
153
181
|
"pluginName": "@knocklabs/cli",
|
|
154
182
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -158,7 +186,7 @@
|
|
|
158
186
|
"service-token": {
|
|
159
187
|
"name": "service-token",
|
|
160
188
|
"type": "option",
|
|
161
|
-
"summary": "The service token to authenticate with",
|
|
189
|
+
"summary": "The service token to authenticate with.",
|
|
162
190
|
"required": true,
|
|
163
191
|
"multiple": false
|
|
164
192
|
},
|
|
@@ -172,12 +200,14 @@
|
|
|
172
200
|
"environment": {
|
|
173
201
|
"name": "environment",
|
|
174
202
|
"type": "option",
|
|
203
|
+
"summary": "The environment to use.",
|
|
175
204
|
"multiple": false,
|
|
176
205
|
"default": "development"
|
|
177
206
|
},
|
|
178
207
|
"hide-uncommitted-changes": {
|
|
179
208
|
"name": "hide-uncommitted-changes",
|
|
180
209
|
"type": "boolean",
|
|
210
|
+
"summary": "Hide any uncommitted changes.",
|
|
181
211
|
"allowNo": false
|
|
182
212
|
},
|
|
183
213
|
"json": {
|
|
@@ -191,12 +221,14 @@
|
|
|
191
221
|
"args": {
|
|
192
222
|
"translationRef": {
|
|
193
223
|
"name": "translationRef",
|
|
224
|
+
"description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
|
|
194
225
|
"required": true
|
|
195
226
|
}
|
|
196
227
|
}
|
|
197
228
|
},
|
|
198
229
|
"translation:list": {
|
|
199
230
|
"id": "translation:list",
|
|
231
|
+
"summary": "Display all translations for an environment.",
|
|
200
232
|
"strict": true,
|
|
201
233
|
"pluginName": "@knocklabs/cli",
|
|
202
234
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -206,7 +238,7 @@
|
|
|
206
238
|
"service-token": {
|
|
207
239
|
"name": "service-token",
|
|
208
240
|
"type": "option",
|
|
209
|
-
"summary": "The service token to authenticate with",
|
|
241
|
+
"summary": "The service token to authenticate with.",
|
|
210
242
|
"required": true,
|
|
211
243
|
"multiple": false
|
|
212
244
|
},
|
|
@@ -220,27 +252,32 @@
|
|
|
220
252
|
"environment": {
|
|
221
253
|
"name": "environment",
|
|
222
254
|
"type": "option",
|
|
255
|
+
"summary": "The environment to use.",
|
|
223
256
|
"multiple": false,
|
|
224
257
|
"default": "development"
|
|
225
258
|
},
|
|
226
259
|
"hide-uncommitted-changes": {
|
|
227
260
|
"name": "hide-uncommitted-changes",
|
|
228
261
|
"type": "boolean",
|
|
262
|
+
"summary": "Hide any uncommitted changes.",
|
|
229
263
|
"allowNo": false
|
|
230
264
|
},
|
|
231
265
|
"after": {
|
|
232
266
|
"name": "after",
|
|
233
267
|
"type": "option",
|
|
268
|
+
"summary": "The cursor after which to fetch the next page.",
|
|
234
269
|
"multiple": false
|
|
235
270
|
},
|
|
236
271
|
"before": {
|
|
237
272
|
"name": "before",
|
|
238
273
|
"type": "option",
|
|
274
|
+
"summary": "The cursor before which to fetch the previous page.",
|
|
239
275
|
"multiple": false
|
|
240
276
|
},
|
|
241
277
|
"limit": {
|
|
242
278
|
"name": "limit",
|
|
243
279
|
"type": "option",
|
|
280
|
+
"summary": "The total number of entries to fetch per page.",
|
|
244
281
|
"multiple": false
|
|
245
282
|
},
|
|
246
283
|
"json": {
|
|
@@ -255,6 +292,7 @@
|
|
|
255
292
|
},
|
|
256
293
|
"translation:pull": {
|
|
257
294
|
"id": "translation:pull",
|
|
295
|
+
"summary": "Pull one or more translations from an environment into a local file system.",
|
|
258
296
|
"strict": true,
|
|
259
297
|
"pluginName": "@knocklabs/cli",
|
|
260
298
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -264,7 +302,7 @@
|
|
|
264
302
|
"service-token": {
|
|
265
303
|
"name": "service-token",
|
|
266
304
|
"type": "option",
|
|
267
|
-
"summary": "The service token to authenticate with",
|
|
305
|
+
"summary": "The service token to authenticate with.",
|
|
268
306
|
"required": true,
|
|
269
307
|
"multiple": false
|
|
270
308
|
},
|
|
@@ -278,17 +316,20 @@
|
|
|
278
316
|
"environment": {
|
|
279
317
|
"name": "environment",
|
|
280
318
|
"type": "option",
|
|
319
|
+
"summary": "The environment to use.",
|
|
281
320
|
"multiple": false,
|
|
282
321
|
"default": "development"
|
|
283
322
|
},
|
|
284
323
|
"all": {
|
|
285
324
|
"name": "all",
|
|
286
325
|
"type": "boolean",
|
|
326
|
+
"summary": "Whether to pull all translations from the specified environment.",
|
|
287
327
|
"allowNo": false
|
|
288
328
|
},
|
|
289
329
|
"translations-dir": {
|
|
290
330
|
"name": "translations-dir",
|
|
291
331
|
"type": "option",
|
|
332
|
+
"summary": "The target directory path to pull all translations into.",
|
|
292
333
|
"multiple": false,
|
|
293
334
|
"dependsOn": [
|
|
294
335
|
"all"
|
|
@@ -297,23 +338,27 @@
|
|
|
297
338
|
"hide-uncommitted-changes": {
|
|
298
339
|
"name": "hide-uncommitted-changes",
|
|
299
340
|
"type": "boolean",
|
|
341
|
+
"summary": "Hide any uncommitted changes.",
|
|
300
342
|
"allowNo": false
|
|
301
343
|
},
|
|
302
344
|
"force": {
|
|
303
345
|
"name": "force",
|
|
304
346
|
"type": "boolean",
|
|
347
|
+
"summary": "Remove the confirmation prompt.",
|
|
305
348
|
"allowNo": false
|
|
306
349
|
}
|
|
307
350
|
},
|
|
308
351
|
"args": {
|
|
309
352
|
"translationRef": {
|
|
310
353
|
"name": "translationRef",
|
|
354
|
+
"description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
|
|
311
355
|
"required": false
|
|
312
356
|
}
|
|
313
357
|
}
|
|
314
358
|
},
|
|
315
359
|
"translation:push": {
|
|
316
360
|
"id": "translation:push",
|
|
361
|
+
"summary": "Push one or more translations from a local file system to Knock.",
|
|
317
362
|
"strict": true,
|
|
318
363
|
"pluginName": "@knocklabs/cli",
|
|
319
364
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -323,7 +368,7 @@
|
|
|
323
368
|
"service-token": {
|
|
324
369
|
"name": "service-token",
|
|
325
370
|
"type": "option",
|
|
326
|
-
"summary": "The service token to authenticate with",
|
|
371
|
+
"summary": "The service token to authenticate with.",
|
|
327
372
|
"required": true,
|
|
328
373
|
"multiple": false
|
|
329
374
|
},
|
|
@@ -347,11 +392,13 @@
|
|
|
347
392
|
"all": {
|
|
348
393
|
"name": "all",
|
|
349
394
|
"type": "boolean",
|
|
395
|
+
"summary": "Whether to push all translations from the target directory.",
|
|
350
396
|
"allowNo": false
|
|
351
397
|
},
|
|
352
398
|
"translations-dir": {
|
|
353
399
|
"name": "translations-dir",
|
|
354
400
|
"type": "option",
|
|
401
|
+
"summary": "The target directory path to find all translations to push.",
|
|
355
402
|
"multiple": false,
|
|
356
403
|
"dependsOn": [
|
|
357
404
|
"all"
|
|
@@ -377,12 +424,14 @@
|
|
|
377
424
|
"args": {
|
|
378
425
|
"translationRef": {
|
|
379
426
|
"name": "translationRef",
|
|
427
|
+
"description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
|
|
380
428
|
"required": false
|
|
381
429
|
}
|
|
382
430
|
}
|
|
383
431
|
},
|
|
384
432
|
"translation:validate": {
|
|
385
433
|
"id": "translation:validate",
|
|
434
|
+
"summary": "Validate one or more translations from a local file system.",
|
|
386
435
|
"strict": true,
|
|
387
436
|
"pluginName": "@knocklabs/cli",
|
|
388
437
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -392,7 +441,7 @@
|
|
|
392
441
|
"service-token": {
|
|
393
442
|
"name": "service-token",
|
|
394
443
|
"type": "option",
|
|
395
|
-
"summary": "The service token to authenticate with",
|
|
444
|
+
"summary": "The service token to authenticate with.",
|
|
396
445
|
"required": true,
|
|
397
446
|
"multiple": false
|
|
398
447
|
},
|
|
@@ -406,7 +455,7 @@
|
|
|
406
455
|
"environment": {
|
|
407
456
|
"name": "environment",
|
|
408
457
|
"type": "option",
|
|
409
|
-
"summary": "Validating a
|
|
458
|
+
"summary": "Validating a translation is only done in the development environment",
|
|
410
459
|
"multiple": false,
|
|
411
460
|
"options": [
|
|
412
461
|
"development"
|
|
@@ -416,11 +465,13 @@
|
|
|
416
465
|
"all": {
|
|
417
466
|
"name": "all",
|
|
418
467
|
"type": "boolean",
|
|
468
|
+
"summary": "Whether to validate all translations from the target directory.",
|
|
419
469
|
"allowNo": false
|
|
420
470
|
},
|
|
421
471
|
"translations-dir": {
|
|
422
472
|
"name": "translations-dir",
|
|
423
473
|
"type": "option",
|
|
474
|
+
"summary": "The target directory path to find all translations to validate.",
|
|
424
475
|
"multiple": false,
|
|
425
476
|
"dependsOn": [
|
|
426
477
|
"all"
|
|
@@ -430,12 +481,15 @@
|
|
|
430
481
|
"args": {
|
|
431
482
|
"translationRef": {
|
|
432
483
|
"name": "translationRef",
|
|
484
|
+
"description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
|
|
433
485
|
"required": false
|
|
434
486
|
}
|
|
435
487
|
}
|
|
436
488
|
},
|
|
437
489
|
"workflow:activate": {
|
|
438
490
|
"id": "workflow:activate",
|
|
491
|
+
"summary": "Activate or deactivate a workflow in a given environment.",
|
|
492
|
+
"description": "This immediately enables or disables a workflow in a given environment without\nneeding to go through environment promotion.\n\nBy default, this command activates a given workflow. Pass in the --status flag\nwith `false` in order to deactivate it.",
|
|
439
493
|
"strict": true,
|
|
440
494
|
"pluginName": "@knocklabs/cli",
|
|
441
495
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -445,7 +499,7 @@
|
|
|
445
499
|
"service-token": {
|
|
446
500
|
"name": "service-token",
|
|
447
501
|
"type": "option",
|
|
448
|
-
"summary": "The service token to authenticate with",
|
|
502
|
+
"summary": "The service token to authenticate with.",
|
|
449
503
|
"required": true,
|
|
450
504
|
"multiple": false
|
|
451
505
|
},
|
|
@@ -459,12 +513,14 @@
|
|
|
459
513
|
"environment": {
|
|
460
514
|
"name": "environment",
|
|
461
515
|
"type": "option",
|
|
516
|
+
"summary": "The environment to use.",
|
|
462
517
|
"required": true,
|
|
463
518
|
"multiple": false
|
|
464
519
|
},
|
|
465
520
|
"status": {
|
|
466
521
|
"name": "status",
|
|
467
522
|
"type": "option",
|
|
523
|
+
"summary": "The workflow active status to set.",
|
|
468
524
|
"multiple": false,
|
|
469
525
|
"options": [
|
|
470
526
|
"true",
|
|
@@ -475,6 +531,7 @@
|
|
|
475
531
|
"force": {
|
|
476
532
|
"name": "force",
|
|
477
533
|
"type": "boolean",
|
|
534
|
+
"summary": "Remove the confirmation prompt.",
|
|
478
535
|
"allowNo": false
|
|
479
536
|
}
|
|
480
537
|
},
|
|
@@ -487,6 +544,7 @@
|
|
|
487
544
|
},
|
|
488
545
|
"workflow:get": {
|
|
489
546
|
"id": "workflow:get",
|
|
547
|
+
"summary": "Display a single workflow from an environment.",
|
|
490
548
|
"strict": true,
|
|
491
549
|
"pluginName": "@knocklabs/cli",
|
|
492
550
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -496,7 +554,7 @@
|
|
|
496
554
|
"service-token": {
|
|
497
555
|
"name": "service-token",
|
|
498
556
|
"type": "option",
|
|
499
|
-
"summary": "The service token to authenticate with",
|
|
557
|
+
"summary": "The service token to authenticate with.",
|
|
500
558
|
"required": true,
|
|
501
559
|
"multiple": false
|
|
502
560
|
},
|
|
@@ -510,12 +568,14 @@
|
|
|
510
568
|
"environment": {
|
|
511
569
|
"name": "environment",
|
|
512
570
|
"type": "option",
|
|
571
|
+
"summary": "The environment to use.",
|
|
513
572
|
"multiple": false,
|
|
514
573
|
"default": "development"
|
|
515
574
|
},
|
|
516
575
|
"hide-uncommitted-changes": {
|
|
517
576
|
"name": "hide-uncommitted-changes",
|
|
518
577
|
"type": "boolean",
|
|
578
|
+
"summary": "Hide any uncommitted changes.",
|
|
519
579
|
"allowNo": false
|
|
520
580
|
},
|
|
521
581
|
"json": {
|
|
@@ -535,6 +595,7 @@
|
|
|
535
595
|
},
|
|
536
596
|
"workflow:list": {
|
|
537
597
|
"id": "workflow:list",
|
|
598
|
+
"summary": "Display all workflows for an environment.",
|
|
538
599
|
"strict": true,
|
|
539
600
|
"pluginName": "@knocklabs/cli",
|
|
540
601
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -544,7 +605,7 @@
|
|
|
544
605
|
"service-token": {
|
|
545
606
|
"name": "service-token",
|
|
546
607
|
"type": "option",
|
|
547
|
-
"summary": "The service token to authenticate with",
|
|
608
|
+
"summary": "The service token to authenticate with.",
|
|
548
609
|
"required": true,
|
|
549
610
|
"multiple": false
|
|
550
611
|
},
|
|
@@ -558,27 +619,32 @@
|
|
|
558
619
|
"environment": {
|
|
559
620
|
"name": "environment",
|
|
560
621
|
"type": "option",
|
|
622
|
+
"summary": "The environment to use.",
|
|
561
623
|
"multiple": false,
|
|
562
624
|
"default": "development"
|
|
563
625
|
},
|
|
564
626
|
"hide-uncommitted-changes": {
|
|
565
627
|
"name": "hide-uncommitted-changes",
|
|
566
628
|
"type": "boolean",
|
|
629
|
+
"summary": "Hide any uncommitted changes.",
|
|
567
630
|
"allowNo": false
|
|
568
631
|
},
|
|
569
632
|
"after": {
|
|
570
633
|
"name": "after",
|
|
571
634
|
"type": "option",
|
|
635
|
+
"summary": "The cursor after which to fetch the next page.",
|
|
572
636
|
"multiple": false
|
|
573
637
|
},
|
|
574
638
|
"before": {
|
|
575
639
|
"name": "before",
|
|
576
640
|
"type": "option",
|
|
641
|
+
"summary": "The cursor before which to fetch the previous page.",
|
|
577
642
|
"multiple": false
|
|
578
643
|
},
|
|
579
644
|
"limit": {
|
|
580
645
|
"name": "limit",
|
|
581
646
|
"type": "option",
|
|
647
|
+
"summary": "The total number of entries to fetch per page.",
|
|
582
648
|
"multiple": false
|
|
583
649
|
},
|
|
584
650
|
"json": {
|
|
@@ -603,7 +669,7 @@
|
|
|
603
669
|
"service-token": {
|
|
604
670
|
"name": "service-token",
|
|
605
671
|
"type": "option",
|
|
606
|
-
"summary": "The service token to authenticate with",
|
|
672
|
+
"summary": "The service token to authenticate with.",
|
|
607
673
|
"required": true,
|
|
608
674
|
"multiple": false
|
|
609
675
|
},
|
|
@@ -637,6 +703,7 @@
|
|
|
637
703
|
},
|
|
638
704
|
"workflow:pull": {
|
|
639
705
|
"id": "workflow:pull",
|
|
706
|
+
"summary": "Pull one or more workflows from an environment into a local file system.",
|
|
640
707
|
"strict": true,
|
|
641
708
|
"pluginName": "@knocklabs/cli",
|
|
642
709
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -646,7 +713,7 @@
|
|
|
646
713
|
"service-token": {
|
|
647
714
|
"name": "service-token",
|
|
648
715
|
"type": "option",
|
|
649
|
-
"summary": "The service token to authenticate with",
|
|
716
|
+
"summary": "The service token to authenticate with.",
|
|
650
717
|
"required": true,
|
|
651
718
|
"multiple": false
|
|
652
719
|
},
|
|
@@ -660,17 +727,20 @@
|
|
|
660
727
|
"environment": {
|
|
661
728
|
"name": "environment",
|
|
662
729
|
"type": "option",
|
|
730
|
+
"summary": "The environment to use.",
|
|
663
731
|
"multiple": false,
|
|
664
732
|
"default": "development"
|
|
665
733
|
},
|
|
666
734
|
"all": {
|
|
667
735
|
"name": "all",
|
|
668
736
|
"type": "boolean",
|
|
737
|
+
"summary": "Whether to pull all workflows from the specified environment.",
|
|
669
738
|
"allowNo": false
|
|
670
739
|
},
|
|
671
740
|
"workflows-dir": {
|
|
672
741
|
"name": "workflows-dir",
|
|
673
742
|
"type": "option",
|
|
743
|
+
"summary": "The target directory path to pull all workflows into.",
|
|
674
744
|
"multiple": false,
|
|
675
745
|
"dependsOn": [
|
|
676
746
|
"all"
|
|
@@ -679,11 +749,13 @@
|
|
|
679
749
|
"hide-uncommitted-changes": {
|
|
680
750
|
"name": "hide-uncommitted-changes",
|
|
681
751
|
"type": "boolean",
|
|
752
|
+
"summary": "Hide any uncommitted changes.",
|
|
682
753
|
"allowNo": false
|
|
683
754
|
},
|
|
684
755
|
"force": {
|
|
685
756
|
"name": "force",
|
|
686
757
|
"type": "boolean",
|
|
758
|
+
"summary": "Remove the confirmation prompt.",
|
|
687
759
|
"allowNo": false
|
|
688
760
|
}
|
|
689
761
|
},
|
|
@@ -696,6 +768,7 @@
|
|
|
696
768
|
},
|
|
697
769
|
"workflow:push": {
|
|
698
770
|
"id": "workflow:push",
|
|
771
|
+
"summary": "Push one or more workflows from a local file system to Knock.",
|
|
699
772
|
"strict": true,
|
|
700
773
|
"pluginName": "@knocklabs/cli",
|
|
701
774
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -705,7 +778,7 @@
|
|
|
705
778
|
"service-token": {
|
|
706
779
|
"name": "service-token",
|
|
707
780
|
"type": "option",
|
|
708
|
-
"summary": "The service token to authenticate with",
|
|
781
|
+
"summary": "The service token to authenticate with.",
|
|
709
782
|
"required": true,
|
|
710
783
|
"multiple": false
|
|
711
784
|
},
|
|
@@ -729,11 +802,13 @@
|
|
|
729
802
|
"all": {
|
|
730
803
|
"name": "all",
|
|
731
804
|
"type": "boolean",
|
|
805
|
+
"summary": "Whether to push all workflows from the target directory.",
|
|
732
806
|
"allowNo": false
|
|
733
807
|
},
|
|
734
808
|
"workflows-dir": {
|
|
735
809
|
"name": "workflows-dir",
|
|
736
810
|
"type": "option",
|
|
811
|
+
"summary": "The target directory path to find all workflows to push.",
|
|
737
812
|
"multiple": false,
|
|
738
813
|
"dependsOn": [
|
|
739
814
|
"all"
|
|
@@ -763,8 +838,76 @@
|
|
|
763
838
|
}
|
|
764
839
|
}
|
|
765
840
|
},
|
|
841
|
+
"workflow:run": {
|
|
842
|
+
"id": "workflow:run",
|
|
843
|
+
"summary": "Test run a workflow using the latest version from Knock, or a local workflow directory.",
|
|
844
|
+
"strict": true,
|
|
845
|
+
"pluginName": "@knocklabs/cli",
|
|
846
|
+
"pluginAlias": "@knocklabs/cli",
|
|
847
|
+
"pluginType": "core",
|
|
848
|
+
"aliases": [],
|
|
849
|
+
"flags": {
|
|
850
|
+
"service-token": {
|
|
851
|
+
"name": "service-token",
|
|
852
|
+
"type": "option",
|
|
853
|
+
"summary": "The service token to authenticate with.",
|
|
854
|
+
"required": true,
|
|
855
|
+
"multiple": false
|
|
856
|
+
},
|
|
857
|
+
"api-origin": {
|
|
858
|
+
"name": "api-origin",
|
|
859
|
+
"type": "option",
|
|
860
|
+
"hidden": true,
|
|
861
|
+
"required": false,
|
|
862
|
+
"multiple": false
|
|
863
|
+
},
|
|
864
|
+
"environment": {
|
|
865
|
+
"name": "environment",
|
|
866
|
+
"type": "option",
|
|
867
|
+
"summary": "The environment in which to run the workflow",
|
|
868
|
+
"multiple": false,
|
|
869
|
+
"default": "development"
|
|
870
|
+
},
|
|
871
|
+
"recipients": {
|
|
872
|
+
"name": "recipients",
|
|
873
|
+
"type": "option",
|
|
874
|
+
"summary": "One or more recipient ids for this workflow run, separated by comma.",
|
|
875
|
+
"required": true,
|
|
876
|
+
"multiple": true,
|
|
877
|
+
"aliases": [
|
|
878
|
+
"recipient"
|
|
879
|
+
],
|
|
880
|
+
"delimiter": ","
|
|
881
|
+
},
|
|
882
|
+
"actor": {
|
|
883
|
+
"name": "actor",
|
|
884
|
+
"type": "option",
|
|
885
|
+
"summary": "An actor id for the workflow run.",
|
|
886
|
+
"multiple": false
|
|
887
|
+
},
|
|
888
|
+
"tenant": {
|
|
889
|
+
"name": "tenant",
|
|
890
|
+
"type": "option",
|
|
891
|
+
"summary": "A tenant id for the workflow run.",
|
|
892
|
+
"multiple": false
|
|
893
|
+
},
|
|
894
|
+
"data": {
|
|
895
|
+
"name": "data",
|
|
896
|
+
"type": "option",
|
|
897
|
+
"summary": "A JSON string of the data for this workflow",
|
|
898
|
+
"multiple": false
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
"args": {
|
|
902
|
+
"workflowKey": {
|
|
903
|
+
"name": "workflowKey",
|
|
904
|
+
"required": true
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
},
|
|
766
908
|
"workflow:validate": {
|
|
767
909
|
"id": "workflow:validate",
|
|
910
|
+
"summary": "Validate one or more workflows from a local file system.",
|
|
768
911
|
"strict": true,
|
|
769
912
|
"pluginName": "@knocklabs/cli",
|
|
770
913
|
"pluginAlias": "@knocklabs/cli",
|
|
@@ -774,7 +917,7 @@
|
|
|
774
917
|
"service-token": {
|
|
775
918
|
"name": "service-token",
|
|
776
919
|
"type": "option",
|
|
777
|
-
"summary": "The service token to authenticate with",
|
|
920
|
+
"summary": "The service token to authenticate with.",
|
|
778
921
|
"required": true,
|
|
779
922
|
"multiple": false
|
|
780
923
|
},
|
|
@@ -798,11 +941,13 @@
|
|
|
798
941
|
"all": {
|
|
799
942
|
"name": "all",
|
|
800
943
|
"type": "boolean",
|
|
944
|
+
"summary": "Whether to validate all workflows from the target directory.",
|
|
801
945
|
"allowNo": false
|
|
802
946
|
},
|
|
803
947
|
"workflows-dir": {
|
|
804
948
|
"name": "workflows-dir",
|
|
805
949
|
"type": "option",
|
|
950
|
+
"summary": "The target directory path to find all workflows to validate.",
|
|
806
951
|
"multiple": false,
|
|
807
952
|
"dependsOn": [
|
|
808
953
|
"all"
|