@knocklabs/cli 0.1.10 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +68 -531
  2. package/bin/dev.js +6 -0
  3. package/bin/run.js +7 -0
  4. package/dist/{commands → src/commands}/commit/get.js +24 -9
  5. package/dist/{commands → src/commands}/commit/index.js +23 -8
  6. package/dist/{commands → src/commands}/commit/list.js +29 -14
  7. package/dist/{commands → src/commands}/commit/promote.js +26 -11
  8. package/dist/{commands → src/commands}/knock.js +21 -6
  9. package/dist/{commands → src/commands}/layout/get.js +28 -13
  10. package/dist/{commands → src/commands}/layout/list.js +29 -14
  11. package/dist/{commands → src/commands}/layout/pull.js +47 -30
  12. package/dist/{commands → src/commands}/layout/push.js +38 -21
  13. package/dist/{commands → src/commands}/layout/validate.js +33 -16
  14. package/dist/src/commands/ping.js +37 -0
  15. package/dist/{commands → src/commands}/translation/get.js +33 -16
  16. package/dist/{commands → src/commands}/translation/list.js +34 -17
  17. package/dist/{commands → src/commands}/translation/pull.js +36 -19
  18. package/dist/{commands → src/commands}/translation/push.js +33 -15
  19. package/dist/{commands → src/commands}/translation/validate.js +30 -13
  20. package/dist/{commands → src/commands}/whoami.js +22 -7
  21. package/dist/{commands → src/commands}/workflow/activate.js +27 -12
  22. package/dist/{commands → src/commands}/workflow/get.js +35 -18
  23. package/dist/{commands → src/commands}/workflow/list.js +34 -17
  24. package/dist/{commands → src/commands}/workflow/new.js +37 -20
  25. package/dist/{commands → src/commands}/workflow/pull.js +44 -27
  26. package/dist/{commands → src/commands}/workflow/push.js +34 -17
  27. package/dist/{commands → src/commands}/workflow/run.js +25 -10
  28. package/dist/{commands → src/commands}/workflow/validate.js +30 -13
  29. package/dist/{index.js → src/index.js} +3 -1
  30. package/dist/{isomorphic.js → src/isomorphic.js} +8 -4
  31. package/dist/{lib → src/lib}/api-v1.js +57 -41
  32. package/dist/{lib → src/lib}/base-command.js +38 -15
  33. package/dist/{lib → src/lib}/helpers/const.js +18 -10
  34. package/dist/{lib → src/lib}/helpers/date.js +9 -5
  35. package/dist/{lib → src/lib}/helpers/error.js +42 -8
  36. package/dist/{lib → src/lib}/helpers/flag.js +24 -12
  37. package/dist/{lib → src/lib}/helpers/fs.js +10 -6
  38. package/dist/{lib → src/lib}/helpers/json.js +19 -9
  39. package/dist/{lib → src/lib}/helpers/liquid.js +3 -1
  40. package/dist/{lib → src/lib}/helpers/object.isomorphic.js +35 -7
  41. package/dist/{lib → src/lib}/helpers/page.js +34 -18
  42. package/dist/{lib → src/lib}/helpers/request.js +12 -6
  43. package/dist/{lib → src/lib}/helpers/string.js +8 -4
  44. package/dist/{lib → src/lib}/helpers/ux.js +9 -5
  45. package/dist/{lib → src/lib}/marshal/commit/helpers.js +3 -1
  46. package/dist/src/lib/marshal/commit/index.js +19 -0
  47. package/dist/{lib → src/lib}/marshal/conditions/helpers.js +5 -3
  48. package/dist/src/lib/marshal/conditions/index.js +19 -0
  49. package/dist/{lib → src/lib}/marshal/email-layout/helpers.js +25 -15
  50. package/dist/src/lib/marshal/email-layout/index.js +22 -0
  51. package/dist/{lib → src/lib}/marshal/email-layout/processor.isomorphic.js +17 -11
  52. package/dist/{lib → src/lib}/marshal/email-layout/reader.js +29 -23
  53. package/dist/{lib → src/lib}/marshal/email-layout/writer.js +38 -30
  54. package/dist/src/lib/marshal/index.isomorphic.js +26 -0
  55. package/dist/{lib → src/lib}/marshal/shared/const.isomorphic.js +6 -2
  56. package/dist/{lib → src/lib}/marshal/shared/helpers.js +22 -14
  57. package/dist/{lib → src/lib}/marshal/translation/helpers.js +52 -30
  58. package/dist/src/lib/marshal/translation/index.js +22 -0
  59. package/dist/{lib → src/lib}/marshal/translation/processor.isomorphic.js +9 -3
  60. package/dist/{lib → src/lib}/marshal/translation/reader.js +14 -10
  61. package/dist/{lib → src/lib}/marshal/translation/writer.js +21 -15
  62. package/dist/{lib → src/lib}/marshal/workflow/generator.js +23 -15
  63. package/dist/{lib → src/lib}/marshal/workflow/helpers.js +47 -27
  64. package/dist/src/lib/marshal/workflow/index.js +23 -0
  65. package/dist/{lib → src/lib}/marshal/workflow/processor.isomorphic.js +35 -23
  66. package/dist/{lib → src/lib}/marshal/workflow/reader.js +30 -24
  67. package/dist/{lib → src/lib}/marshal/workflow/types.js +3 -1
  68. package/dist/{lib → src/lib}/marshal/workflow/writer.js +40 -30
  69. package/dist/{lib → src/lib}/run-context/helpers.js +3 -1
  70. package/dist/src/lib/run-context/index.js +26 -0
  71. package/dist/{lib → src/lib}/run-context/loader.js +17 -13
  72. package/dist/{lib → src/lib}/user-config.js +13 -9
  73. package/oclif.manifest.json +2 -1386
  74. package/package.json +16 -16
  75. package/bin/dev +0 -17
  76. package/bin/run +0 -5
  77. package/dist/commands/ping.js +0 -22
  78. package/dist/lib/marshal/commit/index.js +0 -17
  79. package/dist/lib/marshal/conditions/index.js +0 -17
  80. package/dist/lib/marshal/email-layout/index.js +0 -20
  81. package/dist/lib/marshal/index.isomorphic.js +0 -20
  82. package/dist/lib/marshal/translation/index.js +0 -20
  83. package/dist/lib/marshal/workflow/index.js +0 -21
  84. package/dist/lib/run-context/index.js +0 -22
  85. /package/dist/{lib → src/lib}/marshal/commit/types.js +0 -0
  86. /package/dist/{lib → src/lib}/marshal/conditions/types.js +0 -0
  87. /package/dist/{lib → src/lib}/marshal/email-layout/types.js +0 -0
  88. /package/dist/{lib → src/lib}/marshal/shared/types.js +0 -0
  89. /package/dist/{lib → src/lib}/marshal/translation/types.js +0 -0
  90. /package/dist/{lib → src/lib}/run-context/types.js +0 -0
