@knocklabs/cli 0.3.1 → 1.0.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/README.md +258 -55
  2. package/dist/commands/branch/delete.js +4 -1
  3. package/dist/commands/branch/merge.js +82 -0
  4. package/dist/commands/channel/list.js +73 -0
  5. package/dist/commands/environment/list.js +73 -0
  6. package/dist/commands/guide/new.js +276 -0
  7. package/dist/commands/guide/pull.js +5 -6
  8. package/dist/commands/guide/push.js +1 -1
  9. package/dist/commands/guide/validate.js +1 -1
  10. package/dist/commands/init.js +108 -0
  11. package/dist/commands/layout/new.js +228 -0
  12. package/dist/commands/layout/pull.js +5 -6
  13. package/dist/commands/layout/push.js +1 -1
  14. package/dist/commands/layout/validate.js +1 -1
  15. package/dist/commands/message-type/new.js +228 -0
  16. package/dist/commands/message-type/pull.js +5 -6
  17. package/dist/commands/message-type/push.js +1 -1
  18. package/dist/commands/message-type/validate.js +1 -1
  19. package/dist/commands/partial/new.js +274 -0
  20. package/dist/commands/partial/pull.js +5 -6
  21. package/dist/commands/partial/push.js +1 -1
  22. package/dist/commands/partial/validate.js +1 -1
  23. package/dist/commands/pull.js +7 -2
  24. package/dist/commands/push.js +6 -4
  25. package/dist/commands/translation/pull.js +1 -1
  26. package/dist/commands/translation/push.js +1 -1
  27. package/dist/commands/translation/validate.js +1 -1
  28. package/dist/commands/workflow/new.js +179 -54
  29. package/dist/commands/workflow/pull.js +6 -8
  30. package/dist/commands/workflow/push.js +1 -1
  31. package/dist/commands/workflow/validate.js +1 -1
  32. package/dist/lib/api-v1.js +23 -2
  33. package/dist/lib/auth.js +1 -1
  34. package/dist/lib/base-command.js +18 -15
  35. package/dist/lib/helpers/project-config.js +158 -0
  36. package/dist/lib/helpers/request.js +1 -2
  37. package/dist/lib/helpers/string.js +4 -4
  38. package/dist/lib/helpers/typegen.js +1 -1
  39. package/dist/lib/marshal/email-layout/generator.js +152 -0
  40. package/dist/lib/marshal/email-layout/helpers.js +6 -9
  41. package/dist/lib/marshal/email-layout/index.js +1 -0
  42. package/dist/lib/marshal/email-layout/writer.js +15 -3
  43. package/dist/lib/marshal/guide/generator.js +163 -0
  44. package/dist/lib/marshal/guide/helpers.js +6 -10
  45. package/dist/lib/marshal/guide/index.js +1 -0
  46. package/dist/lib/marshal/guide/writer.js +5 -9
  47. package/dist/lib/marshal/message-type/generator.js +139 -0
  48. package/dist/lib/marshal/message-type/helpers.js +6 -10
  49. package/dist/lib/marshal/message-type/index.js +1 -0
  50. package/dist/lib/marshal/message-type/writer.js +5 -1
  51. package/dist/lib/marshal/partial/generator.js +159 -0
  52. package/dist/lib/marshal/partial/helpers.js +6 -10
  53. package/dist/lib/marshal/partial/index.js +1 -0
  54. package/dist/lib/marshal/partial/writer.js +3 -0
  55. package/dist/lib/marshal/translation/helpers.js +6 -10
  56. package/dist/lib/marshal/translation/processor.isomorphic.js +4 -4
  57. package/dist/lib/marshal/translation/writer.js +2 -2
  58. package/dist/lib/marshal/workflow/generator.js +175 -19
  59. package/dist/lib/marshal/workflow/helpers.js +7 -10
  60. package/dist/lib/run-context/loader.js +5 -0
  61. package/dist/lib/templates.js +131 -0
  62. package/oclif.manifest.json +1075 -471
  63. package/package.json +10 -8
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
16
16
  $ knock COMMAND
