@knocklabs/cli 0.1.12 → 0.1.14

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 (78) hide show
  1. package/README.md +497 -1
  2. package/dist/{src/commands → commands}/translation/push.js +0 -1
  3. package/dist/{src/lib → lib}/marshal/translation/reader.js +4 -0
  4. package/oclif.manifest.json +1760 -2
  5. package/package.json +3 -3
  6. /package/dist/{src/commands → commands}/commit/get.js +0 -0
  7. /package/dist/{src/commands → commands}/commit/index.js +0 -0
  8. /package/dist/{src/commands → commands}/commit/list.js +0 -0
  9. /package/dist/{src/commands → commands}/commit/promote.js +0 -0
  10. /package/dist/{src/commands → commands}/knock.js +0 -0
  11. /package/dist/{src/commands → commands}/layout/get.js +0 -0
  12. /package/dist/{src/commands → commands}/layout/list.js +0 -0
  13. /package/dist/{src/commands → commands}/layout/pull.js +0 -0
  14. /package/dist/{src/commands → commands}/layout/push.js +0 -0
  15. /package/dist/{src/commands → commands}/layout/validate.js +0 -0
  16. /package/dist/{src/commands → commands}/ping.js +0 -0
  17. /package/dist/{src/commands → commands}/translation/get.js +0 -0
  18. /package/dist/{src/commands → commands}/translation/list.js +0 -0
  19. /package/dist/{src/commands → commands}/translation/pull.js +0 -0
  20. /package/dist/{src/commands → commands}/translation/validate.js +0 -0
  21. /package/dist/{src/commands → commands}/whoami.js +0 -0
  22. /package/dist/{src/commands → commands}/workflow/activate.js +0 -0
  23. /package/dist/{src/commands → commands}/workflow/get.js +0 -0
  24. /package/dist/{src/commands → commands}/workflow/list.js +0 -0
  25. /package/dist/{src/commands → commands}/workflow/new.js +0 -0
  26. /package/dist/{src/commands → commands}/workflow/pull.js +0 -0
  27. /package/dist/{src/commands → commands}/workflow/push.js +0 -0
  28. /package/dist/{src/commands → commands}/workflow/run.js +0 -0
  29. /package/dist/{src/commands → commands}/workflow/validate.js +0 -0
  30. /package/dist/{src/index.js → index.js} +0 -0
  31. /package/dist/{src/isomorphic.js → isomorphic.js} +0 -0
  32. /package/dist/{src/lib → lib}/api-v1.js +0 -0
  33. /package/dist/{src/lib → lib}/base-command.js +0 -0
  34. /package/dist/{src/lib → lib}/helpers/const.js +0 -0
  35. /package/dist/{src/lib → lib}/helpers/date.js +0 -0
  36. /package/dist/{src/lib → lib}/helpers/error.js +0 -0
  37. /package/dist/{src/lib → lib}/helpers/flag.js +0 -0
  38. /package/dist/{src/lib → lib}/helpers/fs.js +0 -0
  39. /package/dist/{src/lib → lib}/helpers/json.js +0 -0
  40. /package/dist/{src/lib → lib}/helpers/liquid.js +0 -0
  41. /package/dist/{src/lib → lib}/helpers/object.isomorphic.js +0 -0
  42. /package/dist/{src/lib → lib}/helpers/page.js +0 -0
  43. /package/dist/{src/lib → lib}/helpers/request.js +0 -0
  44. /package/dist/{src/lib → lib}/helpers/string.js +0 -0
  45. /package/dist/{src/lib → lib}/helpers/ux.js +0 -0
  46. /package/dist/{src/lib → lib}/marshal/commit/helpers.js +0 -0
  47. /package/dist/{src/lib → lib}/marshal/commit/index.js +0 -0
  48. /package/dist/{src/lib → lib}/marshal/commit/types.js +0 -0
  49. /package/dist/{src/lib → lib}/marshal/conditions/helpers.js +0 -0
  50. /package/dist/{src/lib → lib}/marshal/conditions/index.js +0 -0
  51. /package/dist/{src/lib → lib}/marshal/conditions/types.js +0 -0
  52. /package/dist/{src/lib → lib}/marshal/email-layout/helpers.js +0 -0
  53. /package/dist/{src/lib → lib}/marshal/email-layout/index.js +0 -0
  54. /package/dist/{src/lib → lib}/marshal/email-layout/processor.isomorphic.js +0 -0
  55. /package/dist/{src/lib → lib}/marshal/email-layout/reader.js +0 -0
  56. /package/dist/{src/lib → lib}/marshal/email-layout/types.js +0 -0
  57. /package/dist/{src/lib → lib}/marshal/email-layout/writer.js +0 -0
  58. /package/dist/{src/lib → lib}/marshal/index.isomorphic.js +0 -0
  59. /package/dist/{src/lib → lib}/marshal/shared/const.isomorphic.js +0 -0
  60. /package/dist/{src/lib → lib}/marshal/shared/helpers.js +0 -0
  61. /package/dist/{src/lib → lib}/marshal/shared/types.js +0 -0
  62. /package/dist/{src/lib → lib}/marshal/translation/helpers.js +0 -0
  63. /package/dist/{src/lib → lib}/marshal/translation/index.js +0 -0
  64. /package/dist/{src/lib → lib}/marshal/translation/processor.isomorphic.js +0 -0
  65. /package/dist/{src/lib → lib}/marshal/translation/types.js +0 -0
  66. /package/dist/{src/lib → lib}/marshal/translation/writer.js +0 -0
  67. /package/dist/{src/lib → lib}/marshal/workflow/generator.js +0 -0
  68. /package/dist/{src/lib → lib}/marshal/workflow/helpers.js +0 -0
  69. /package/dist/{src/lib → lib}/marshal/workflow/index.js +0 -0
  70. /package/dist/{src/lib → lib}/marshal/workflow/processor.isomorphic.js +0 -0
  71. /package/dist/{src/lib → lib}/marshal/workflow/reader.js +0 -0
  72. /package/dist/{src/lib → lib}/marshal/workflow/types.js +0 -0
  73. /package/dist/{src/lib → lib}/marshal/workflow/writer.js +0 -0
  74. /package/dist/{src/lib → lib}/run-context/helpers.js +0 -0
  75. /package/dist/{src/lib → lib}/run-context/index.js +0 -0
  76. /package/dist/{src/lib → lib}/run-context/loader.js +0 -0
  77. /package/dist/{src/lib → lib}/run-context/types.js +0 -0
  78. /package/dist/{src/lib → lib}/user-config.js +0 -0