@@ -1,1388 +1,4 @@
1
1
  {
2
- "version": "0.1.10",
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
- },
30
- "ping": {
31
- "id": "ping",
32
- "strict": true,
33
- "pluginName": "@knocklabs/cli",
34
- "pluginAlias": "@knocklabs/cli",
35
- "pluginType": "core",
36
- "hidden": true,
37
- "aliases": [],
38
- "flags": {
39
- "service-token": {
40
- "name": "service-token",
41
- "type": "option",
42
- "summary": "The service token to authenticate with.",
43
- "required": true,
44
- "multiple": false
45
- },
46
- "api-origin": {
47
- "name": "api-origin",
48
- "type": "option",
49
- "hidden": true,
50
- "required": false,
51
- "multiple": false
52
- }
53
- },
54
- "args": {}
55
- },
56
- "whoami": {
57
- "id": "whoami",
58
- "summary": "Verify the provided service token.",
59
- "strict": true,
60
- "pluginName": "@knocklabs/cli",
61
- "pluginAlias": "@knocklabs/cli",
62
- "pluginType": "core",
63
- "aliases": [],
64
- "flags": {
65
- "service-token": {
66
- "name": "service-token",
67
- "type": "option",
68
- "summary": "The service token to authenticate with.",
69
- "required": true,
70
- "multiple": false
71
- },
72
- "api-origin": {
73
- "name": "api-origin",
74
- "type": "option",
75
- "hidden": true,
76
- "required": false,
77
- "multiple": false
78
- },
79
- "json": {
80
- "name": "json",
81
- "type": "boolean",
82
- "description": "Format output as json.",
83
- "helpGroup": "GLOBAL",
84
- "allowNo": false
85
- }
86
- },
87
- "args": {}
88
- },
89
- "commit:get": {
90
- "id": "commit:get",
91
- "summary": "Display a single commit",
92
- "strict": true,
93
- "pluginName": "@knocklabs/cli",
94
- "pluginAlias": "@knocklabs/cli",
95
- "pluginType": "core",
96
- "aliases": [],
97
- "flags": {
98
- "service-token": {
99
- "name": "service-token",
100
- "type": "option",
101
- "summary": "The service token to authenticate with.",
102
- "required": true,
103
- "multiple": false
104
- },
105
- "api-origin": {
106
- "name": "api-origin",
107
- "type": "option",
108
- "hidden": true,
109
- "required": false,
110
- "multiple": false
111
- },
112
- "json": {
113
- "name": "json",
114
- "type": "boolean",
115
- "description": "Format output as json.",
116
- "helpGroup": "GLOBAL",
117
- "allowNo": false
118
- }
119
- },
120
- "args": {
121
- "id": {
122
- "name": "id",
123
- "required": true
124
- }
125
- }
126
- },
127
- "commit": {
128
- "id": "commit",
129
- "summary": "Commit all changes in development environment.",
130
- "strict": true,
131
- "pluginName": "@knocklabs/cli",
132
- "pluginAlias": "@knocklabs/cli",
133
- "pluginType": "core",
134
- "aliases": [],
135
- "flags": {
136
- "service-token": {
137
- "name": "service-token",
138
- "type": "option",
139
- "summary": "The service token to authenticate with.",
140
- "required": true,
141
- "multiple": false
142
- },
143
- "api-origin": {
144
- "name": "api-origin",
145
- "type": "option",
146
- "hidden": true,
147
- "required": false,
148
- "multiple": false
149
- },
150
- "environment": {
151
- "name": "environment",
152
- "type": "option",
153
- "summary": "Committing changes applies to the development environment only, use `commit promote` to promote changes to a subsequent environment.",
154
- "multiple": false,
155
- "options": [
156
- "development"
157
- ],
158
- "default": "development"
159
- },
160
- "commit-message": {
161
- "name": "commit-message",
162
- "type": "option",
163
- "char": "m",
164
- "summary": "Use the given value as the commit message.",
165
- "multiple": false
166
- },
167
- "force": {
168
- "name": "force",
169
- "type": "boolean",
170
- "summary": "Remove the confirmation prompt.",
171
- "allowNo": false
172
- }
173
- },
174
- "args": {}
175
- },
176
- "commit:list": {
177
- "id": "commit:list",
178
- "summary": "Display all commits in an environment",
179
- "strict": true,
180
- "pluginName": "@knocklabs/cli",
181
- "pluginAlias": "@knocklabs/cli",
182
- "pluginType": "core",
183
- "aliases": [],
184
- "flags": {
185
- "service-token": {
186
- "name": "service-token",
187
- "type": "option",
188
- "summary": "The service token to authenticate with.",
189
- "required": true,
190
- "multiple": false
191
- },
192
- "api-origin": {
193
- "name": "api-origin",
194
- "type": "option",
195
- "hidden": true,
196
- "required": false,
197
- "multiple": false
198
- },
199
- "environment": {
200
- "name": "environment",
201
- "type": "option",
202
- "summary": "The environment to use.",
203
- "multiple": false,
204
- "default": "development"
205
- },
206
- "promoted": {
207
- "name": "promoted",
208
- "type": "boolean",
209
- "summary": "Show only promoted or unpromoted changes between the given environment and the subsequent environment.",
210
- "allowNo": true
211
- },
212
- "after": {
213
- "name": "after",
214
- "type": "option",
215
- "summary": "The cursor after which to fetch the next page.",
216
- "multiple": false
217
- },
218
- "before": {
219
- "name": "before",
220
- "type": "option",
221
- "summary": "The cursor before which to fetch the previous page.",
222
- "multiple": false
223
- },
224
- "limit": {
225
- "name": "limit",
226
- "type": "option",
227
- "summary": "The total number of entries to fetch per page.",
228
- "multiple": false
229
- },
230
- "json": {
231
- "name": "json",
232
- "type": "boolean",
233
- "description": "Format output as json.",
234
- "helpGroup": "GLOBAL",
235
- "allowNo": false
236
- }
237
- },
238
- "args": {}
239
- },
240
- "commit:promote": {
241
- "id": "commit:promote",
242
- "summary": "Promote one or all commits to the subsequent environment.",
243
- "strict": true,
244
- "pluginName": "@knocklabs/cli",
245
- "pluginAlias": "@knocklabs/cli",
246
- "pluginType": "core",
247
- "aliases": [],
248
- "flags": {
249
- "service-token": {
250
- "name": "service-token",
251
- "type": "option",
252
- "summary": "The service token to authenticate with.",
253
- "required": true,
254
- "multiple": false
255
- },
256
- "api-origin": {
257
- "name": "api-origin",
258
- "type": "option",
259
- "hidden": true,
260
- "required": false,
261
- "multiple": false
262
- },
263
- "to": {
264
- "name": "to",
265
- "type": "option",
266
- "summary": "The destination environment to promote all changes from the preceding environment.",
267
- "multiple": false
268
- },
269
- "force": {
270
- "name": "force",
271
- "type": "boolean",
272
- "summary": "Remove the confirmation prompt.",
273
- "allowNo": false
274
- },
275
- "only": {
276
- "name": "only",
277
- "type": "option",
278
- "summary": "The target commit id to promote to the subsequent environment",
279
- "multiple": false
280
- }
281
- },
282
- "args": {}
283
- },
284
- "layout:get": {
285
- "id": "layout:get",
286
- "summary": "Display a single email layout from an environment.",
287
- "strict": true,
288
- "pluginName": "@knocklabs/cli",
289
- "pluginAlias": "@knocklabs/cli",
290
- "pluginType": "core",
291
- "aliases": [],
292
- "flags": {
293
- "service-token": {
294
- "name": "service-token",
295
- "type": "option",
296
- "summary": "The service token to authenticate with.",
297
- "required": true,
298
- "multiple": false
299
- },
300
- "api-origin": {
301
- "name": "api-origin",
302
- "type": "option",
303
- "hidden": true,
304
- "required": false,
305
- "multiple": false
306
- },
307
- "environment": {
308
- "name": "environment",
309
- "type": "option",
310
- "summary": "The environment to use.",
311
- "multiple": false,
312
- "default": "development"
313
- },
314
- "hide-uncommitted-changes": {
315
- "name": "hide-uncommitted-changes",
316
- "type": "boolean",
317
- "summary": "Hide any uncommitted changes.",
318
- "allowNo": false
319
- },
320
- "json": {
321
- "name": "json",
322
- "type": "boolean",
323
- "description": "Format output as json.",
324
- "helpGroup": "GLOBAL",
325
- "allowNo": false
326
- }
327
- },
328
- "args": {
329
- "emailLayoutKey": {
330
- "name": "emailLayoutKey",
331
- "required": true
332
- }
333
- }
334
- },
335
- "layout:list": {
336
- "id": "layout:list",
337
- "summary": "Display all email layouts for an environment.",
338
- "strict": true,
339
- "pluginName": "@knocklabs/cli",
340
- "pluginAlias": "@knocklabs/cli",
341
- "pluginType": "core",
342
- "aliases": [],
343
- "flags": {
344
- "service-token": {
345
- "name": "service-token",
346
- "type": "option",
347
- "summary": "The service token to authenticate with.",
348
- "required": true,
349
- "multiple": false
350
- },
351
- "api-origin": {
352
- "name": "api-origin",
353
- "type": "option",
354
- "hidden": true,
355
- "required": false,
356
- "multiple": false
357
- },
358
- "environment": {
359
- "name": "environment",
360
- "type": "option",
361
- "summary": "The environment to use.",
362
- "multiple": false,
363
- "default": "development"
364
- },
365
- "hide-uncommitted-changes": {
366
- "name": "hide-uncommitted-changes",
367
- "type": "boolean",
368
- "summary": "Hide any uncommitted changes.",
369
- "allowNo": false
370
- },
371
- "after": {
372
- "name": "after",
373
- "type": "option",
374
- "summary": "The cursor after which to fetch the next page.",
375
- "multiple": false
376
- },
377
- "before": {
378
- "name": "before",
379
- "type": "option",
380
- "summary": "The cursor before which to fetch the previous page.",
381
- "multiple": false
382
- },
383
- "limit": {
384
- "name": "limit",
385
- "type": "option",
386
- "summary": "The total number of entries to fetch per page.",
387
- "multiple": false
388
- },
389
- "json": {
390
- "name": "json",
391
- "type": "boolean",
392
- "description": "Format output as json.",
393
- "helpGroup": "GLOBAL",
394
- "allowNo": false
395
- }
396
- },
397
- "args": {}
398
- },
399
- "layout:pull": {
400
- "id": "layout:pull",
401
- "summary": "Pull one or more email layouts from an environment into a local file system.",
402
- "strict": true,
403
- "pluginName": "@knocklabs/cli",
404
- "pluginAlias": "@knocklabs/cli",
405
- "pluginType": "core",
406
- "aliases": [],
407
- "flags": {
408
- "service-token": {
409
- "name": "service-token",
410
- "type": "option",
411
- "summary": "The service token to authenticate with.",
412
- "required": true,
413
- "multiple": false
414
- },
415
- "api-origin": {
416
- "name": "api-origin",
417
- "type": "option",
418
- "hidden": true,
419
- "required": false,
420
- "multiple": false
421
- },
422
- "environment": {
423
- "name": "environment",
424
- "type": "option",
425
- "summary": "The environment to use.",
426
- "multiple": false,
427
- "default": "development"
428
- },
429
- "all": {
430
- "name": "all",
431
- "type": "boolean",
432
- "summary": "Whether to pull all email layouts from the specified environment.",
433
- "allowNo": false
434
- },
435
- "layouts-dir": {
436
- "name": "layouts-dir",
437
- "type": "option",
438
- "summary": "The target directory path to pull all email layouts into.",
439
- "multiple": false,
440
- "dependsOn": [
441
- "all"
442
- ],
443
- "aliases": [
444
- "email-layouts-dir"
445
- ]
446
- },
447
- "hide-uncommitted-changes": {
448
- "name": "hide-uncommitted-changes",
449
- "type": "boolean",
450
- "summary": "Hide any uncommitted changes.",
451
- "allowNo": false
452
- },
453
- "force": {
454
- "name": "force",
455
- "type": "boolean",
456
- "summary": "Remove the confirmation prompt.",
457
- "allowNo": false
458
- }
459
- },
460
- "args": {
461
- "emailLayoutKey": {
462
- "name": "emailLayoutKey",
463
- "required": false
464
- }
465
- }
466
- },
467
- "layout:push": {
468
- "id": "layout:push",
469
- "summary": "Push one or more email layouts from a local file system to Knock.",
470
- "strict": true,
471
- "pluginName": "@knocklabs/cli",
472
- "pluginAlias": "@knocklabs/cli",
473
- "pluginType": "core",
474
- "aliases": [],
475
- "flags": {
476
- "service-token": {
477
- "name": "service-token",
478
- "type": "option",
479
- "summary": "The service token to authenticate with.",
480
- "required": true,
481
- "multiple": false
482
- },
483
- "api-origin": {
484
- "name": "api-origin",
485
- "type": "option",
486
- "hidden": true,
487
- "required": false,
488
- "multiple": false
489
- },
490
- "environment": {
491
- "name": "environment",
492
- "type": "option",
493
- "summary": "Pushing an email layout is only allowed in the development environment",
494
- "multiple": false,
495
- "options": [
496
- "development"
497
- ],
498
- "default": "development"
499
- },
500
- "all": {
501
- "name": "all",
502
- "type": "boolean",
503
- "summary": "Whether to push all layouts from the target directory.",
504
- "allowNo": false
505
- },
506
- "layouts-dir": {
507
- "name": "layouts-dir",
508
- "type": "option",
509
- "summary": "The target directory path to find all layouts to push.",
510
- "multiple": false,
511
- "dependsOn": [
512
- "all"
513
- ],
514
- "aliases": [
515
- "email-layouts-dir"
516
- ]
517
- },
518
- "commit": {
519
- "name": "commit",
520
- "type": "boolean",
521
- "summary": "Push and commit the layout(s) at the same time",
522
- "allowNo": false
523
- },
524
- "commit-message": {
525
- "name": "commit-message",
526
- "type": "option",
527
- "char": "m",
528
- "summary": "Use the given value as the commit message",
529
- "multiple": false,
530
- "dependsOn": [
531
- "commit"
532
- ]
533
- }
534
- },
535
- "args": {
536
- "emailLayoutKey": {
537
- "name": "emailLayoutKey",
538
- "required": false
539
- }
540
- }
541
- },
542
- "layout:validate": {
543
- "id": "layout:validate",
544
- "summary": "Validate one or more layouts from a local file system.",
545
- "strict": true,
546
- "pluginName": "@knocklabs/cli",
547
- "pluginAlias": "@knocklabs/cli",
548
- "pluginType": "core",
549
- "aliases": [],
550
- "flags": {
551
- "service-token": {
552
- "name": "service-token",
553
- "type": "option",
554
- "summary": "The service token to authenticate with.",
555
- "required": true,
556
- "multiple": false
557
- },
558
- "api-origin": {
559
- "name": "api-origin",
560
- "type": "option",
561
- "hidden": true,
562
- "required": false,
563
- "multiple": false
564
- },
565
- "environment": {
566
- "name": "environment",
567
- "type": "option",
568
- "summary": "Validating a layout is only done in the development environment",
569
- "multiple": false,
570
- "options": [
571
- "development"
572
- ],
573
- "default": "development"
574
- },
575
- "all": {
576
- "name": "all",
577
- "type": "boolean",
578
- "summary": "Whether to validate all layouts from the target directory.",
579
- "allowNo": false
580
- },
581
- "layouts-dir": {
582
- "name": "layouts-dir",
583
- "type": "option",
584
- "summary": "The target directory path to find all layouts to validate.",
585
- "multiple": false,
586
- "dependsOn": [
587
- "all"
588
- ],
589
- "aliases": [
590
- "email-layouts-dir"
591
- ]
592
- }
593
- },
594
- "args": {
595
- "emailLayoutKey": {
596
- "name": "emailLayoutKey",
597
- "required": false
598
- }
599
- }
600
- },
601
- "translation:get": {
602
- "id": "translation:get",
603
- "summary": "Display a single translation from an environment.",
604
- "strict": true,
605
- "pluginName": "@knocklabs/cli",
606
- "pluginAlias": "@knocklabs/cli",
607
- "pluginType": "core",
608
- "aliases": [],
609
- "flags": {
610
- "service-token": {
611
- "name": "service-token",
612
- "type": "option",
613
- "summary": "The service token to authenticate with.",
614
- "required": true,
615
- "multiple": false
616
- },
617
- "api-origin": {
618
- "name": "api-origin",
619
- "type": "option",
620
- "hidden": true,
621
- "required": false,
622
- "multiple": false
623
- },
624
- "environment": {
625
- "name": "environment",
626
- "type": "option",
627
- "summary": "The environment to use.",
628
- "multiple": false,
629
- "default": "development"
630
- },
631
- "hide-uncommitted-changes": {
632
- "name": "hide-uncommitted-changes",
633
- "type": "boolean",
634
- "summary": "Hide any uncommitted changes.",
635
- "allowNo": false
636
- },
637
- "json": {
638
- "name": "json",
639
- "type": "boolean",
640
- "description": "Format output as json.",
641
- "helpGroup": "GLOBAL",
642
- "allowNo": false
643
- }
644
- },
645
- "args": {
646
- "translationRef": {
647
- "name": "translationRef",
648
- "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`.",
649
- "required": true
650
- }
651
- }
652
- },
653
- "translation:list": {
654
- "id": "translation:list",
655
- "summary": "Display all translations for an environment.",
656
- "strict": true,
657
- "pluginName": "@knocklabs/cli",
658
- "pluginAlias": "@knocklabs/cli",
659
- "pluginType": "core",
660
- "aliases": [],
661
- "flags": {
662
- "service-token": {
663
- "name": "service-token",
664
- "type": "option",
665
- "summary": "The service token to authenticate with.",
666
- "required": true,
667
- "multiple": false
668
- },
669
- "api-origin": {
670
- "name": "api-origin",
671
- "type": "option",
672
- "hidden": true,
673
- "required": false,
674
- "multiple": false
675
- },
676
- "environment": {
677
- "name": "environment",
678
- "type": "option",
679
- "summary": "The environment to use.",
680
- "multiple": false,
681
- "default": "development"
682
- },
683
- "hide-uncommitted-changes": {
684
- "name": "hide-uncommitted-changes",
685
- "type": "boolean",
686
- "summary": "Hide any uncommitted changes.",
687
- "allowNo": false
688
- },
689
- "after": {
690
- "name": "after",
691
- "type": "option",
692
- "summary": "The cursor after which to fetch the next page.",
693
- "multiple": false
694
- },
695
- "before": {
696
- "name": "before",
697
- "type": "option",
698
- "summary": "The cursor before which to fetch the previous page.",
699
- "multiple": false
700
- },
701
- "limit": {
702
- "name": "limit",
703
- "type": "option",
704
- "summary": "The total number of entries to fetch per page.",
705
- "multiple": false
706
- },
707
- "json": {
708
- "name": "json",
709
- "type": "boolean",
710
- "description": "Format output as json.",
711
- "helpGroup": "GLOBAL",
712
- "allowNo": false
713
- }
714
- },
715
- "args": {}
716
- },
717
- "translation:pull": {
718
- "id": "translation:pull",
719
- "summary": "Pull one or more translations from an environment into a local file system.",
720
- "strict": true,
721
- "pluginName": "@knocklabs/cli",
722
- "pluginAlias": "@knocklabs/cli",
723
- "pluginType": "core",
724
- "aliases": [],
725
- "flags": {
726
- "service-token": {
727
- "name": "service-token",
728
- "type": "option",
729
- "summary": "The service token to authenticate with.",
730
- "required": true,
731
- "multiple": false
732
- },
733
- "api-origin": {
734
- "name": "api-origin",
735
- "type": "option",
736
- "hidden": true,
737
- "required": false,
738
- "multiple": false
739
- },
740
- "environment": {
741
- "name": "environment",
742
- "type": "option",
743
- "summary": "The environment to use.",
744
- "multiple": false,
745
- "default": "development"
746
- },
747
- "all": {
748
- "name": "all",
749
- "type": "boolean",
750
- "summary": "Whether to pull all translations from the specified environment.",
751
- "allowNo": false
752
- },
753
- "translations-dir": {
754
- "name": "translations-dir",
755
- "type": "option",
756
- "summary": "The target directory path to pull all translations into.",
757
- "multiple": false,
758
- "dependsOn": [
759
- "all"
760
- ]
761
- },
762
- "hide-uncommitted-changes": {
763
- "name": "hide-uncommitted-changes",
764
- "type": "boolean",
765
- "summary": "Hide any uncommitted changes.",
766
- "allowNo": false
767
- },
768
- "force": {
769
- "name": "force",
770
- "type": "boolean",
771
- "summary": "Remove the confirmation prompt.",
772
- "allowNo": false
773
- }
774
- },
775
- "args": {
776
- "translationRef": {
777
- "name": "translationRef",
778
- "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`.",
779
- "required": false
780
- }
781
- }
782
- },
783
- "translation:push": {
784
- "id": "translation:push",
785
- "summary": "Push one or more translations from a local file system to Knock.",
786
- "strict": true,
787
- "pluginName": "@knocklabs/cli",
788
- "pluginAlias": "@knocklabs/cli",
789
- "pluginType": "core",
790
- "aliases": [],
791
- "flags": {
792
- "service-token": {
793
- "name": "service-token",
794
- "type": "option",
795
- "summary": "The service token to authenticate with.",
796
- "required": true,
797
- "multiple": false
798
- },
799
- "api-origin": {
800
- "name": "api-origin",
801
- "type": "option",
802
- "hidden": true,
803
- "required": false,
804
- "multiple": false
805
- },
806
- "environment": {
807
- "name": "environment",
808
- "type": "option",
809
- "summary": "Pushing a translation is only allowed in the development environment",
810
- "multiple": false,
811
- "options": [
812
- "development"
813
- ],
814
- "default": "development"
815
- },
816
- "all": {
817
- "name": "all",
818
- "type": "boolean",
819
- "summary": "Whether to push all translations from the target directory.",
820
- "allowNo": false
821
- },
822
- "translations-dir": {
823
- "name": "translations-dir",
824
- "type": "option",
825
- "summary": "The target directory path to find all translations to push.",
826
- "multiple": false,
827
- "dependsOn": [
828
- "all"
829
- ]
830
- },
831
- "commit": {
832
- "name": "commit",
833
- "type": "boolean",
834
- "summary": "Push and commit the translation(s) at the same time",
835
- "allowNo": false
836
- },
837
- "commit-message": {
838
- "name": "commit-message",
839
- "type": "option",
840
- "char": "m",
841
- "summary": "Use the given value as the commit message",
842
- "multiple": false,
843
- "dependsOn": [
844
- "commit"
845
- ]
846
- }
847
- },
848
- "args": {
849
- "translationRef": {
850
- "name": "translationRef",
851
- "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`.",
852
- "required": false
853
- }
854
- }
855
- },
856
- "translation:validate": {
857
- "id": "translation:validate",
858
- "summary": "Validate one or more translations from a local file system.",
859
- "strict": true,
860
- "pluginName": "@knocklabs/cli",
861
- "pluginAlias": "@knocklabs/cli",
862
- "pluginType": "core",
863
- "aliases": [],
864
- "flags": {
865
- "service-token": {
866
- "name": "service-token",
867
- "type": "option",
868
- "summary": "The service token to authenticate with.",
869
- "required": true,
870
- "multiple": false
871
- },
872
- "api-origin": {
873
- "name": "api-origin",
874
- "type": "option",
875
- "hidden": true,
876
- "required": false,
877
- "multiple": false
878
- },
879
- "environment": {
880
- "name": "environment",
881
- "type": "option",
882
- "summary": "Validating a translation is only done in the development environment",
883
- "multiple": false,
884
- "options": [
885
- "development"
886
- ],
887
- "default": "development"
888
- },
889
- "all": {
890
- "name": "all",
891
- "type": "boolean",
892
- "summary": "Whether to validate all translations from the target directory.",
893
- "allowNo": false
894
- },
895
- "translations-dir": {
896
- "name": "translations-dir",
897
- "type": "option",
898
- "summary": "The target directory path to find all translations to validate.",
899
- "multiple": false,
900
- "dependsOn": [
901
- "all"
902
- ]
903
- }
904
- },
905
- "args": {
906
- "translationRef": {
907
- "name": "translationRef",
908
- "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`.",
909
- "required": false
910
- }
911
- }
912
- },
913
- "workflow:activate": {
914
- "id": "workflow:activate",
915
- "summary": "Activate or deactivate a workflow in a given environment.",
916
- "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.",
917
- "strict": true,
918
- "pluginName": "@knocklabs/cli",
919
- "pluginAlias": "@knocklabs/cli",
920
- "pluginType": "core",
921
- "aliases": [],
922
- "flags": {
923
- "service-token": {
924
- "name": "service-token",
925
- "type": "option",
926
- "summary": "The service token to authenticate with.",
927
- "required": true,
928
- "multiple": false
929
- },
930
- "api-origin": {
931
- "name": "api-origin",
932
- "type": "option",
933
- "hidden": true,
934
- "required": false,
935
- "multiple": false
936
- },
937
- "environment": {
938
- "name": "environment",
939
- "type": "option",
940
- "summary": "The environment to use.",
941
- "required": true,
942
- "multiple": false
943
- },
944
- "status": {
945
- "name": "status",
946
- "type": "option",
947
- "summary": "The workflow active status to set.",
948
- "multiple": false,
949
- "options": [
950
- "true",
951
- "false"
952
- ],
953
- "default": true
954
- },
955
- "force": {
956
- "name": "force",
957
- "type": "boolean",
958
- "summary": "Remove the confirmation prompt.",
959
- "allowNo": false
960
- }
961
- },
962
- "args": {
963
- "workflowKey": {
964
- "name": "workflowKey",
965
- "required": true
966
- }
967
- }
968
- },
969
- "workflow:get": {
970
- "id": "workflow:get",
971
- "summary": "Display a single workflow from an environment.",
972
- "strict": true,
973
- "pluginName": "@knocklabs/cli",
974
- "pluginAlias": "@knocklabs/cli",
975
- "pluginType": "core",
976
- "aliases": [],
977
- "flags": {
978
- "service-token": {
979
- "name": "service-token",
980
- "type": "option",
981
- "summary": "The service token to authenticate with.",
982
- "required": true,
983
- "multiple": false
984
- },
985
- "api-origin": {
986
- "name": "api-origin",
987
- "type": "option",
988
- "hidden": true,
989
- "required": false,
990
- "multiple": false
991
- },
992
- "environment": {
993
- "name": "environment",
994
- "type": "option",
995
- "summary": "The environment to use.",
996
- "multiple": false,
997
- "default": "development"
998
- },
999
- "hide-uncommitted-changes": {
1000
- "name": "hide-uncommitted-changes",
1001
- "type": "boolean",
1002
- "summary": "Hide any uncommitted changes.",
1003
- "allowNo": false
1004
- },
1005
- "json": {
1006
- "name": "json",
1007
- "type": "boolean",
1008
- "description": "Format output as json.",
1009
- "helpGroup": "GLOBAL",
1010
- "allowNo": false
1011
- }
1012
- },
1013
- "args": {
1014
- "workflowKey": {
1015
- "name": "workflowKey",
1016
- "required": true
1017
- }
1018
- }
1019
- },
1020
- "workflow:list": {
1021
- "id": "workflow:list",
1022
- "summary": "Display all workflows for an environment.",
1023
- "strict": true,
1024
- "pluginName": "@knocklabs/cli",
1025
- "pluginAlias": "@knocklabs/cli",
1026
- "pluginType": "core",
1027
- "aliases": [],
1028
- "flags": {
1029
- "service-token": {
1030
- "name": "service-token",
1031
- "type": "option",
1032
- "summary": "The service token to authenticate with.",
1033
- "required": true,
1034
- "multiple": false
1035
- },
1036
- "api-origin": {
1037
- "name": "api-origin",
1038
- "type": "option",
1039
- "hidden": true,
1040
- "required": false,
1041
- "multiple": false
1042
- },
1043
- "environment": {
1044
- "name": "environment",
1045
- "type": "option",
1046
- "summary": "The environment to use.",
1047
- "multiple": false,
1048
- "default": "development"
1049
- },
1050
- "hide-uncommitted-changes": {
1051
- "name": "hide-uncommitted-changes",
1052
- "type": "boolean",
1053
- "summary": "Hide any uncommitted changes.",
1054
- "allowNo": false
1055
- },
1056
- "after": {
1057
- "name": "after",
1058
- "type": "option",
1059
- "summary": "The cursor after which to fetch the next page.",
1060
- "multiple": false
1061
- },
1062
- "before": {
1063
- "name": "before",
1064
- "type": "option",
1065
- "summary": "The cursor before which to fetch the previous page.",
1066
- "multiple": false
1067
- },
1068
- "limit": {
1069
- "name": "limit",
1070
- "type": "option",
1071
- "summary": "The total number of entries to fetch per page.",
1072
- "multiple": false
1073
- },
1074
- "json": {
1075
- "name": "json",
1076
- "type": "boolean",
1077
- "description": "Format output as json.",
1078
- "helpGroup": "GLOBAL",
1079
- "allowNo": false
1080
- }
1081
- },
1082
- "args": {}
1083
- },
1084
- "workflow:new": {
1085
- "id": "workflow:new",
1086
- "strict": true,
1087
- "pluginName": "@knocklabs/cli",
1088
- "pluginAlias": "@knocklabs/cli",
1089
- "pluginType": "core",
1090
- "hidden": true,
1091
- "aliases": [],
1092
- "flags": {
1093
- "service-token": {
1094
- "name": "service-token",
1095
- "type": "option",
1096
- "summary": "The service token to authenticate with.",
1097
- "required": true,
1098
- "multiple": false
1099
- },
1100
- "api-origin": {
1101
- "name": "api-origin",
1102
- "type": "option",
1103
- "hidden": true,
1104
- "required": false,
1105
- "multiple": false
1106
- },
1107
- "steps": {
1108
- "name": "steps",
1109
- "type": "option",
1110
- "multiple": false,
1111
- "aliases": [
1112
- "step"
1113
- ]
1114
- },
1115
- "force": {
1116
- "name": "force",
1117
- "type": "boolean",
1118
- "allowNo": false
1119
- }
1120
- },
1121
- "args": {
1122
- "workflowKey": {
1123
- "name": "workflowKey",
1124
- "required": true
1125
- }
1126
- }
1127
- },
1128
- "workflow:pull": {
1129
- "id": "workflow:pull",
1130
- "summary": "Pull one or more workflows from an environment into a local file system.",
1131
- "strict": true,
1132
- "pluginName": "@knocklabs/cli",
1133
- "pluginAlias": "@knocklabs/cli",
1134
- "pluginType": "core",
1135
- "aliases": [],
1136
- "flags": {
1137
- "service-token": {
1138
- "name": "service-token",
1139
- "type": "option",
1140
- "summary": "The service token to authenticate with.",
1141
- "required": true,
1142
- "multiple": false
1143
- },
1144
- "api-origin": {
1145
- "name": "api-origin",
1146
- "type": "option",
1147
- "hidden": true,
1148
- "required": false,
1149
- "multiple": false
1150
- },
1151
- "environment": {
1152
- "name": "environment",
1153
- "type": "option",
1154
- "summary": "The environment to use.",
1155
- "multiple": false,
1156
- "default": "development"
1157
- },
1158
- "all": {
1159
- "name": "all",
1160
- "type": "boolean",
1161
- "summary": "Whether to pull all workflows from the specified environment.",
1162
- "allowNo": false
1163
- },
1164
- "workflows-dir": {
1165
- "name": "workflows-dir",
1166
- "type": "option",
1167
- "summary": "The target directory path to pull all workflows into.",
1168
- "multiple": false,
1169
- "dependsOn": [
1170
- "all"
1171
- ]
1172
- },
1173
- "hide-uncommitted-changes": {
1174
- "name": "hide-uncommitted-changes",
1175
- "type": "boolean",
1176
- "summary": "Hide any uncommitted changes.",
1177
- "allowNo": false
1178
- },
1179
- "force": {
1180
- "name": "force",
1181
- "type": "boolean",
1182
- "summary": "Remove the confirmation prompt.",
1183
- "allowNo": false
1184
- }
1185
- },
1186
- "args": {
1187
- "workflowKey": {
1188
- "name": "workflowKey",
1189
- "required": false
1190
- }
1191
- }
1192
- },
1193
- "workflow:push": {
1194
- "id": "workflow:push",
1195
- "summary": "Push one or more workflows from a local file system to Knock.",
1196
- "strict": true,
1197
- "pluginName": "@knocklabs/cli",
1198
- "pluginAlias": "@knocklabs/cli",
1199
- "pluginType": "core",
1200
- "aliases": [],
1201
- "flags": {
1202
- "service-token": {
1203
- "name": "service-token",
1204
- "type": "option",
1205
- "summary": "The service token to authenticate with.",
1206
- "required": true,
1207
- "multiple": false
1208
- },
1209
- "api-origin": {
1210
- "name": "api-origin",
1211
- "type": "option",
1212
- "hidden": true,
1213
- "required": false,
1214
- "multiple": false
1215
- },
1216
- "environment": {
1217
- "name": "environment",
1218
- "type": "option",
1219
- "summary": "Pushing a workflow is only allowed in the development environment",
1220
- "multiple": false,
1221
- "options": [
1222
- "development"
1223
- ],
1224
- "default": "development"
1225
- },
1226
- "all": {
1227
- "name": "all",
1228
- "type": "boolean",
1229
- "summary": "Whether to push all workflows from the target directory.",
1230
- "allowNo": false
1231
- },
1232
- "workflows-dir": {
1233
- "name": "workflows-dir",
1234
- "type": "option",
1235
- "summary": "The target directory path to find all workflows to push.",
1236
- "multiple": false,
1237
- "dependsOn": [
1238
- "all"
1239
- ]
1240
- },
1241
- "commit": {
1242
- "name": "commit",
1243
- "type": "boolean",
1244
- "summary": "Push and commit the workflow(s) at the same time",
1245
- "allowNo": false
1246
- },
1247
- "commit-message": {
1248
- "name": "commit-message",
1249
- "type": "option",
1250
- "char": "m",
1251
- "summary": "Use the given value as the commit message",
1252
- "multiple": false,
1253
- "dependsOn": [
1254
- "commit"
1255
- ]
1256
- }
1257
- },
1258
- "args": {
1259
- "workflowKey": {
1260
- "name": "workflowKey",
1261
- "required": false
1262
- }
1263
- }
1264
- },
1265
- "workflow:run": {
1266
- "id": "workflow:run",
1267
- "summary": "Test run a workflow using the latest version from Knock.",
1268
- "strict": true,
1269
- "pluginName": "@knocklabs/cli",
1270
- "pluginAlias": "@knocklabs/cli",
1271
- "pluginType": "core",
1272
- "aliases": [],
1273
- "flags": {
1274
- "service-token": {
1275
- "name": "service-token",
1276
- "type": "option",
1277
- "summary": "The service token to authenticate with.",
1278
- "required": true,
1279
- "multiple": false
1280
- },
1281
- "api-origin": {
1282
- "name": "api-origin",
1283
- "type": "option",
1284
- "hidden": true,
1285
- "required": false,
1286
- "multiple": false
1287
- },
1288
- "environment": {
1289
- "name": "environment",
1290
- "type": "option",
1291
- "summary": "The environment in which to run the workflow",
1292
- "multiple": false,
1293
- "default": "development"
1294
- },
1295
- "recipients": {
1296
- "name": "recipients",
1297
- "type": "option",
1298
- "summary": "One or more recipient user ids separated by comma, or a JSON string containing one or more recipient object references for this workflow run.",
1299
- "required": true,
1300
- "multiple": false,
1301
- "aliases": [
1302
- "recipient"
1303
- ]
1304
- },
1305
- "actor": {
1306
- "name": "actor",
1307
- "type": "option",
1308
- "summary": "An actor id, or a JSON string of an actor object reference for the workflow run.",
1309
- "multiple": false
1310
- },
1311
- "tenant": {
1312
- "name": "tenant",
1313
- "type": "option",
1314
- "summary": "A tenant id for the workflow run.",
1315
- "multiple": false
1316
- },
1317
- "data": {
1318
- "name": "data",
1319
- "type": "option",
1320
- "summary": "A JSON string of the data for this workflow",
1321
- "multiple": false
1322
- }
1323
- },
1324
- "args": {
1325
- "workflowKey": {
1326
- "name": "workflowKey",
1327
- "required": true
1328
- }
1329
- }
1330
- },
1331
- "workflow:validate": {
1332
- "id": "workflow:validate",
1333
- "summary": "Validate one or more workflows from a local file system.",
1334
- "strict": true,
1335
- "pluginName": "@knocklabs/cli",
1336
- "pluginAlias": "@knocklabs/cli",
1337
- "pluginType": "core",
1338
- "aliases": [],
1339
- "flags": {
1340
- "service-token": {
1341
- "name": "service-token",
1342
- "type": "option",
1343
- "summary": "The service token to authenticate with.",
1344
- "required": true,
1345
- "multiple": false
1346
- },
1347
- "api-origin": {
1348
- "name": "api-origin",
1349
- "type": "option",
1350
- "hidden": true,
1351
- "required": false,
1352
- "multiple": false
1353
- },
1354
- "environment": {
1355
- "name": "environment",
1356
- "type": "option",
1357
- "summary": "Validating a workflow is only done in the development environment",
1358
- "multiple": false,
1359
- "options": [
1360
- "development"
1361
- ],
1362
- "default": "development"
1363
- },
1364
- "all": {
1365
- "name": "all",
1366
- "type": "boolean",
1367
- "summary": "Whether to validate all workflows from the target directory.",
1368
- "allowNo": false
1369
- },
1370
- "workflows-dir": {
1371
- "name": "workflows-dir",
1372
- "type": "option",
1373
- "summary": "The target directory path to find all workflows to validate.",
1374
- "multiple": false,
1375
- "dependsOn": [
1376
- "all"
1377
- ]
1378
- }
1379
- },
1380
- "args": {
1381
- "workflowKey": {
1382
- "name": "workflowKey",
1383
- "required": false
1384
- }
1385
- }
1386
- }
1387
- }
2
+ "commands": {},
3
+ "version": "0.1.12"
1388
4
  }