17
17
  running command...
18
18
  $ knock (--version)
19
- @knocklabs/cli/0.3.1 linux-x64 node-v18.20.8
19
+ @knocklabs/cli/1.0.0-rc.1 linux-x64 node-v18.20.8
20
20
  $ knock --help [COMMAND]
21
21
  USAGE
22
22
  $ knock COMMAND
@@ -31,21 +31,27 @@ USAGE
31
31
  * [`knock branch delete SLUG`](#knock-branch-delete-slug)
32
32
  * [`knock branch exit`](#knock-branch-exit)
33
33
  * [`knock branch list`](#knock-branch-list)
34
+ * [`knock branch merge SLUG`](#knock-branch-merge-slug)
34
35
  * [`knock branch switch SLUG`](#knock-branch-switch-slug)
36
+ * [`knock channel list`](#knock-channel-list)
35
37
  * [`knock commit`](#knock-commit)
36
38
  * [`knock commit get ID`](#knock-commit-get-id)
37
39
  * [`knock commit list`](#knock-commit-list)
38
40
  * [`knock commit promote`](#knock-commit-promote)
41
+ * [`knock environment list`](#knock-environment-list)
39
42
  * [`knock guide activate GUIDEKEY`](#knock-guide-activate-guidekey)
40
43
  * [`knock guide generate-types`](#knock-guide-generate-types)
41
44
  * [`knock guide get GUIDEKEY`](#knock-guide-get-guidekey)
42
45
  * [`knock guide list`](#knock-guide-list)
46
+ * [`knock guide new`](#knock-guide-new)
43
47
  * [`knock guide pull [GUIDEKEY]`](#knock-guide-pull-guidekey)
44
48
  * [`knock guide push [GUIDEKEY]`](#knock-guide-push-guidekey)
45
49
  * [`knock guide validate [GUIDEKEY]`](#knock-guide-validate-guidekey)
46
50
  * [`knock help [COMMAND]`](#knock-help-command)
51
+ * [`knock init`](#knock-init)
47
52
  * [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
48
53
  * [`knock layout list`](#knock-layout-list)
54
+ * [`knock layout new`](#knock-layout-new)
49
55
  * [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
50
56
  * [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
51
57
  * [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
@@ -53,11 +59,13 @@ USAGE
53
59
  * [`knock logout`](#knock-logout)
54
60
  * [`knock message-type get MESSAGETYPEKEY`](#knock-message-type-get-messagetypekey)
55
61
  * [`knock message-type list`](#knock-message-type-list)
62
+ * [`knock message-type new`](#knock-message-type-new)
56
63
  * [`knock message-type pull [MESSAGETYPEKEY]`](#knock-message-type-pull-messagetypekey)
57
64
  * [`knock message-type push [MESSAGETYPEKEY]`](#knock-message-type-push-messagetypekey)
58
65
  * [`knock message-type validate [MESSAGETYPEKEY]`](#knock-message-type-validate-messagetypekey)
59
66
  * [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
60
67
  * [`knock partial list`](#knock-partial-list)
68
+ * [`knock partial new`](#knock-partial-new)
61
69
  * [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
62
70
  * [`knock partial push [PARTIALKEY]`](#knock-partial-push-partialkey)
63
71
  * [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
@@ -73,6 +81,7 @@ USAGE
73
81
  * [`knock workflow generate-types`](#knock-workflow-generate-types)
74
82
  * [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
75
83
  * [`knock workflow list`](#knock-workflow-list)
84
+ * [`knock workflow new`](#knock-workflow-new)
76
85
  * [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
77
86
  * [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
78
87
  * [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
@@ -96,7 +105,7 @@ GLOBAL FLAGS
96
105
  --json Format output as json.
97
106
  ```
98
107
 
99
- _See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/branch/create.ts)_
108
+ _See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/create.ts)_
100
109
 
101
110
  ## `knock branch delete SLUG`
102
111
 
@@ -114,7 +123,7 @@ FLAGS
114
123
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
115
124
  ```
116
125
 
117
- _See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/branch/delete.ts)_
126
+ _See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/delete.ts)_
118
127
 
119
128
  ## `knock branch exit`
120
129
 
@@ -128,7 +137,7 @@ FLAGS
128
137
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
129
138
  ```
130
139
 
131
- _See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/branch/exit.ts)_
140
+ _See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/exit.ts)_
132
141
 
133
142
  ## `knock branch list`
134
143
 
@@ -148,7 +157,26 @@ GLOBAL FLAGS
148
157
  --json Format output as json.
149
158
  ```
150
159
 
151
- _See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/branch/list.ts)_
160
+ _See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/list.ts)_
161
+
162
+ ## `knock branch merge SLUG`
163
+
164
+ Merges a branch into the development environment.
165
+
166
+ ```
167
+ USAGE
168
+ $ knock branch merge SLUG [--service-token <value>] [--force] [--delete]
169
+
170
+ ARGUMENTS
171
+ SLUG The slug of the branch to merge
172
+
173
+ FLAGS
174
+ --[no-]delete Delete the branch after merging.
175
+ --force Remove the confirmation prompt.
176
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
177
+ ```
178
+
179
+ _See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/merge.ts)_
152
180
 
153
181
  ## `knock branch switch SLUG`
154
182
 
@@ -167,7 +195,24 @@ FLAGS
167
195
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
168
196
  ```
169
197
 
170
- _See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/branch/switch.ts)_
198
+ _See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/branch/switch.ts)_
199
+
200
+ ## `knock channel list`
201
+
202
+ Display all channels configured for the account.
203
+
204
+ ```
205
+ USAGE
206
+ $ knock channel list [--json] [--service-token <value>]
207
+
208
+ FLAGS
209
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
210
+
211
+ GLOBAL FLAGS
212
+ --json Format output as json.
213
+ ```
214
+
215
+ _See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/channel/list.ts)_
171
216
 
172
217
  ## `knock commit`
173
218
 
@@ -188,7 +233,7 @@ FLAGS
188
233
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
189
234
  ```
190
235
 
191
- _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/commit/index.ts)_
236
+ _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/commit/index.ts)_
192
237
 
193
238
  ## `knock commit get ID`
194
239
 
@@ -205,7 +250,7 @@ GLOBAL FLAGS
205
250
  --json Format output as json.
206
251
  ```
207
252
 
208
- _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/commit/get.ts)_
253
+ _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/commit/get.ts)_
209
254
 
210
255
  ## `knock commit list`
211
256
 
@@ -237,7 +282,7 @@ GLOBAL FLAGS
237
282
  --json Format output as json.
238
283
  ```
239
284
 
240
- _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/commit/list.ts)_
285
+ _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/commit/list.ts)_
241
286
 
242
287
  ## `knock commit promote`
243
288
 
@@ -254,7 +299,24 @@ FLAGS
254
299
  --to=<value> The destination environment to promote all changes from the preceding environment.
255
300
  ```
256
301
 
257
- _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/commit/promote.ts)_
302
+ _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/commit/promote.ts)_
303
+
304
+ ## `knock environment list`
305
+
306
+ Display all environments configured for the account.
307
+
308
+ ```
309
+ USAGE
310
+ $ knock environment list [--json] [--service-token <value>]
311
+
312
+ FLAGS
313
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
314
+
315
+ GLOBAL FLAGS
316
+ --json Format output as json.
317
+ ```
318
+
319
+ _See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/environment/list.ts)_
258
320
 
259
321
  ## `knock guide activate GUIDEKEY`
260
322
 
@@ -285,7 +347,7 @@ DESCRIPTION
285
347
  or deactivated at a later time using the --from and --until flags.
286
348
  ```
287
349
 
288
- _See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/activate.ts)_
350
+ _See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/activate.ts)_
289
351
 
290
352
  ## `knock guide generate-types`
291
353
 
@@ -308,7 +370,7 @@ DESCRIPTION
308
370
  Generate types for all guides in an environment and write them to a file.
309
371
  ```
310
372
 
311
- _See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/generate-types.ts)_
373
+ _See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/generate-types.ts)_
312
374
 
313
375
  ## `knock guide get GUIDEKEY`
314
376
 
@@ -329,7 +391,7 @@ GLOBAL FLAGS
329
391
  --json Format output as json.
330
392
  ```
331
393
 
332
- _See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/get.ts)_
394
+ _See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/get.ts)_
333
395
 
334
396
  ## `knock guide list`
335
397
 
@@ -353,7 +415,31 @@ GLOBAL FLAGS
353
415
  --json Format output as json.
354
416
  ```
355
417
 
356
- _See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/list.ts)_
418
+ _See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/list.ts)_
419
+
420
+ ## `knock guide new`
421
+
422
+ Create a new guide with a minimal configuration.
423
+
424
+ ```
425
+ USAGE
426
+ $ knock guide new [--service-token <value>] [-n <value>] [-k <value>] [-m <value>] [--environment <value>]
427
+ [--branch <value>] [--force] [-p] [-t <value>]
428
+
429
+ FLAGS
430
+ -k, --key=<value> The key of the guide
431
+ -m, --message-type=<value> The message type key to use for the guide. You cannot use this flag with --template.
432
+ -n, --name=<value> The name of the guide
433
+ -p, --push Whether or not to push the guide to Knock after creation.
434
+ -t, --template=<value> The template to use for the guide. Should be `guides/{key}`. You cannot use this flag
435
+ with --message-type.
436
+ --branch=<value> The slug of the branch to use.
437
+ --environment=<value> [default: development] The environment to create the guide in. Defaults to development.
438
+ --force Force the creation of the guide directory without confirmation.
439
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
440
+ ```
441
+
442
+ _See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/new.ts)_
357
443
 
358
444
  ## `knock guide pull [GUIDEKEY]`
359
445
 
@@ -374,7 +460,7 @@ FLAGS
374
460
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
375
461
  ```
376
462
 
377
- _See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/pull.ts)_
463
+ _See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/pull.ts)_
378
464
 
379
465
  ## `knock guide push [GUIDEKEY]`
380
466
 
@@ -395,7 +481,7 @@ FLAGS
395
481
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
396
482
  ```
397
483
 
398
- _See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/push.ts)_
484
+ _See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/push.ts)_
399
485
 
400
486
  ## `knock guide validate [GUIDEKEY]`
401
487
 
@@ -414,7 +500,7 @@ FLAGS
414
500
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
415
501
  ```
416
502
 
417
- _See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/guide/validate.ts)_
503
+ _See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/guide/validate.ts)_
418
504
 
419
505
  ## `knock help [COMMAND]`
420
506
 
@@ -434,7 +520,27 @@ DESCRIPTION
434
520
  Display help for knock.
435
521
  ```
436
522
 
437
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.35/src/commands/help.ts)_
523
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
524
+
525
+ ## `knock init`
526
+
527
+ Initialize a new Knock project with a knock.json configuration file.
528
+
529
+ ```
530
+ USAGE
531
+ $ knock init [--service-token <value>]
532
+
533
+ FLAGS
534
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
535
+
536
+ DESCRIPTION
537
+ Initialize a new Knock project with a knock.json configuration file.
538
+
539
+ Creates a knock.json configuration file in the current directory to store project-level settings like the knock
540
+ resources directory.
541
+ ```
542
+
543
+ _See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/init.ts)_
438
544
 
439
545
  ## `knock layout get EMAILLAYOUTKEY`
440
546
 
@@ -455,7 +561,7 @@ GLOBAL FLAGS
455
561
  --json Format output as json.
456
562
  ```
457
563
 
458
- _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/layout/get.ts)_
564
+ _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/get.ts)_
459
565
 
460
566
  ## `knock layout list`
461
567
 
@@ -479,7 +585,30 @@ GLOBAL FLAGS
479
585
  --json Format output as json.
480
586
  ```
481
587
 
482
- _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/layout/list.ts)_
588
+ _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/list.ts)_
589
+
590
+ ## `knock layout new`
591
+
592
+ Create a new email layout with a minimal configuration.
593
+
594
+ ```
595
+ USAGE
596
+ $ knock layout new [--service-token <value>] [-n <value>] [-k <value>] [--environment <value>] [--branch
597
+ <value>] [--force] [-p] [--template <value>]
598
+
599
+ FLAGS
600
+ -k, --key=<value> The key of the email layout
601
+ -n, --name=<value> The name of the email layout
602
+ -p, --push Whether or not to push the email layout to Knock after creation.
603
+ --branch=<value> The slug of the branch to use.
604
+ --environment=<value> [default: development] The environment to create the email layout in. Defaults to
605
+ development.
606
+ --force Force the creation of the email layout directory without confirmation.
607
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
608
+ --template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
609
+ ```
610
+
611
+ _See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/new.ts)_
483
612
 
484
613
  ## `knock layout pull [EMAILLAYOUTKEY]`
485
614
 
@@ -500,7 +629,7 @@ FLAGS
500
629
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
501
630
  ```
502
631
 
503
- _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/layout/pull.ts)_
632
+ _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/pull.ts)_
504
633
 
505
634
  ## `knock layout push [EMAILLAYOUTKEY]`
506
635
 
@@ -523,7 +652,7 @@ FLAGS
523
652
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
524
653
  ```
525
654
 
526
- _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/layout/push.ts)_
655
+ _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/push.ts)_
527
656
 
528
657
  ## `knock layout validate [EMAILLAYOUTKEY]`
529
658
 
@@ -543,7 +672,7 @@ FLAGS
543
672
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
544
673
  ```
545
674
 
546
- _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/layout/validate.ts)_
675
+ _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/layout/validate.ts)_
547
676
 
548
677
  ## `knock login`
549
678
 
@@ -557,7 +686,7 @@ FLAGS
557
686
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
558
687
  ```
559
688
 
560
- _See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/login.ts)_
689
+ _See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/login.ts)_
561
690
 
562
691
  ## `knock logout`
563
692
 
@@ -571,7 +700,7 @@ FLAGS
571
700
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
572
701
  ```
573
702
 
574
- _See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/logout.ts)_
703
+ _See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/logout.ts)_
575
704
 
576
705
  ## `knock message-type get MESSAGETYPEKEY`
577
706
 
@@ -592,7 +721,7 @@ GLOBAL FLAGS
592
721
  --json Format output as json.
593
722
  ```
594
723
 
595
- _See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/message-type/get.ts)_
724
+ _See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/get.ts)_
596
725
 
597
726
  ## `knock message-type list`
598
727
 
@@ -616,7 +745,30 @@ GLOBAL FLAGS
616
745
  --json Format output as json.
617
746
  ```
618
747
 
619
- _See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/message-type/list.ts)_
748
+ _See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/list.ts)_
749
+
750
+ ## `knock message-type new`
751
+
752
+ Create a new message type with a minimal configuration.
753
+
754
+ ```
755
+ USAGE
756
+ $ knock message-type new [--service-token <value>] [-n <value>] [-k <value>] [--environment <value>] [--branch
757
+ <value>] [--force] [-p] [--template <value>]
758
+
759
+ FLAGS
760
+ -k, --key=<value> The key of the message type
761
+ -n, --name=<value> The name of the message type
762
+ -p, --push Whether or not to push the message type to Knock after creation.
763
+ --branch=<value> The slug of the branch to use.
764
+ --environment=<value> [default: development] The environment to create the message type in. Defaults to
765
+ development.
766
+ --force Force the creation of the message type directory without confirmation.
767
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
768
+ --template=<value> The template to use for the message type. Should be `message-types/{key}`.
769
+ ```
770
+
771
+ _See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/new.ts)_
620
772
 
621
773
  ## `knock message-type pull [MESSAGETYPEKEY]`
622
774
 
@@ -637,7 +789,7 @@ FLAGS
637
789
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
638
790
  ```
639
791
 
640
- _See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/message-type/pull.ts)_
792
+ _See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/pull.ts)_
641
793
 
642
794
  ## `knock message-type push [MESSAGETYPEKEY]`
643
795
 
@@ -660,7 +812,7 @@ FLAGS
660
812
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
661
813
  ```
662
814
 
663
- _See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/message-type/push.ts)_
815
+ _See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/push.ts)_
664
816
 
665
817
  ## `knock message-type validate [MESSAGETYPEKEY]`
666
818
 
@@ -681,7 +833,7 @@ FLAGS
681
833
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
682
834
  ```
683
835
 
684
- _See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/message-type/validate.ts)_
836
+ _See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/message-type/validate.ts)_
685
837
 
686
838
  ## `knock partial get PARTIALKEY`
687
839
 
@@ -702,7 +854,7 @@ GLOBAL FLAGS
702
854
  --json Format output as json.
703
855
  ```
704
856
 
705
- _See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/partial/get.ts)_
857
+ _See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/get.ts)_
706
858
 
707
859
  ## `knock partial list`
708
860
 
@@ -726,7 +878,33 @@ GLOBAL FLAGS
726
878
  --json Format output as json.
727
879
  ```
728
880
 
729
- _See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/partial/list.ts)_
881
+ _See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/list.ts)_
882
+
883
+ ## `knock partial new`
884
+
885
+ Create a new partial with a minimal configuration.
886
+
887
+ ```
888
+ USAGE
889
+ $ knock partial new [--service-token <value>] [-n <value>] [-k <value>] [-t html|json|markdown|text]
890
+ [--environment <value>] [--branch <value>] [--force] [-p] [--template <value>]
891
+
892
+ FLAGS
893
+ -k, --key=<value> The key of the partial
894
+ -n, --name=<value> The name of the partial
895
+ -p, --push Whether or not to push the partial to Knock after creation.
896
+ -t, --type=<option> The type of the partial (html, json, markdown, text). You cannot use this flag with
897
+ --template.
898
+ <options: html|json|markdown|text>
899
+ --branch=<value> The slug of the branch to use.
900
+ --environment=<value> [default: development] The environment to create the partial in. Defaults to development.
901
+ --force Force the creation of the partial directory without confirmation.
902
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
903
+ --template=<value> The template to use for the partial. Should be `partials/{key}`. You cannot use this flag
904
+ with --type.
905
+ ```
906
+
907
+ _See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/new.ts)_
730
908
 
731
909
  ## `knock partial pull [PARTIALKEY]`
732
910
 
@@ -747,7 +925,7 @@ FLAGS
747
925
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
748
926
  ```
749
927
 
750
- _See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/partial/pull.ts)_
928
+ _See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/pull.ts)_
751
929
 
752
930
  ## `knock partial push [PARTIALKEY]`
753
931
 
@@ -769,7 +947,7 @@ FLAGS
769
947
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
770
948
  ```
771
949
 
772
- _See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/partial/push.ts)_
950
+ _See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/push.ts)_
773
951
 
774
952
  ## `knock partial validate [PARTIALKEY]`
775
953
 
@@ -789,7 +967,7 @@ FLAGS
789
967
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
790
968
  ```
791
969
 
792
- _See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/partial/validate.ts)_
970
+ _See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/partial/validate.ts)_
793
971
 
794
972
  ## `knock pull`
795
973
 
@@ -797,7 +975,7 @@ Pull all resources from an environment into a local file system.
797
975
 
798
976
  ```
799
977
  USAGE
800
- $ knock pull --knock-dir <value> [--service-token <value>] [--environment <value>] [--branch <value>]
978
+ $ knock pull [--service-token <value>] [--environment <value>] [--branch <value>] [--knock-dir <value>]
801
979
  [--hide-uncommitted-changes] [--force]
802
980
 
803
981
  FLAGS
@@ -805,11 +983,11 @@ FLAGS
805
983
  --environment=<value> [default: development] The environment to use.
806
984
  --force Remove the confirmation prompt.
807
985
  --hide-uncommitted-changes Hide any uncommitted changes.
808
- --knock-dir=<value> (required) The target directory path to pull all resources into.
986
+ --knock-dir=<value> The target directory path to pull all resources into.
809
987
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
810
988
  ```
811
989
 
812
- _See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/pull.ts)_
990
+ _See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/pull.ts)_
813
991
 
814
992
  ## `knock push`
815
993
 
@@ -817,7 +995,7 @@ Push all resources from a local file system to Knock.
817
995
 
818
996
  ```
819
997
  USAGE
820
- $ knock push --knock-dir <value> [--service-token <value>] [--environment development] [--branch
998
+ $ knock push [--service-token <value>] [--environment development] [--branch <value>] [--knock-dir
821
999
  <value>] [-m <value> --commit]
822
1000
 
823
1001
  FLAGS
@@ -826,11 +1004,11 @@ FLAGS
826
1004
  --commit Push and commit the resource(s) at the same time
827
1005
  --environment=<option> [default: development] Pushing resources is only allowed in the development environment
828
1006
  <options: development>
829
- --knock-dir=<value> (required) The target directory path to find all resources to push.
1007
+ --knock-dir=<value> The target directory path to find all resources to push.
830
1008
  --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
831
1009
  ```
832
1010
 
833
- _See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/push.ts)_
1011
+ _See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/push.ts)_
834
1012
 
835
1013
  ## `knock translation get TRANSLATIONREF`
836
1014
 
@@ -858,7 +1036,7 @@ GLOBAL FLAGS
858
1036
  --json Format output as json.
859
1037
  ```
860
1038
 
861
- _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/translation/get.ts)_
1039
+ _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/translation/get.ts)_
862
1040
 
863
1041
  ## `knock translation list`
864
1042
 
@@ -882,7 +1060,7 @@ GLOBAL FLAGS
882
1060
  --json Format output as json.
883
1061
  ```
884
1062
 
885
- _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/translation/list.ts)_
1063
+ _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/translation/list.ts)_
886
1064
 
887
1065
  ## `knock translation pull [TRANSLATIONREF]`
888
1066
 
@@ -910,7 +1088,7 @@ FLAGS
910
1088
  --translations-dir=<value> The target directory path to pull all translations into.
911
1089
  ```
912
1090
 
913
- _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/translation/pull.ts)_
1091
+ _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/translation/pull.ts)_
914
1092
 
915
1093
  ## `knock translation push [TRANSLATIONREF]`
916
1094
 
@@ -938,7 +1116,7 @@ FLAGS
938
1116
  --translations-dir=<value> The target directory path to find all translations to push.
939
1117
  ```
940
1118
 
941
- _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/translation/push.ts)_
1119
+ _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/translation/push.ts)_
942
1120
 
943
1121
  ## `knock translation validate [TRANSLATIONREF]`
944
1122
 
@@ -964,7 +1142,7 @@ FLAGS
964
1142
  --translations-dir=<value> The target directory path to find all translations to validate.
965
1143
  ```
966
1144
 
967
- _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/translation/validate.ts)_
1145
+ _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/translation/validate.ts)_
968
1146
 
969
1147
  ## `knock whoami`
970
1148
 
@@ -981,7 +1159,7 @@ GLOBAL FLAGS
981
1159
  --json Format output as json.
982
1160
  ```
983
1161
 
984
- _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/whoami.ts)_
1162
+ _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/whoami.ts)_
985
1163
 
986
1164
  ## `knock workflow activate WORKFLOWKEY`
987
1165
 
@@ -1010,7 +1188,7 @@ DESCRIPTION
1010
1188
  with `false` in order to deactivate it.
1011
1189
  ```
1012
1190
 
1013
- _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/activate.ts)_
1191
+ _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/activate.ts)_
1014
1192
 
1015
1193
  ## `knock workflow generate-types`
1016
1194
 
@@ -1033,7 +1211,7 @@ DESCRIPTION
1033
1211
  Generate types for all workflows in an environment and write them to a file.
1034
1212
  ```
1035
1213
 
1036
- _See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/generate-types.ts)_
1214
+ _See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/generate-types.ts)_
1037
1215
 
