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