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