1038
1216
  ## `knock workflow get WORKFLOWKEY`
1039
1217
 
@@ -1054,7 +1232,7 @@ GLOBAL FLAGS
1054
1232
  --json Format output as json.
1055
1233
  ```
1056
1234
 
1057
- _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/get.ts)_
1235
+ _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/get.ts)_
1058
1236
 
1059
1237
  ## `knock workflow list`
1060
1238
 
@@ -1078,7 +1256,32 @@ GLOBAL FLAGS
1078
1256
  --json Format output as json.
1079
1257
  ```
1080
1258
 
1081
- _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/list.ts)_
1259
+ _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/list.ts)_
1260
+
1261
+ ## `knock workflow new`
1262
+
1263
+ Create a new workflow with a minimal configuration.
1264
+
1265
+ ```
1266
+ USAGE
1267
+ $ knock workflow new [--service-token <value>] [-n <value>] [-k <value>] [-s <value>] [--environment <value>]
1268
+ [--branch <value>] [--force] [-p] [-t <value>]
1269
+
1270
+ FLAGS
1271
+ -k, --key=<value> The key of the workflow
1272
+ -n, --name=<value> The name of the workflow
1273
+ -p, --push Whether or not to push the workflow to Knock after creation.
1274
+ -s, --steps=<value> Comma-separated list of step types to include in the workflow
1275
+ -t, --template=<value> The template repository to use for the workflow. Should be `workflows/{type}`. You cannot
1276
+ use this flag with --steps.
1277
+ --branch=<value> The slug of the branch to use.
1278
+ --environment=<value> [default: development] The environment to create the workflow in. Defaults to
1279
+ development.
1280
+ --force Force the creation of the workflow directory without confirmation.
1281
+ --service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
1282
+ ```
1283
+
1284
+ _See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/new.ts)_
1082
1285
 