@@ -1,4 +1,1762 @@
1
1
  {
2
- "commands": {},
3
- "version": "0.1.12"
2
+ "commands": {
3
+ "knock": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "flags": {
7
+ "service-token": {
8
+ "env": "KNOCK_SERVICE_TOKEN",
9
+ "name": "service-token",
10
+ "required": true,
11
+ "summary": "The service token to authenticate with.",
12
+ "hasDynamicHelp": false,
13
+ "multiple": false,
14
+ "type": "option"
15
+ },
16
+ "api-origin": {
17
+ "hidden": true,
18
+ "name": "api-origin",
19
+ "required": false,
20
+ "hasDynamicHelp": false,
21
+ "multiple": false,
22
+ "type": "option"
23
+ }
24
+ },
25
+ "hasDynamicHelp": false,
26
+ "hidden": true,
27
+ "hiddenAliases": [],
28
+ "id": "knock",
29
+ "pluginAlias": "@knocklabs/cli",
30
+ "pluginName": "@knocklabs/cli",
31
+ "pluginType": "core",
32
+ "strict": true,
33
+ "enableJsonFlag": false,
34
+ "isESM": false,
35
+ "relativePath": [
36
+ "dist",
37
+ "commands",
38
+ "knock.js"
39
+ ]
40
+ },
41
+ "ping": {
42
+ "aliases": [],
43
+ "args": {},
44
+ "flags": {
45
+ "service-token": {
46
+ "env": "KNOCK_SERVICE_TOKEN",
47
+ "name": "service-token",
48
+ "required": true,
49
+ "summary": "The service token to authenticate with.",
50
+ "hasDynamicHelp": false,
51
+ "multiple": false,
52
+ "type": "option"
53
+ },
54
+ "api-origin": {
55
+ "hidden": true,
56
+ "name": "api-origin",
57
+ "required": false,
58
+ "hasDynamicHelp": false,
59
+ "multiple": false,
60
+ "type": "option"
61
+ }
62
+ },
63
+ "hasDynamicHelp": false,
64
+ "hidden": true,
65
+ "hiddenAliases": [],
66
+ "id": "ping",
67
+ "pluginAlias": "@knocklabs/cli",
68
+ "pluginName": "@knocklabs/cli",
69
+ "pluginType": "core",
70
+ "strict": true,
71
+ "enableJsonFlag": false,
72
+ "isESM": false,
73
+ "relativePath": [
74
+ "dist",
75
+ "commands",
76
+ "ping.js"
77
+ ]
78
+ },
79
+ "whoami": {
80
+ "aliases": [],
81
+ "args": {},
82
+ "flags": {
83
+ "json": {
84
+ "description": "Format output as json.",
85
+ "helpGroup": "GLOBAL",
86
+ "name": "json",
87
+ "allowNo": false,
88
+ "type": "boolean"
89
+ },
90
+ "service-token": {
91
+ "env": "KNOCK_SERVICE_TOKEN",
92
+ "name": "service-token",
93
+ "required": true,
94
+ "summary": "The service token to authenticate with.",
95
+ "hasDynamicHelp": false,
96
+ "multiple": false,
97
+ "type": "option"
98
+ },
99
+ "api-origin": {
100
+ "hidden": true,
101
+ "name": "api-origin",
102
+ "required": false,
103
+ "hasDynamicHelp": false,
104
+ "multiple": false,
105
+ "type": "option"
106
+ }
107
+ },
108
+ "hasDynamicHelp": false,
109
+ "hiddenAliases": [],
110
+ "id": "whoami",
111
+ "pluginAlias": "@knocklabs/cli",
112
+ "pluginName": "@knocklabs/cli",
113
+ "pluginType": "core",
114
+ "strict": true,
115
+ "summary": "Verify the provided service token.",
116
+ "enableJsonFlag": true,
117
+ "isESM": false,
118
+ "relativePath": [
119
+ "dist",
120
+ "commands",
121
+ "whoami.js"
122
+ ]
123
+ },
124
+ "commit:get": {
125
+ "aliases": [],
126
+ "args": {
127
+ "id": {
128
+ "name": "id",
129
+ "required": true
130
+ }
131
+ },
132
+ "flags": {
133
+ "json": {
134
+ "description": "Format output as json.",
135
+ "helpGroup": "GLOBAL",
136
+ "name": "json",
137
+ "allowNo": false,
138
+ "type": "boolean"
139
+ },
140
+ "service-token": {
141
+ "env": "KNOCK_SERVICE_TOKEN",
142
+ "name": "service-token",
143
+ "required": true,
144
+ "summary": "The service token to authenticate with.",
145
+ "hasDynamicHelp": false,
146
+ "multiple": false,
147
+ "type": "option"
148
+ },
149
+ "api-origin": {
150
+ "hidden": true,
151
+ "name": "api-origin",
152
+ "required": false,
153
+ "hasDynamicHelp": false,
154
+ "multiple": false,
155
+ "type": "option"
156
+ }
157
+ },
158
+ "hasDynamicHelp": false,
159
+ "hiddenAliases": [],
160
+ "id": "commit:get",
161
+ "pluginAlias": "@knocklabs/cli",
162
+ "pluginName": "@knocklabs/cli",
163
+ "pluginType": "core",
164
+ "strict": true,
165
+ "summary": "Display a single commit",
166
+ "enableJsonFlag": true,
167
+ "isESM": false,
168
+ "relativePath": [
169
+ "dist",
170
+ "commands",
171
+ "commit",
172
+ "get.js"
173
+ ]
174
+ },
175
+ "commit": {
176
+ "aliases": [],
177
+ "args": {},
178
+ "flags": {
179
+ "service-token": {
180
+ "env": "KNOCK_SERVICE_TOKEN",
181
+ "name": "service-token",
182
+ "required": true,
183
+ "summary": "The service token to authenticate with.",
184
+ "hasDynamicHelp": false,
185
+ "multiple": false,
186
+ "type": "option"
187
+ },
188
+ "api-origin": {
189
+ "hidden": true,
190
+ "name": "api-origin",
191
+ "required": false,
192
+ "hasDynamicHelp": false,
193
+ "multiple": false,
194
+ "type": "option"
195
+ },
196
+ "environment": {
197
+ "name": "environment",
198
+ "summary": "Committing changes applies to the development environment only, use `commit promote` to promote changes to a subsequent environment.",
199
+ "default": "development",
200
+ "hasDynamicHelp": false,
201
+ "multiple": false,
202
+ "options": [
203
+ "development"
204
+ ],
205
+ "type": "option"
206
+ },
207
+ "commit-message": {
208
+ "char": "m",
209
+ "name": "commit-message",
210
+ "summary": "Use the given value as the commit message.",
211
+ "hasDynamicHelp": false,
212
+ "multiple": false,
213
+ "type": "option"
214
+ },
215
+ "force": {
216
+ "name": "force",
217
+ "summary": "Remove the confirmation prompt.",
218
+ "allowNo": false,
219
+ "type": "boolean"
220
+ }
221
+ },
222
+ "hasDynamicHelp": false,
223
+ "hiddenAliases": [],
224
+ "id": "commit",
225
+ "pluginAlias": "@knocklabs/cli",
226
+ "pluginName": "@knocklabs/cli",
227
+ "pluginType": "core",
228
+ "strict": true,
229
+ "summary": "Commit all changes in development environment.",
230
+ "enableJsonFlag": false,
231
+ "isESM": false,
232
+ "relativePath": [
233
+ "dist",
234
+ "commands",
235
+ "commit",
236
+ "index.js"
237
+ ]
238
+ },
239
+ "commit:list": {
240
+ "aliases": [],
241
+ "args": {},
242
+ "flags": {
243
+ "json": {
244
+ "description": "Format output as json.",
245
+ "helpGroup": "GLOBAL",
246
+ "name": "json",
247
+ "allowNo": false,
248
+ "type": "boolean"
249
+ },
250
+ "service-token": {
251
+ "env": "KNOCK_SERVICE_TOKEN",
252
+ "name": "service-token",
253
+ "required": true,
254
+ "summary": "The service token to authenticate with.",
255
+ "hasDynamicHelp": false,
256
+ "multiple": false,
257
+ "type": "option"
258
+ },
259
+ "api-origin": {
260
+ "hidden": true,
261
+ "name": "api-origin",
262
+ "required": false,
263
+ "hasDynamicHelp": false,
264
+ "multiple": false,
265
+ "type": "option"
266
+ },
267
+ "environment": {
268
+ "name": "environment",
269
+ "summary": "The environment to use.",
270
+ "default": "development",
271
+ "hasDynamicHelp": false,
272
+ "multiple": false,
273
+ "type": "option"
274
+ },
275
+ "promoted": {
276
+ "name": "promoted",
277
+ "summary": "Show only promoted or unpromoted changes between the given environment and the subsequent environment.",
278
+ "allowNo": true,
279
+ "type": "boolean"
280
+ },
281
+ "after": {
282
+ "name": "after",
283
+ "summary": "The cursor after which to fetch the next page.",
284
+ "hasDynamicHelp": false,
285
+ "multiple": false,
286
+ "type": "option"
287
+ },
288
+ "before": {
289
+ "name": "before",
290
+ "summary": "The cursor before which to fetch the previous page.",
291
+ "hasDynamicHelp": false,
292
+ "multiple": false,
293
+ "type": "option"
294
+ },
295
+ "limit": {
296
+ "name": "limit",
297
+ "summary": "The total number of entries to fetch per page.",
298
+ "hasDynamicHelp": false,
299
+ "multiple": false,
300
+ "type": "option"
301
+ }
302
+ },
303
+ "hasDynamicHelp": false,
304
+ "hiddenAliases": [],
305
+ "id": "commit:list",
306
+ "pluginAlias": "@knocklabs/cli",
307
+ "pluginName": "@knocklabs/cli",
308
+ "pluginType": "core",
309
+ "strict": true,
310
+ "summary": "Display all commits in an environment",
311
+ "enableJsonFlag": true,
312
+ "isESM": false,
313
+ "relativePath": [
314
+ "dist",
315
+ "commands",
316
+ "commit",
317
+ "list.js"
318
+ ]
319
+ },
320
+ "commit:promote": {
321
+ "aliases": [],
322
+ "args": {},
323
+ "flags": {
324
+ "service-token": {
325
+ "env": "KNOCK_SERVICE_TOKEN",
326
+ "name": "service-token",
327
+ "required": true,
328
+ "summary": "The service token to authenticate with.",
329
+ "hasDynamicHelp": false,
330
+ "multiple": false,
331
+ "type": "option"
332
+ },
333
+ "api-origin": {
334
+ "hidden": true,
335
+ "name": "api-origin",
336
+ "required": false,
337
+ "hasDynamicHelp": false,
338
+ "multiple": false,
339
+ "type": "option"
340
+ },
341
+ "to": {
342
+ "name": "to",
343
+ "summary": "The destination environment to promote all changes from the preceding environment.",
344
+ "hasDynamicHelp": false,
345
+ "multiple": false,
346
+ "type": "option"
347
+ },
348
+ "force": {
349
+ "name": "force",
350
+ "summary": "Remove the confirmation prompt.",
351
+ "allowNo": false,
352
+ "type": "boolean"
353
+ },
354
+ "only": {
355
+ "name": "only",
356
+ "summary": "The target commit id to promote to the subsequent environment",
357
+ "hasDynamicHelp": false,
358
+ "multiple": false,
359
+ "type": "option"
360
+ }
361
+ },
362
+ "hasDynamicHelp": false,
363
+ "hiddenAliases": [],
364
+ "id": "commit:promote",
365
+ "pluginAlias": "@knocklabs/cli",
366
+ "pluginName": "@knocklabs/cli",
367
+ "pluginType": "core",
368
+ "strict": true,
369
+ "summary": "Promote one or all commits to the subsequent environment.",
370
+ "enableJsonFlag": false,
371
+ "isESM": false,
372
+ "relativePath": [
373
+ "dist",
374
+ "commands",
375
+ "commit",
376
+ "promote.js"
377
+ ]
378
+ },
379
+ "layout:get": {
380
+ "aliases": [],
381
+ "args": {
382
+ "emailLayoutKey": {
383
+ "name": "emailLayoutKey",
384
+ "required": true
385
+ }
386
+ },
387
+ "flags": {
388
+ "json": {
389
+ "description": "Format output as json.",
390
+ "helpGroup": "GLOBAL",
391
+ "name": "json",
392
+ "allowNo": false,
393
+ "type": "boolean"
394
+ },
395
+ "service-token": {
396
+ "env": "KNOCK_SERVICE_TOKEN",
397
+ "name": "service-token",
398
+ "required": true,
399
+ "summary": "The service token to authenticate with.",
400
+ "hasDynamicHelp": false,
401
+ "multiple": false,
402
+ "type": "option"
403
+ },
404
+ "api-origin": {
405
+ "hidden": true,
406
+ "name": "api-origin",
407
+ "required": false,
408
+ "hasDynamicHelp": false,
409
+ "multiple": false,
410
+ "type": "option"
411
+ },
412
+ "environment": {
413
+ "name": "environment",
414
+ "summary": "The environment to use.",
415
+ "default": "development",
416
+ "hasDynamicHelp": false,
417
+ "multiple": false,
418
+ "type": "option"
419
+ },
420
+ "hide-uncommitted-changes": {
421
+ "name": "hide-uncommitted-changes",
422
+ "summary": "Hide any uncommitted changes.",
423
+ "allowNo": false,
424
+ "type": "boolean"
425
+ }
426
+ },
427
+ "hasDynamicHelp": false,
428
+ "hiddenAliases": [],
429
+ "id": "layout:get",
430
+ "pluginAlias": "@knocklabs/cli",
431
+ "pluginName": "@knocklabs/cli",
432
+ "pluginType": "core",
433
+ "strict": true,
434
+ "summary": "Display a single email layout from an environment.",
435
+ "enableJsonFlag": true,
436
+ "isESM": false,
437
+ "relativePath": [
438
+ "dist",
439
+ "commands",
440
+ "layout",
441
+ "get.js"
442
+ ]
443
+ },
444
+ "layout:list": {
445
+ "aliases": [],
446
+ "args": {},
447
+ "flags": {
448
+ "json": {
449
+ "description": "Format output as json.",
450
+ "helpGroup": "GLOBAL",
451
+ "name": "json",
452
+ "allowNo": false,
453
+ "type": "boolean"
454
+ },
455
+ "service-token": {
456
+ "env": "KNOCK_SERVICE_TOKEN",
457
+ "name": "service-token",
458
+ "required": true,
459
+ "summary": "The service token to authenticate with.",
460
+ "hasDynamicHelp": false,
461
+ "multiple": false,
462
+ "type": "option"
463
+ },
464
+ "api-origin": {
465
+ "hidden": true,
466
+ "name": "api-origin",
467
+ "required": false,
468
+ "hasDynamicHelp": false,
469
+ "multiple": false,
470
+ "type": "option"
471
+ },
472
+ "environment": {
473
+ "name": "environment",
474
+ "summary": "The environment to use.",
475
+ "default": "development",
476
+ "hasDynamicHelp": false,
477
+ "multiple": false,
478
+ "type": "option"
479
+ },
480
+ "hide-uncommitted-changes": {
481
+ "name": "hide-uncommitted-changes",
482
+ "summary": "Hide any uncommitted changes.",
483
+ "allowNo": false,
484
+ "type": "boolean"
485
+ },
486
+ "after": {
487
+ "name": "after",
488
+ "summary": "The cursor after which to fetch the next page.",
489
+ "hasDynamicHelp": false,
490
+ "multiple": false,
491
+ "type": "option"
492
+ },
493
+ "before": {
494
+ "name": "before",
495
+ "summary": "The cursor before which to fetch the previous page.",
496
+ "hasDynamicHelp": false,
497
+ "multiple": false,
498
+ "type": "option"
499
+ },
500
+ "limit": {
501
+ "name": "limit",
502
+ "summary": "The total number of entries to fetch per page.",
503
+ "hasDynamicHelp": false,
504
+ "multiple": false,
505
+ "type": "option"
506
+ }
507
+ },
508
+ "hasDynamicHelp": false,
509
+ "hiddenAliases": [],
510
+ "id": "layout:list",
511
+ "pluginAlias": "@knocklabs/cli",
512
+ "pluginName": "@knocklabs/cli",
513
+ "pluginType": "core",
514
+ "strict": true,
515
+ "summary": "Display all email layouts for an environment.",
516
+ "enableJsonFlag": true,
517
+ "isESM": false,
518
+ "relativePath": [
519
+ "dist",
520
+ "commands",
521
+ "layout",
522
+ "list.js"
523
+ ]
524
+ },
525
+ "layout:pull": {
526
+ "aliases": [],
527
+ "args": {
528
+ "emailLayoutKey": {
529
+ "name": "emailLayoutKey",
530
+ "required": false
531
+ }
532
+ },
533
+ "flags": {
534
+ "service-token": {
535
+ "env": "KNOCK_SERVICE_TOKEN",
536
+ "name": "service-token",
537
+ "required": true,
538
+ "summary": "The service token to authenticate with.",
539
+ "hasDynamicHelp": false,
540
+ "multiple": false,
541
+ "type": "option"
542
+ },
543
+ "api-origin": {
544
+ "hidden": true,
545
+ "name": "api-origin",
546
+ "required": false,
547
+ "hasDynamicHelp": false,
548
+ "multiple": false,
549
+ "type": "option"
550
+ },
551
+ "environment": {
552
+ "name": "environment",
553
+ "summary": "The environment to use.",
554
+ "default": "development",
555
+ "hasDynamicHelp": false,
556
+ "multiple": false,
557
+ "type": "option"
558
+ },
559
+ "all": {
560
+ "name": "all",
561
+ "summary": "Whether to pull all email layouts from the specified environment.",
562
+ "allowNo": false,
563
+ "type": "boolean"
564
+ },
565
+ "layouts-dir": {
566
+ "aliases": [
567
+ "email-layouts-dir"
568
+ ],
569
+ "dependsOn": [
570
+ "all"
571
+ ],
572
+ "name": "layouts-dir",
573
+ "summary": "The target directory path to pull all email layouts into.",
574
+ "hasDynamicHelp": false,
575
+ "multiple": false,
576
+ "type": "option"
577
+ },
578
+ "hide-uncommitted-changes": {
579
+ "name": "hide-uncommitted-changes",
580
+ "summary": "Hide any uncommitted changes.",
581
+ "allowNo": false,
582
+ "type": "boolean"
583
+ },
584
+ "force": {
585
+ "name": "force",
586
+ "summary": "Remove the confirmation prompt.",
587
+ "allowNo": false,
588
+ "type": "boolean"
589
+ }
590
+ },
591
+ "hasDynamicHelp": false,
592
+ "hiddenAliases": [],
593
+ "id": "layout:pull",
594
+ "pluginAlias": "@knocklabs/cli",
595
+ "pluginName": "@knocklabs/cli",
596
+ "pluginType": "core",
597
+ "strict": true,
598
+ "summary": "Pull one or more email layouts from an environment into a local file system.",
599
+ "enableJsonFlag": false,
600
+ "isESM": false,
601
+ "relativePath": [
602
+ "dist",
603
+ "commands",
604
+ "layout",
605
+ "pull.js"
606
+ ]
607
+ },
608
+ "layout:push": {
609
+ "aliases": [],
610
+ "args": {
611
+ "emailLayoutKey": {
612
+ "name": "emailLayoutKey",
613
+ "required": false
614
+ }
615
+ },
616
+ "flags": {
617
+ "service-token": {
618
+ "env": "KNOCK_SERVICE_TOKEN",
619
+ "name": "service-token",
620
+ "required": true,
621
+ "summary": "The service token to authenticate with.",
622
+ "hasDynamicHelp": false,
623
+ "multiple": false,
624
+ "type": "option"
625
+ },
626
+ "api-origin": {
627
+ "hidden": true,
628
+ "name": "api-origin",
629
+ "required": false,
630
+ "hasDynamicHelp": false,
631
+ "multiple": false,
632
+ "type": "option"
633
+ },
634
+ "environment": {
635
+ "name": "environment",
636
+ "summary": "Pushing an email layout is only allowed in the development environment",
637
+ "default": "development",
638
+ "hasDynamicHelp": false,
639
+ "multiple": false,
640
+ "options": [
641
+ "development"
642
+ ],
643
+ "type": "option"
644
+ },
645
+ "all": {
646
+ "name": "all",
647
+ "summary": "Whether to push all layouts from the target directory.",
648
+ "allowNo": false,
649
+ "type": "boolean"
650
+ },
651
+ "layouts-dir": {
652
+ "aliases": [
653
+ "email-layouts-dir"
654
+ ],
655
+ "dependsOn": [
656
+ "all"
657
+ ],
658
+ "name": "layouts-dir",
659
+ "summary": "The target directory path to find all layouts to push.",
660
+ "hasDynamicHelp": false,
661
+ "multiple": false,
662
+ "type": "option"
663
+ },
664
+ "commit": {
665
+ "name": "commit",
666
+ "summary": "Push and commit the layout(s) at the same time",
667
+ "allowNo": false,
668
+ "type": "boolean"
669
+ },
670
+ "commit-message": {
671
+ "char": "m",
672
+ "dependsOn": [
673
+ "commit"
674
+ ],
675
+ "name": "commit-message",
676
+ "summary": "Use the given value as the commit message",
677
+ "hasDynamicHelp": false,
678
+ "multiple": false,
679
+ "type": "option"
680
+ }
681
+ },
682
+ "hasDynamicHelp": false,
683
+ "hiddenAliases": [],
684
+ "id": "layout:push",
685
+ "pluginAlias": "@knocklabs/cli",
686
+ "pluginName": "@knocklabs/cli",
687
+ "pluginType": "core",
688
+ "strict": true,
689
+ "summary": "Push one or more email layouts from a local file system to Knock.",
690
+ "enableJsonFlag": false,
691
+ "isESM": false,
692
+ "relativePath": [
693
+ "dist",
694
+ "commands",
695
+ "layout",
696
+ "push.js"
697
+ ]
698
+ },
699
+ "layout:validate": {
700
+ "aliases": [],
701
+ "args": {
702
+ "emailLayoutKey": {
703
+ "name": "emailLayoutKey",
704
+ "required": false
705
+ }
706
+ },
707
+ "flags": {
708
+ "service-token": {
709
+ "env": "KNOCK_SERVICE_TOKEN",
710
+ "name": "service-token",
711
+ "required": true,
712
+ "summary": "The service token to authenticate with.",
713
+ "hasDynamicHelp": false,
714
+ "multiple": false,
715
+ "type": "option"
716
+ },
717
+ "api-origin": {
718
+ "hidden": true,
719
+ "name": "api-origin",
720
+ "required": false,
721
+ "hasDynamicHelp": false,
722
+ "multiple": false,
723
+ "type": "option"
724
+ },
725
+ "environment": {
726
+ "name": "environment",
727
+ "summary": "Validating a layout is only done in the development environment",
728
+ "default": "development",
729
+ "hasDynamicHelp": false,
730
+ "multiple": false,
731
+ "options": [
732
+ "development"
733
+ ],
734
+ "type": "option"
735
+ },
736
+ "all": {
737
+ "name": "all",
738
+ "summary": "Whether to validate all layouts from the target directory.",
739
+ "allowNo": false,
740
+ "type": "boolean"
741
+ },
742
+ "layouts-dir": {
743
+ "aliases": [
744
+ "email-layouts-dir"
745
+ ],
746
+ "dependsOn": [
747
+ "all"
748
+ ],
749
+ "name": "layouts-dir",
750
+ "summary": "The target directory path to find all layouts to validate.",
751
+ "hasDynamicHelp": false,
752
+ "multiple": false,
753
+ "type": "option"
754
+ }
755
+ },
756
+ "hasDynamicHelp": false,
757
+ "hiddenAliases": [],
758
+ "id": "layout:validate",
759
+ "pluginAlias": "@knocklabs/cli",
760
+ "pluginName": "@knocklabs/cli",
761
+ "pluginType": "core",
762
+ "strict": true,
763
+ "summary": "Validate one or more layouts from a local file system.",
764
+ "enableJsonFlag": false,
765
+ "isESM": false,
766
+ "relativePath": [
767
+ "dist",
768
+ "commands",
769
+ "layout",
770
+ "validate.js"
771
+ ]
772
+ },
773
+ "translation:get": {
774
+ "aliases": [],
775
+ "args": {
776
+ "translationRef": {
777
+ "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`.",
778
+ "name": "translationRef",
779
+ "required": true
780
+ }
781
+ },
782
+ "flags": {
783
+ "json": {
784
+ "description": "Format output as json.",
785
+ "helpGroup": "GLOBAL",
786
+ "name": "json",
787
+ "allowNo": false,
788
+ "type": "boolean"
789
+ },
790
+ "service-token": {
791
+ "env": "KNOCK_SERVICE_TOKEN",
792
+ "name": "service-token",
793
+ "required": true,
794
+ "summary": "The service token to authenticate with.",
795
+ "hasDynamicHelp": false,
796
+ "multiple": false,
797
+ "type": "option"
798
+ },
799
+ "api-origin": {
800
+ "hidden": true,
801
+ "name": "api-origin",
802
+ "required": false,
803
+ "hasDynamicHelp": false,
804
+ "multiple": false,
805
+ "type": "option"
806
+ },
807
+ "environment": {
808
+ "name": "environment",
809
+ "summary": "The environment to use.",
810
+ "default": "development",
811
+ "hasDynamicHelp": false,
812
+ "multiple": false,
813
+ "type": "option"
814
+ },
815
+ "hide-uncommitted-changes": {
816
+ "name": "hide-uncommitted-changes",
817
+ "summary": "Hide any uncommitted changes.",
818
+ "allowNo": false,
819
+ "type": "boolean"
820
+ }
821
+ },
822
+ "hasDynamicHelp": false,
823
+ "hiddenAliases": [],
824
+ "id": "translation:get",
825
+ "pluginAlias": "@knocklabs/cli",
826
+ "pluginName": "@knocklabs/cli",
827
+ "pluginType": "core",
828
+ "strict": true,
829
+ "summary": "Display a single translation from an environment.",
830
+ "enableJsonFlag": true,
831
+ "isESM": false,
832
+ "relativePath": [
833
+ "dist",
834
+ "commands",
835
+ "translation",
836
+ "get.js"
837
+ ]
838
+ },
839
+ "translation:list": {
840
+ "aliases": [],
841
+ "args": {},
842
+ "flags": {
843
+ "json": {
844
+ "description": "Format output as json.",
845
+ "helpGroup": "GLOBAL",
846
+ "name": "json",
847
+ "allowNo": false,
848
+ "type": "boolean"
849
+ },
850
+ "service-token": {
851
+ "env": "KNOCK_SERVICE_TOKEN",
852
+ "name": "service-token",
853
+ "required": true,
854
+ "summary": "The service token to authenticate with.",
855
+ "hasDynamicHelp": false,
856
+ "multiple": false,
857
+ "type": "option"
858
+ },
859
+ "api-origin": {
860
+ "hidden": true,
861
+ "name": "api-origin",
862
+ "required": false,
863
+ "hasDynamicHelp": false,
864
+ "multiple": false,
865
+ "type": "option"
866
+ },
867
+ "environment": {
868
+ "name": "environment",
869
+ "summary": "The environment to use.",
870
+ "default": "development",
871
+ "hasDynamicHelp": false,
872
+ "multiple": false,
873
+ "type": "option"
874
+ },
875
+ "hide-uncommitted-changes": {
876
+ "name": "hide-uncommitted-changes",
877
+ "summary": "Hide any uncommitted changes.",
878
+ "allowNo": false,
879
+ "type": "boolean"
880
+ },
881
+ "after": {
882
+ "name": "after",
883
+ "summary": "The cursor after which to fetch the next page.",
884
+ "hasDynamicHelp": false,
885
+ "multiple": false,
886
+ "type": "option"
887
+ },
888
+ "before": {
889
+ "name": "before",
890
+ "summary": "The cursor before which to fetch the previous page.",
891
+ "hasDynamicHelp": false,
892
+ "multiple": false,
893
+ "type": "option"
894
+ },
895
+ "limit": {
896
+ "name": "limit",
897
+ "summary": "The total number of entries to fetch per page.",
898
+ "hasDynamicHelp": false,
899
+ "multiple": false,
900
+ "type": "option"
901
+ }
902
+ },
903
+ "hasDynamicHelp": false,
904
+ "hiddenAliases": [],
905
+ "id": "translation:list",
906
+ "pluginAlias": "@knocklabs/cli",
907
+ "pluginName": "@knocklabs/cli",
908
+ "pluginType": "core",
909
+ "strict": true,
910
+ "summary": "Display all translations for an environment.",
911
+ "enableJsonFlag": true,
912
+ "isESM": false,
913
+ "relativePath": [
914
+ "dist",
915
+ "commands",
916
+ "translation",
917
+ "list.js"
918
+ ]
919
+ },
920
+ "translation:pull": {
921
+ "aliases": [],
922
+ "args": {
923
+ "translationRef": {
924
+ "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`.",
925
+ "name": "translationRef",
926
+ "required": false
927
+ }
928
+ },
929
+ "flags": {
930
+ "service-token": {
931
+ "env": "KNOCK_SERVICE_TOKEN",
932
+ "name": "service-token",
933
+ "required": true,
934
+ "summary": "The service token to authenticate with.",
935
+ "hasDynamicHelp": false,
936
+ "multiple": false,
937
+ "type": "option"
938
+ },
939
+ "api-origin": {
940
+ "hidden": true,
941
+ "name": "api-origin",
942
+ "required": false,
943
+ "hasDynamicHelp": false,
944
+ "multiple": false,
945
+ "type": "option"
946
+ },
947
+ "environment": {
948
+ "name": "environment",
949
+ "summary": "The environment to use.",
950
+ "default": "development",
951
+ "hasDynamicHelp": false,
952
+ "multiple": false,
953
+ "type": "option"
954
+ },
955
+ "all": {
956
+ "name": "all",
957
+ "summary": "Whether to pull all translations from the specified environment.",
958
+ "allowNo": false,
959
+ "type": "boolean"
960
+ },
961
+ "translations-dir": {
962
+ "dependsOn": [
963
+ "all"
964
+ ],
965
+ "name": "translations-dir",
966
+ "summary": "The target directory path to pull all translations into.",
967
+ "hasDynamicHelp": false,
968
+ "multiple": false,
969
+ "type": "option"
970
+ },
971
+ "hide-uncommitted-changes": {
972
+ "name": "hide-uncommitted-changes",
973
+ "summary": "Hide any uncommitted changes.",
974
+ "allowNo": false,
975
+ "type": "boolean"
976
+ },
977
+ "force": {
978
+ "name": "force",
979
+ "summary": "Remove the confirmation prompt.",
980
+ "allowNo": false,
981
+ "type": "boolean"
982
+ }
983
+ },
984
+ "hasDynamicHelp": false,
985
+ "hiddenAliases": [],
986
+ "id": "translation:pull",
987
+ "pluginAlias": "@knocklabs/cli",
988
+ "pluginName": "@knocklabs/cli",
989
+ "pluginType": "core",
990
+ "strict": true,
991
+ "summary": "Pull one or more translations from an environment into a local file system.",
992
+ "enableJsonFlag": false,
993
+ "isESM": false,
994
+ "relativePath": [
995
+ "dist",
996
+ "commands",
997
+ "translation",
998
+ "pull.js"
999
+ ]
1000
+ },
1001
+ "translation:push": {
1002
+ "aliases": [],
1003
+ "args": {
1004
+ "translationRef": {
1005
+ "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`.",
1006
+ "name": "translationRef",
1007
+ "required": false
1008
+ }
1009
+ },
1010
+ "flags": {
1011
+ "service-token": {
1012
+ "env": "KNOCK_SERVICE_TOKEN",
1013
+ "name": "service-token",
1014
+ "required": true,
1015
+ "summary": "The service token to authenticate with.",
1016
+ "hasDynamicHelp": false,
1017
+ "multiple": false,
1018
+ "type": "option"
1019
+ },
1020
+ "api-origin": {
1021
+ "hidden": true,
1022
+ "name": "api-origin",
1023
+ "required": false,
1024
+ "hasDynamicHelp": false,
1025
+ "multiple": false,
1026
+ "type": "option"
1027
+ },
1028
+ "environment": {
1029
+ "name": "environment",
1030
+ "summary": "Pushing a translation is only allowed in the development environment",
1031
+ "default": "development",
1032
+ "hasDynamicHelp": false,
1033
+ "multiple": false,
1034
+ "options": [
1035
+ "development"
1036
+ ],
1037
+ "type": "option"
1038
+ },
1039
+ "all": {
1040
+ "name": "all",
1041
+ "summary": "Whether to push all translations from the target directory.",
1042
+ "allowNo": false,
1043
+ "type": "boolean"
1044
+ },
1045
+ "translations-dir": {
1046
+ "dependsOn": [
1047
+ "all"
1048
+ ],
1049
+ "name": "translations-dir",
1050
+ "summary": "The target directory path to find all translations to push.",
1051
+ "hasDynamicHelp": false,
1052
+ "multiple": false,
1053
+ "type": "option"
1054
+ },
1055
+ "commit": {
1056
+ "name": "commit",
1057
+ "summary": "Push and commit the translation(s) at the same time",
1058
+ "allowNo": false,
1059
+ "type": "boolean"
1060
+ },
1061
+ "commit-message": {
1062
+ "char": "m",
1063
+ "dependsOn": [
1064
+ "commit"
1065
+ ],
1066
+ "name": "commit-message",
1067
+ "summary": "Use the given value as the commit message",
1068
+ "hasDynamicHelp": false,
1069
+ "multiple": false,
1070
+ "type": "option"
1071
+ }
1072
+ },
1073
+ "hasDynamicHelp": false,
1074
+ "hiddenAliases": [],
1075
+ "id": "translation:push",
1076
+ "pluginAlias": "@knocklabs/cli",
1077
+ "pluginName": "@knocklabs/cli",
1078
+ "pluginType": "core",
1079
+ "strict": true,
1080
+ "summary": "Push one or more translations from a local file system to Knock.",
1081
+ "enableJsonFlag": false,
1082
+ "isESM": false,
1083
+ "relativePath": [
1084
+ "dist",
1085
+ "commands",
1086
+ "translation",
1087
+ "push.js"
1088
+ ]
1089
+ },
1090
+ "translation:validate": {
1091
+ "aliases": [],
1092
+ "args": {
1093
+ "translationRef": {
1094
+ "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`.",
1095
+ "name": "translationRef",
1096
+ "required": false
1097
+ }
1098
+ },
1099
+ "flags": {
1100
+ "service-token": {
1101
+ "env": "KNOCK_SERVICE_TOKEN",
1102
+ "name": "service-token",
1103
+ "required": true,
1104
+ "summary": "The service token to authenticate with.",
1105
+ "hasDynamicHelp": false,
1106
+ "multiple": false,
1107
+ "type": "option"
1108
+ },
1109
+ "api-origin": {
1110
+ "hidden": true,
1111
+ "name": "api-origin",
1112
+ "required": false,
1113
+ "hasDynamicHelp": false,
1114
+ "multiple": false,
1115
+ "type": "option"
1116
+ },
1117
+ "environment": {
1118
+ "name": "environment",
1119
+ "summary": "Validating a translation is only done in the development environment",
1120
+ "default": "development",
1121
+ "hasDynamicHelp": false,
1122
+ "multiple": false,
1123
+ "options": [
1124
+ "development"
1125
+ ],
1126
+ "type": "option"
1127
+ },
1128
+ "all": {
1129
+ "name": "all",
1130
+ "summary": "Whether to validate all translations from the target directory.",
1131
+ "allowNo": false,
1132
+ "type": "boolean"
1133
+ },
1134
+ "translations-dir": {
1135
+ "dependsOn": [
1136
+ "all"
1137
+ ],
1138
+ "name": "translations-dir",
1139
+ "summary": "The target directory path to find all translations to validate.",
1140
+ "hasDynamicHelp": false,
1141
+ "multiple": false,
1142
+ "type": "option"
1143
+ }
1144
+ },
1145
+ "hasDynamicHelp": false,
1146
+ "hiddenAliases": [],
1147
+ "id": "translation:validate",
1148
+ "pluginAlias": "@knocklabs/cli",
1149
+ "pluginName": "@knocklabs/cli",
1150
+ "pluginType": "core",
1151
+ "strict": true,
1152
+ "summary": "Validate one or more translations from a local file system.",
1153
+ "enableJsonFlag": false,
1154
+ "isESM": false,
1155
+ "relativePath": [
1156
+ "dist",
1157
+ "commands",
1158
+ "translation",
1159
+ "validate.js"
1160
+ ]
1161
+ },
1162
+ "workflow:activate": {
1163
+ "aliases": [],
1164
+ "args": {
1165
+ "workflowKey": {
1166
+ "name": "workflowKey",
1167
+ "required": true
1168
+ }
1169
+ },
1170
+ "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.",
1171
+ "flags": {
1172
+ "service-token": {
1173
+ "env": "KNOCK_SERVICE_TOKEN",
1174
+ "name": "service-token",
1175
+ "required": true,
1176
+ "summary": "The service token to authenticate with.",
1177
+ "hasDynamicHelp": false,
1178
+ "multiple": false,
1179
+ "type": "option"
1180
+ },
1181
+ "api-origin": {
1182
+ "hidden": true,
1183
+ "name": "api-origin",
1184
+ "required": false,
1185
+ "hasDynamicHelp": false,
1186
+ "multiple": false,
1187
+ "type": "option"
1188
+ },
1189
+ "environment": {
1190
+ "name": "environment",
1191
+ "required": true,
1192
+ "summary": "The environment to use.",
1193
+ "hasDynamicHelp": false,
1194
+ "multiple": false,
1195
+ "type": "option"
1196
+ },
1197
+ "status": {
1198
+ "name": "status",
1199
+ "summary": "The workflow active status to set.",
1200
+ "default": true,
1201
+ "hasDynamicHelp": false,
1202
+ "multiple": false,
1203
+ "options": [
1204
+ "true",
1205
+ "false"
1206
+ ],
1207
+ "type": "option"
1208
+ },
1209
+ "force": {
1210
+ "name": "force",
1211
+ "summary": "Remove the confirmation prompt.",
1212
+ "allowNo": false,
1213
+ "type": "boolean"
1214
+ }
1215
+ },
1216
+ "hasDynamicHelp": false,
1217
+ "hiddenAliases": [],
1218
+ "id": "workflow:activate",
1219
+ "pluginAlias": "@knocklabs/cli",
1220
+ "pluginName": "@knocklabs/cli",
1221
+ "pluginType": "core",
1222
+ "strict": true,
1223
+ "summary": "Activate or deactivate a workflow in a given environment.",
1224
+ "enableJsonFlag": false,
1225
+ "isESM": false,
1226
+ "relativePath": [
1227
+ "dist",
1228
+ "commands",
1229
+ "workflow",
1230
+ "activate.js"
1231
+ ]
1232
+ },
1233
+ "workflow:get": {
1234
+ "aliases": [],
1235
+ "args": {
1236
+ "workflowKey": {
1237
+ "name": "workflowKey",
1238
+ "required": true
1239
+ }
1240
+ },
1241
+ "flags": {
1242
+ "json": {
1243
+ "description": "Format output as json.",
1244
+ "helpGroup": "GLOBAL",
1245
+ "name": "json",
1246
+ "allowNo": false,
1247
+ "type": "boolean"
1248
+ },
1249
+ "service-token": {
1250
+ "env": "KNOCK_SERVICE_TOKEN",
1251
+ "name": "service-token",
1252
+ "required": true,
1253
+ "summary": "The service token to authenticate with.",
1254
+ "hasDynamicHelp": false,
1255
+ "multiple": false,
1256
+ "type": "option"
1257
+ },
1258
+ "api-origin": {
1259
+ "hidden": true,
1260
+ "name": "api-origin",
1261
+ "required": false,
1262
+ "hasDynamicHelp": false,
1263
+ "multiple": false,
1264
+ "type": "option"
1265
+ },
1266
+ "environment": {
1267
+ "name": "environment",
1268
+ "summary": "The environment to use.",
1269
+ "default": "development",
1270
+ "hasDynamicHelp": false,
1271
+ "multiple": false,
1272
+ "type": "option"
1273
+ },
1274
+ "hide-uncommitted-changes": {
1275
+ "name": "hide-uncommitted-changes",
1276
+ "summary": "Hide any uncommitted changes.",
1277
+ "allowNo": false,
1278
+ "type": "boolean"
1279
+ }
1280
+ },
1281
+ "hasDynamicHelp": false,
1282
+ "hiddenAliases": [],
1283
+ "id": "workflow:get",
1284
+ "pluginAlias": "@knocklabs/cli",
1285
+ "pluginName": "@knocklabs/cli",
1286
+ "pluginType": "core",
1287
+ "strict": true,
1288
+ "summary": "Display a single workflow from an environment.",
1289
+ "enableJsonFlag": true,
1290
+ "isESM": false,
1291
+ "relativePath": [
1292
+ "dist",
1293
+ "commands",
1294
+ "workflow",
1295
+ "get.js"
1296
+ ]
1297
+ },
1298
+ "workflow:list": {
1299
+ "aliases": [],
1300
+ "args": {},
1301
+ "flags": {
1302
+ "json": {
1303
+ "description": "Format output as json.",
1304
+ "helpGroup": "GLOBAL",
1305
+ "name": "json",
1306
+ "allowNo": false,
1307
+ "type": "boolean"
1308
+ },
1309
+ "service-token": {
1310
+ "env": "KNOCK_SERVICE_TOKEN",
1311
+ "name": "service-token",
1312
+ "required": true,
1313
+ "summary": "The service token to authenticate with.",
1314
+ "hasDynamicHelp": false,
1315
+ "multiple": false,
1316
+ "type": "option"
1317
+ },
1318
+ "api-origin": {
1319
+ "hidden": true,
1320
+ "name": "api-origin",
1321
+ "required": false,
1322
+ "hasDynamicHelp": false,
1323
+ "multiple": false,
1324
+ "type": "option"
1325
+ },
1326
+ "environment": {
1327
+ "name": "environment",
1328
+ "summary": "The environment to use.",
1329
+ "default": "development",
1330
+ "hasDynamicHelp": false,
1331
+ "multiple": false,
1332
+ "type": "option"
1333
+ },
1334
+ "hide-uncommitted-changes": {
1335
+ "name": "hide-uncommitted-changes",
1336
+ "summary": "Hide any uncommitted changes.",
1337
+ "allowNo": false,
1338
+ "type": "boolean"
1339
+ },
1340
+ "after": {
1341
+ "name": "after",
1342
+ "summary": "The cursor after which to fetch the next page.",
1343
+ "hasDynamicHelp": false,
1344
+ "multiple": false,
1345
+ "type": "option"
1346
+ },
1347
+ "before": {
1348
+ "name": "before",
1349
+ "summary": "The cursor before which to fetch the previous page.",
1350
+ "hasDynamicHelp": false,
1351
+ "multiple": false,
1352
+ "type": "option"
1353
+ },
1354
+ "limit": {
1355
+ "name": "limit",
1356
+ "summary": "The total number of entries to fetch per page.",
1357
+ "hasDynamicHelp": false,
1358
+ "multiple": false,
1359
+ "type": "option"
1360
+ }
1361
+ },
1362
+ "hasDynamicHelp": false,
1363
+ "hiddenAliases": [],
1364
+ "id": "workflow:list",
1365
+ "pluginAlias": "@knocklabs/cli",
1366
+ "pluginName": "@knocklabs/cli",
1367
+ "pluginType": "core",
1368
+ "strict": true,
1369
+ "summary": "Display all workflows for an environment.",
1370
+ "enableJsonFlag": true,
1371
+ "isESM": false,
1372
+ "relativePath": [
1373
+ "dist",
1374
+ "commands",
1375
+ "workflow",
1376
+ "list.js"
1377
+ ]
1378
+ },
1379
+ "workflow:new": {
1380
+ "aliases": [],
1381
+ "args": {
1382
+ "workflowKey": {
1383
+ "name": "workflowKey",
1384
+ "required": true
1385
+ }
1386
+ },
1387
+ "flags": {
1388
+ "service-token": {
1389
+ "env": "KNOCK_SERVICE_TOKEN",
1390
+ "name": "service-token",
1391
+ "required": true,
1392
+ "summary": "The service token to authenticate with.",
1393
+ "hasDynamicHelp": false,
1394
+ "multiple": false,
1395
+ "type": "option"
1396
+ },
1397
+ "api-origin": {
1398
+ "hidden": true,
1399
+ "name": "api-origin",
1400
+ "required": false,
1401
+ "hasDynamicHelp": false,
1402
+ "multiple": false,
1403
+ "type": "option"
1404
+ },
1405
+ "steps": {
1406
+ "aliases": [
1407
+ "step"
1408
+ ],
1409
+ "name": "steps",
1410
+ "hasDynamicHelp": false,
1411
+ "multiple": false,
1412
+ "type": "option"
1413
+ },
1414
+ "force": {
1415
+ "name": "force",
1416
+ "allowNo": false,
1417
+ "type": "boolean"
1418
+ }
1419
+ },
1420
+ "hasDynamicHelp": false,
1421
+ "hidden": true,
1422
+ "hiddenAliases": [],
1423
+ "id": "workflow:new",
1424
+ "pluginAlias": "@knocklabs/cli",
1425
+ "pluginName": "@knocklabs/cli",
1426
+ "pluginType": "core",
1427
+ "strict": true,
1428
+ "enableJsonFlag": false,
1429
+ "isESM": false,
1430
+ "relativePath": [
1431
+ "dist",
1432
+ "commands",
1433
+ "workflow",
1434
+ "new.js"
1435
+ ]
1436
+ },
1437
+ "workflow:pull": {
1438
+ "aliases": [],
1439
+ "args": {
1440
+ "workflowKey": {
1441
+ "name": "workflowKey",
1442
+ "required": false
1443
+ }
1444
+ },
1445
+ "flags": {
1446
+ "service-token": {
1447
+ "env": "KNOCK_SERVICE_TOKEN",
1448
+ "name": "service-token",
1449
+ "required": true,
1450
+ "summary": "The service token to authenticate with.",
1451
+ "hasDynamicHelp": false,
1452
+ "multiple": false,
1453
+ "type": "option"
1454
+ },
1455
+ "api-origin": {
1456
+ "hidden": true,
1457
+ "name": "api-origin",
1458
+ "required": false,
1459
+ "hasDynamicHelp": false,
1460
+ "multiple": false,
1461
+ "type": "option"
1462
+ },
1463
+ "environment": {
1464
+ "name": "environment",
1465
+ "summary": "The environment to use.",
1466
+ "default": "development",
1467
+ "hasDynamicHelp": false,
1468
+ "multiple": false,
1469
+ "type": "option"
1470
+ },
1471
+ "all": {
1472
+ "name": "all",
1473
+ "summary": "Whether to pull all workflows from the specified environment.",
1474
+ "allowNo": false,
1475
+ "type": "boolean"
1476
+ },
1477
+ "workflows-dir": {
1478
+ "dependsOn": [
1479
+ "all"
1480
+ ],
1481
+ "name": "workflows-dir",
1482
+ "summary": "The target directory path to pull all workflows into.",
1483
+ "hasDynamicHelp": false,
1484
+ "multiple": false,
1485
+ "type": "option"
1486
+ },
1487
+ "hide-uncommitted-changes": {
1488
+ "name": "hide-uncommitted-changes",
1489
+ "summary": "Hide any uncommitted changes.",
1490
+ "allowNo": false,
1491
+ "type": "boolean"
1492
+ },
1493
+ "force": {
1494
+ "name": "force",
1495
+ "summary": "Remove the confirmation prompt.",
1496
+ "allowNo": false,
1497
+ "type": "boolean"
1498
+ }
1499
+ },
1500
+ "hasDynamicHelp": false,
1501
+ "hiddenAliases": [],
1502
+ "id": "workflow:pull",
1503
+ "pluginAlias": "@knocklabs/cli",
1504
+ "pluginName": "@knocklabs/cli",
1505
+ "pluginType": "core",
1506
+ "strict": true,
1507
+ "summary": "Pull one or more workflows from an environment into a local file system.",
1508
+ "enableJsonFlag": false,
1509
+ "isESM": false,
1510
+ "relativePath": [
1511
+ "dist",
1512
+ "commands",
1513
+ "workflow",
1514
+ "pull.js"
1515
+ ]
1516
+ },
1517
+ "workflow:push": {
1518
+ "aliases": [],
1519
+ "args": {
1520
+ "workflowKey": {
1521
+ "name": "workflowKey",
1522
+ "required": false
1523
+ }
1524
+ },
1525
+ "flags": {
1526
+ "service-token": {
1527
+ "env": "KNOCK_SERVICE_TOKEN",
1528
+ "name": "service-token",
1529
+ "required": true,
1530
+ "summary": "The service token to authenticate with.",
1531
+ "hasDynamicHelp": false,
1532
+ "multiple": false,
1533
+ "type": "option"
1534
+ },
1535
+ "api-origin": {
1536
+ "hidden": true,
1537
+ "name": "api-origin",
1538
+ "required": false,
1539
+ "hasDynamicHelp": false,
1540
+ "multiple": false,
1541
+ "type": "option"
1542
+ },
1543
+ "environment": {
1544
+ "name": "environment",
1545
+ "summary": "Pushing a workflow is only allowed in the development environment",
1546
+ "default": "development",
1547
+ "hasDynamicHelp": false,
1548
+ "multiple": false,
1549
+ "options": [
1550
+ "development"
1551
+ ],
1552
+ "type": "option"
1553
+ },
1554
+ "all": {
1555
+ "name": "all",
1556
+ "summary": "Whether to push all workflows from the target directory.",
1557
+ "allowNo": false,
1558
+ "type": "boolean"
1559
+ },
1560
+ "workflows-dir": {
1561
+ "dependsOn": [
1562
+ "all"
1563
+ ],
1564
+ "name": "workflows-dir",
1565
+ "summary": "The target directory path to find all workflows to push.",
1566
+ "hasDynamicHelp": false,
1567
+ "multiple": false,
1568
+ "type": "option"
1569
+ },
1570
+ "commit": {
1571
+ "name": "commit",
1572
+ "summary": "Push and commit the workflow(s) at the same time",
1573
+ "allowNo": false,
1574
+ "type": "boolean"
1575
+ },
1576
+ "commit-message": {
1577
+ "char": "m",
1578
+ "dependsOn": [
1579
+ "commit"
1580
+ ],
1581
+ "name": "commit-message",
1582
+ "summary": "Use the given value as the commit message",
1583
+ "hasDynamicHelp": false,
1584
+ "multiple": false,
1585
+ "type": "option"
1586
+ }
1587
+ },
1588
+ "hasDynamicHelp": false,
1589
+ "hiddenAliases": [],
1590
+ "id": "workflow:push",
1591
+ "pluginAlias": "@knocklabs/cli",
1592
+ "pluginName": "@knocklabs/cli",
1593
+ "pluginType": "core",
1594
+ "strict": true,
1595
+ "summary": "Push one or more workflows from a local file system to Knock.",
1596
+ "enableJsonFlag": false,
1597
+ "isESM": false,
1598
+ "relativePath": [
1599
+ "dist",
1600
+ "commands",
1601
+ "workflow",
1602
+ "push.js"
1603
+ ]
1604
+ },
1605
+ "workflow:run": {
1606
+ "aliases": [],
1607
+ "args": {
1608
+ "workflowKey": {
1609
+ "name": "workflowKey",
1610
+ "required": true
1611
+ }
1612
+ },
1613
+ "flags": {
1614
+ "service-token": {
1615
+ "env": "KNOCK_SERVICE_TOKEN",
1616
+ "name": "service-token",
1617
+ "required": true,
1618
+ "summary": "The service token to authenticate with.",
1619
+ "hasDynamicHelp": false,
1620
+ "multiple": false,
1621
+ "type": "option"
1622
+ },
1623
+ "api-origin": {
1624
+ "hidden": true,
1625
+ "name": "api-origin",
1626
+ "required": false,
1627
+ "hasDynamicHelp": false,
1628
+ "multiple": false,
1629
+ "type": "option"
1630
+ },
1631
+ "environment": {
1632
+ "name": "environment",
1633
+ "summary": "The environment in which to run the workflow",
1634
+ "default": "development",
1635
+ "hasDynamicHelp": false,
1636
+ "multiple": false,
1637
+ "type": "option"
1638
+ },
1639
+ "recipients": {
1640
+ "aliases": [
1641
+ "recipient"
1642
+ ],
1643
+ "name": "recipients",
1644
+ "required": true,
1645
+ "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.",
1646
+ "hasDynamicHelp": false,
1647
+ "multiple": false,
1648
+ "type": "option"
1649
+ },
1650
+ "actor": {
1651
+ "name": "actor",
1652
+ "summary": "An actor id, or a JSON string of an actor object reference for the workflow run.",
1653
+ "hasDynamicHelp": false,
1654
+ "multiple": false,
1655
+ "type": "option"
1656
+ },
1657
+ "tenant": {
1658
+ "name": "tenant",
1659
+ "summary": "A tenant id for the workflow run.",
1660
+ "hasDynamicHelp": false,
1661
+ "multiple": false,
1662
+ "type": "option"
1663
+ },
1664
+ "data": {
1665
+ "name": "data",
1666
+ "summary": "A JSON string of the data for this workflow",
1667
+ "hasDynamicHelp": false,
1668
+ "multiple": false,
1669
+ "type": "option"
1670
+ }
1671
+ },
1672
+ "hasDynamicHelp": false,
1673
+ "hiddenAliases": [],
1674
+ "id": "workflow:run",
1675
+ "pluginAlias": "@knocklabs/cli",
1676
+ "pluginName": "@knocklabs/cli",
1677
+ "pluginType": "core",
1678
+ "strict": true,
1679
+ "summary": "Test run a workflow using the latest version from Knock.",
1680
+ "enableJsonFlag": false,
1681
+ "isESM": false,
1682
+ "relativePath": [
1683
+ "dist",
1684
+ "commands",
1685
+ "workflow",
1686
+ "run.js"
1687
+ ]
1688
+ },
1689
+ "workflow:validate": {
1690
+ "aliases": [],
1691
+ "args": {
1692
+ "workflowKey": {
1693
+ "name": "workflowKey",
1694
+ "required": false
1695
+ }
1696
+ },
1697
+ "flags": {
1698
+ "service-token": {
1699
+ "env": "KNOCK_SERVICE_TOKEN",
1700
+ "name": "service-token",
1701
+ "required": true,
1702
+ "summary": "The service token to authenticate with.",
1703
+ "hasDynamicHelp": false,
1704
+ "multiple": false,
1705
+ "type": "option"
1706
+ },
1707
+ "api-origin": {
1708
+ "hidden": true,
1709
+ "name": "api-origin",
1710
+ "required": false,
1711
+ "hasDynamicHelp": false,
1712
+ "multiple": false,
1713
+ "type": "option"
1714
+ },
1715
+ "environment": {
1716
+ "name": "environment",
1717
+ "summary": "Validating a workflow is only done in the development environment",
1718
+ "default": "development",
1719
+ "hasDynamicHelp": false,
1720
+ "multiple": false,
1721
+ "options": [
1722
+ "development"
1723
+ ],
1724
+ "type": "option"
1725
+ },
1726
+ "all": {
1727
+ "name": "all",
1728
+ "summary": "Whether to validate all workflows from the target directory.",
1729
+ "allowNo": false,
1730
+ "type": "boolean"
1731
+ },
1732
+ "workflows-dir": {
1733
+ "dependsOn": [
1734
+ "all"
1735
+ ],
1736
+ "name": "workflows-dir",
1737
+ "summary": "The target directory path to find all workflows to validate.",
1738
+ "hasDynamicHelp": false,
1739
+ "multiple": false,
1740
+ "type": "option"
1741
+ }
1742
+ },
1743
+ "hasDynamicHelp": false,
1744
+ "hiddenAliases": [],
1745
+ "id": "workflow:validate",
1746
+ "pluginAlias": "@knocklabs/cli",
1747
+ "pluginName": "@knocklabs/cli",
1748
+ "pluginType": "core",
1749
+ "strict": true,
1750
+ "summary": "Validate one or more workflows from a local file system.",
1751
+ "enableJsonFlag": false,
1752
+ "isESM": false,
1753
+ "relativePath": [
1754
+ "dist",
1755
+ "commands",
1756
+ "workflow",
1757
+ "validate.js"
1758
+ ]
1759
+ }
1760
+ },
1761
+ "version": "0.1.14"
4
1762
  }