1083
1286
  ## `knock workflow pull [WORKFLOWKEY]`
1084
1287
 
@@ -1099,7 +1302,7 @@ FLAGS
1099
1302
  --workflows-dir=<value> The target directory path to pull all workflows into.
1100
1303
  ```
1101
1304
 
1102
- _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/pull.ts)_
1305
+ _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/pull.ts)_
1103
1306
 
1104
1307
  ## `knock workflow push [WORKFLOWKEY]`
1105
1308
 
@@ -1120,7 +1323,7 @@ FLAGS
1120
1323
  --workflows-dir=<value> The target directory path to find all workflows to push.
1121
1324
  ```
1122
1325
 
1123
- _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/push.ts)_
1326
+ _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/push.ts)_
1124
1327
 
1125
1328
  ## `knock workflow run WORKFLOWKEY`
1126
1329
 
@@ -1142,7 +1345,7 @@ FLAGS
1142
1345
  --tenant=<value> A tenant id for the workflow run.
1143
1346
  ```
1144
1347
 
1145
- _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/run.ts)_
1348
+ _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/run.ts)_
1146
1349
 
1147
1350
  ## `knock workflow validate [WORKFLOWKEY]`
1148
1351
 
@@ -1161,5 +1364,5 @@ FLAGS
1161
1364
  --workflows-dir=<value> The target directory path to find all workflows to validate.
1162
1365
  ```
1163
1366
 
1164
- _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.3.1/src/commands/workflow/validate.ts)_
1367
+ _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0-rc.1/src/commands/workflow/validate.ts)_
1165
1368
  <!-- commandsstop -->