@knocklabs/cli 0.1.23 → 0.2.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.1.23 linux-x64 node-v18.20.8
19
+ @knocklabs/cli/0.2.1 linux-x64 node-v18.20.8
20
20
  $ knock --help [COMMAND]
21
21
  USAGE
22
22
  $ knock COMMAND
@@ -39,6 +39,8 @@ USAGE
39
39
  * [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
40
40
  * [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
41
41
  * [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
42
+ * [`knock login`](#knock-login)
43
+ * [`knock logout`](#knock-logout)
42
44
  * [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
43
45
  * [`knock partial list`](#knock-partial-list)
44
46
  * [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
@@ -67,7 +69,7 @@ Commit all changes in development environment.
67
69
 
68
70
  ```
69
71
  USAGE
70
- $ knock commit --service-token <value> [--environment development] [-m <value>] [--force]
72
+ $ knock commit [--service-token <value>] [--environment development] [-m <value>] [--force]
71
73
 
72
74
  FLAGS
73
75
  -m, --commit-message=<value> Use the given value as the commit message.
@@ -75,10 +77,10 @@ FLAGS
75
77
  use `commit promote` to promote changes to a subsequent environment.
76
78
  <options: development>
77
79
  --force Remove the confirmation prompt.
78
- --service-token=<value> (required) The service token to authenticate with.
80
+ --service-token=<value> The service token to authenticate with.
79
81
  ```
80
82
 
81
- _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/commit/index.ts)_
83
+ _See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/index.ts)_
82
84
 
83
85
  ## `knock commit get ID`
84
86
 
@@ -86,16 +88,16 @@ Display a single commit
86
88
 
87
89
  ```
88
90
  USAGE
89
- $ knock commit get ID --service-token <value> [--json]
91
+ $ knock commit get ID [--json] [--service-token <value>]
90
92
 
91
93
  FLAGS
92
- --service-token=<value> (required) The service token to authenticate with.
94
+ --service-token=<value> The service token to authenticate with.
93
95
 
94
96
  GLOBAL FLAGS
95
97
  --json Format output as json.
96
98
  ```
97
99
 
98
- _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/commit/get.ts)_
100
+ _See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/get.ts)_
99
101
 
100
102
  ## `knock commit list`
101
103
 
@@ -103,7 +105,7 @@ Display all commits in an environment
103
105
 
104
106
  ```
105
107
  USAGE
106
- $ knock commit list --service-token <value> [--json] [--environment <value>] [--promoted] [--resource-type
108
+ $ knock commit list [--json] [--service-token <value>] [--environment <value>] [--promoted] [--resource-type
107
109
  email_layout|guide|message_type|partial|translation|workflow] [--resource-id <value>] [--after <value>] [--before
108
110
  <value>] [--limit <value>]
109
111
 
@@ -119,13 +121,13 @@ FLAGS
119
121
  locale code and namespace, separated by a /. For example, en/courses or en.
120
122
  --resource-type=<option> Filter commits by resource type. Must be used together with resource-id.
121
123
  <options: email_layout|guide|message_type|partial|translation|workflow>
122
- --service-token=<value> (required) The service token to authenticate with.
124
+ --service-token=<value> The service token to authenticate with.
123
125
 
124
126
  GLOBAL FLAGS
125
127
  --json Format output as json.
126
128
  ```
127
129
 
128
- _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/commit/list.ts)_
130
+ _See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/list.ts)_
129
131
 
130
132
  ## `knock commit promote`
131
133
 
@@ -133,16 +135,16 @@ Promote one or all commits to the subsequent environment.
133
135
 
134
136
  ```
135
137
  USAGE
136
- $ knock commit promote --service-token <value> [--to <value>] [--force] [--only <value>]
138
+ $ knock commit promote [--service-token <value>] [--to <value>] [--force] [--only <value>]
137
139
 
138
140
  FLAGS
139
141
  --force Remove the confirmation prompt.
140
142
  --only=<value> The target commit id to promote to the subsequent environment
141
- --service-token=<value> (required) The service token to authenticate with.
143
+ --service-token=<value> The service token to authenticate with.
142
144
  --to=<value> The destination environment to promote all changes from the preceding environment.
143
145
  ```
144
146
 
145
- _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/commit/promote.ts)_
147
+ _See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/commit/promote.ts)_
146
148
 
147
149
  ## `knock guide activate GUIDEKEY`
148
150
 
@@ -150,14 +152,14 @@ Activate or deactivate a guide in a given environment.
150
152
 
151
153
  ```
152
154
  USAGE
153
- $ knock guide activate GUIDEKEY --service-token <value> --environment <value> [--status true|false | --from
155
+ $ knock guide activate GUIDEKEY --environment <value> [--service-token <value>] [--status true|false | --from
154
156
  <value> | --until <value>] [--force]
155
157
 
156
158
  FLAGS
157
159
  --environment=<value> (required) The environment to use.
158
160
  --force Remove the confirmation prompt.
159
161
  --from=<value> Activate the guide from this ISO8601 UTC datetime (e.g., '2024-01-15T10:30:00Z').
160
- --service-token=<value> (required) The service token to authenticate with.
162
+ --service-token=<value> The service token to authenticate with.
161
163
  --status=<option> The guide active status to set. Cannot be used with --from/--until.
162
164
  <options: true|false>
163
165
  --until=<value> Deactivate the guide at this ISO8601 UTC datetime (e.g., '2024-01-15T18:30:00Z').
@@ -172,7 +174,7 @@ DESCRIPTION
172
174
  or deactivated at a later time using the --from and --until flags.
173
175
  ```
174
176
 
175
- _See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/guide/activate.ts)_
177
+ _See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/guide/activate.ts)_
176
178
 
177
179
  ## `knock guide generate-types`
178
180
 
@@ -180,20 +182,20 @@ Generate types for all guides in an environment and write them to a file.
180
182
 
181
183
  ```
182
184
  USAGE
183
- $ knock guide generate-types --service-token <value> --output-file <value> [--environment <value>]
185
+ $ knock guide generate-types --output-file <value> [--service-token <value>] [--environment <value>]
184
186
 
185
187
  FLAGS
186
188
  --environment=<value> [default: development] Select the environment to generate types for.
187
189
  --output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .py,
188
190
  .go, .rb files only. Your file extension will determine the target language for the generated
189
191
  types.
190
- --service-token=<value> (required) The service token to authenticate with.
192
+ --service-token=<value> The service token to authenticate with.
191
193
 
192
194
  DESCRIPTION
193
195
  Generate types for all guides in an environment and write them to a file.
194
196
  ```
195
197
 
196
- _See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/guide/generate-types.ts)_
198
+ _See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/guide/generate-types.ts)_
197
199
 
198
200
  ## `knock help [COMMAND]`
199
201
 
@@ -221,19 +223,19 @@ Display a single email layout from an environment.
221
223
 
222
224
  ```
223
225
  USAGE
224
- $ knock layout get EMAILLAYOUTKEY --service-token <value> [--json] [--environment <value>]
226
+ $ knock layout get EMAILLAYOUTKEY [--json] [--service-token <value>] [--environment <value>]
225
227
  [--hide-uncommitted-changes]
226
228
 
227
229
  FLAGS
228
230
  --environment=<value> [default: development] The environment to use.
229
231
  --hide-uncommitted-changes Hide any uncommitted changes.
230
- --service-token=<value> (required) The service token to authenticate with.
232
+ --service-token=<value> The service token to authenticate with.
231
233
 
232
234
  GLOBAL FLAGS
233
235
  --json Format output as json.
234
236
  ```
235
237
 
236
- _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/layout/get.ts)_
238
+ _See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/get.ts)_
237
239
 
238
240
  ## `knock layout list`
239
241
 
@@ -241,7 +243,7 @@ Display all email layouts for an environment.
241
243
 
242
244
  ```
243
245
  USAGE
244
- $ knock layout list --service-token <value> [--json] [--environment <value>] [--hide-uncommitted-changes]
246
+ $ knock layout list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
245
247
  [--after <value>] [--before <value>] [--limit <value>]
246
248
 
247
249
  FLAGS
@@ -250,13 +252,13 @@ FLAGS
250
252
  --environment=<value> [default: development] The environment to use.
251
253
  --hide-uncommitted-changes Hide any uncommitted changes.
252
254
  --limit=<value> The total number of entries to fetch per page.
253
- --service-token=<value> (required) The service token to authenticate with.
255
+ --service-token=<value> The service token to authenticate with.
254
256
 
255
257
  GLOBAL FLAGS
256
258
  --json Format output as json.
257
259
  ```
258
260
 
259
- _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/layout/list.ts)_
261
+ _See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/list.ts)_
260
262
 
261
263
  ## `knock layout pull [EMAILLAYOUTKEY]`
262
264
 
@@ -264,7 +266,7 @@ Pull one or more email layouts from an environment into a local file system.
264
266
 
265
267
  ```
266
268
  USAGE
267
- $ knock layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
269
+ $ knock layout pull [EMAILLAYOUTKEY] [--service-token <value>] [--environment <value>] [--layouts-dir <value>
268
270
  --all] [--hide-uncommitted-changes] [--force]
269
271
 
270
272
  FLAGS
@@ -273,10 +275,10 @@ FLAGS
273
275
  --force Remove the confirmation prompt.
274
276
  --hide-uncommitted-changes Hide any uncommitted changes.
275
277
  --layouts-dir=<value> The target directory path to pull all email layouts into.
276
- --service-token=<value> (required) The service token to authenticate with.
278
+ --service-token=<value> The service token to authenticate with.
277
279
  ```
278
280
 
279
- _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/layout/pull.ts)_
281
+ _See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/pull.ts)_
280
282
 
281
283
  ## `knock layout push [EMAILLAYOUTKEY]`
282
284
 
@@ -284,8 +286,8 @@ Push one or more email layouts from a local file system to Knock.
284
286
 
285
287
  ```
286
288
  USAGE
287
- $ knock layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
288
- --all] [-m <value> --commit]
289
+ $ knock layout push [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--layouts-dir
290
+ <value> --all] [-m <value> --commit]
289
291
 
290
292
  FLAGS
291
293
  -m, --commit-message=<value> Use the given value as the commit message
@@ -295,10 +297,10 @@ FLAGS
295
297
  environment
296
298
  <options: development>
297
299
  --layouts-dir=<value> The target directory path to find all layouts to push.
298
- --service-token=<value> (required) The service token to authenticate with.
300
+ --service-token=<value> The service token to authenticate with.
299
301
  ```
300
302
 
301
- _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/layout/push.ts)_
303
+ _See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/push.ts)_
302
304
 
303
305
  ## `knock layout validate [EMAILLAYOUTKEY]`
304
306
 
@@ -306,18 +308,42 @@ Validate one or more layouts from a local file system.
306
308
 
307
309
  ```
308
310
  USAGE
309
- $ knock layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
310
- --all]
311
+ $ knock layout validate [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--layouts-dir
312
+ <value> --all]
311
313
 
312
314
  FLAGS
313
315
  --all Whether to validate all layouts from the target directory.
314
316
  --environment=<option> [default: development] Validating a layout is only done in the development environment
315
317
  <options: development>
316
318
  --layouts-dir=<value> The target directory path to find all layouts to validate.
317
- --service-token=<value> (required) The service token to authenticate with.
319
+ --service-token=<value> The service token to authenticate with.
320
+ ```
321
+
322
+ _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/layout/validate.ts)_
323
+
324
+ ## `knock login`
325
+
326
+ ```
327
+ USAGE
328
+ $ knock login [--service-token <value>]
329
+
330
+ FLAGS
331
+ --service-token=<value> The service token to authenticate with.
332
+ ```
333
+
334
+ _See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/login.ts)_
335
+
336
+ ## `knock logout`
337
+
338
+ ```
339
+ USAGE
340
+ $ knock logout [--service-token <value>]
341
+
342
+ FLAGS
343
+ --service-token=<value> The service token to authenticate with.
318
344
  ```
319
345
 
320
- _See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/layout/validate.ts)_
346
+ _See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/logout.ts)_
321
347
 
322
348
  ## `knock partial get PARTIALKEY`
323
349
 
@@ -325,19 +351,19 @@ Display a single partial from an environment.
325
351
 
326
352
  ```
327
353
  USAGE
328
- $ knock partial get PARTIALKEY --service-token <value> [--json] [--environment <value>]
354
+ $ knock partial get PARTIALKEY [--json] [--service-token <value>] [--environment <value>]
329
355
  [--hide-uncommitted-changes]
330
356
 
331
357
  FLAGS
332
358
  --environment=<value> [default: development] The environment to use.
333
359
  --hide-uncommitted-changes Hide any uncommitted changes.
334
- --service-token=<value> (required) The service token to authenticate with.
360
+ --service-token=<value> The service token to authenticate with.
335
361
 
336
362
  GLOBAL FLAGS
337
363
  --json Format output as json.
338
364
  ```
339
365
 
340
- _See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/partial/get.ts)_
366
+ _See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/get.ts)_
341
367
 
342
368
  ## `knock partial list`
343
369
 
@@ -345,7 +371,7 @@ Display all partials for an environment.
345
371
 
346
372
  ```
347
373
  USAGE
348
- $ knock partial list --service-token <value> [--json] [--environment <value>] [--hide-uncommitted-changes]
374
+ $ knock partial list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
349
375
  [--after <value>] [--before <value>] [--limit <value>]
350
376
 
351
377
  FLAGS
@@ -354,13 +380,13 @@ FLAGS
354
380
  --environment=<value> [default: development] The environment to use.
355
381
  --hide-uncommitted-changes Hide any uncommitted changes.
356
382
  --limit=<value> The total number of entries to fetch per page.
357
- --service-token=<value> (required) The service token to authenticate with.
383
+ --service-token=<value> The service token to authenticate with.
358
384
 
359
385
  GLOBAL FLAGS
360
386
  --json Format output as json.
361
387
  ```
362
388
 
363
- _See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/partial/list.ts)_
389
+ _See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/list.ts)_
364
390
 
365
391
  ## `knock partial pull [PARTIALKEY]`
366
392
 
@@ -368,8 +394,8 @@ Pull one or more partial from an environment into a local file system.
368
394
 
369
395
  ```
370
396
  USAGE
371
- $ knock partial pull [PARTIALKEY] --service-token <value> [--environment <value>] [--partials-dir <value> --all]
372
- [--hide-uncommitted-changes] [--force]
397
+ $ knock partial pull [PARTIALKEY] [--service-token <value>] [--environment <value>] [--partials-dir <value>
398
+ --all] [--hide-uncommitted-changes] [--force]
373
399
 
374
400
  FLAGS
375
401
  --all Whether to pull all partials from the specified environment.
@@ -377,10 +403,10 @@ FLAGS
377
403
  --force Remove the confirmation prompt.
378
404
  --hide-uncommitted-changes Hide any uncommitted changes.
379
405
  --partials-dir=<value> The target directory path to pull all partials into.
380
- --service-token=<value> (required) The service token to authenticate with.
406
+ --service-token=<value> The service token to authenticate with.
381
407
  ```
382
408
 
383
- _See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/partial/pull.ts)_
409
+ _See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/pull.ts)_
384
410
 
385
411
  ## `knock partial push [PARTIALKEY]`
386
412
 
@@ -388,7 +414,7 @@ Push one or more partials from a local file system to Knock.
388
414
 
389
415
  ```
390
416
  USAGE
391
- $ knock partial push [PARTIALKEY] --service-token <value> [--environment development] [--partials-dir <value>
417
+ $ knock partial push [PARTIALKEY] [--service-token <value>] [--environment development] [--partials-dir <value>
392
418
  --all] [-m <value> --commit]
393
419
 
394
420
  FLAGS
@@ -398,10 +424,10 @@ FLAGS
398
424
  --environment=<option> [default: development] Pushing a partial is only allowed in the development environment
399
425
  <options: development>
400
426
  --partials-dir=<value> The target directory path to find all partials to push.
401
- --service-token=<value> (required) The service token to authenticate with.
427
+ --service-token=<value> The service token to authenticate with.
402
428
  ```
403
429
 
404
- _See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/partial/push.ts)_
430
+ _See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/push.ts)_
405
431
 
406
432
  ## `knock partial validate [PARTIALKEY]`
407
433
 
@@ -409,7 +435,7 @@ Validate one or more partials from a local file system.
409
435
 
410
436
  ```
411
437
  USAGE
412
- $ knock partial validate [PARTIALKEY] --service-token <value> [--environment development] [--partials-dir <value>
438
+ $ knock partial validate [PARTIALKEY] [--service-token <value>] [--environment development] [--partials-dir <value>
413
439
  --all]
414
440
 
415
441
  FLAGS
@@ -417,10 +443,10 @@ FLAGS
417
443
  --environment=<option> [default: development] Validating a partial is only done in the development environment
418
444
  <options: development>
419
445
  --partials-dir=<value> The target directory path to find all partials to validate.
420
- --service-token=<value> (required) The service token to authenticate with.
446
+ --service-token=<value> The service token to authenticate with.
421
447
  ```
422
448
 
423
- _See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/partial/validate.ts)_
449
+ _See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/partial/validate.ts)_
424
450
 
425
451
  ## `knock pull`
426
452
 
@@ -428,7 +454,7 @@ Pull all resources from an environment into a local file system.
428
454
 
429
455
  ```
430
456
  USAGE
431
- $ knock pull --service-token <value> --knock-dir <value> [--environment <value>]
457
+ $ knock pull --knock-dir <value> [--service-token <value>] [--environment <value>]
432
458
  [--hide-uncommitted-changes] [--force]
433
459
 
434
460
  FLAGS
@@ -436,10 +462,10 @@ FLAGS
436
462
  --force Remove the confirmation prompt.
437
463
  --hide-uncommitted-changes Hide any uncommitted changes.
438
464
  --knock-dir=<value> (required) The target directory path to pull all resources into.
439
- --service-token=<value> (required) The service token to authenticate with.
465
+ --service-token=<value> The service token to authenticate with.
440
466
  ```
441
467
 
442
- _See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/pull.ts)_
468
+ _See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/pull.ts)_
443
469
 
444
470
  ## `knock push`
445
471
 
@@ -447,7 +473,7 @@ Push all resources from a local file system to Knock.
447
473
 
448
474
  ```
449
475
  USAGE
450
- $ knock push --service-token <value> --knock-dir <value> [--environment development] [-m <value>
476
+ $ knock push --knock-dir <value> [--service-token <value>] [--environment development] [-m <value>
451
477
  --commit]
452
478
 
453
479
  FLAGS
@@ -456,10 +482,10 @@ FLAGS
456
482
  --environment=<option> [default: development] Pushing resources is only allowed in the development environment
457
483
  <options: development>
458
484
  --knock-dir=<value> (required) The target directory path to find all resources to push.
459
- --service-token=<value> (required) The service token to authenticate with.
485
+ --service-token=<value> The service token to authenticate with.
460
486
  ```
461
487
 
462
- _See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/push.ts)_
488
+ _See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/push.ts)_
463
489
 
464
490
  ## `knock translation get TRANSLATIONREF`
465
491
 
@@ -467,7 +493,7 @@ Display a single translation from an environment.
467
493
 
468
494
  ```
469
495
  USAGE
470
- $ knock translation get TRANSLATIONREF --service-token <value> [--json] [--environment <value>]
496
+ $ knock translation get TRANSLATIONREF [--json] [--service-token <value>] [--environment <value>]
471
497
  [--hide-uncommitted-changes] [--format json|po]
472
498
 
473
499
  ARGUMENTS
@@ -480,13 +506,13 @@ FLAGS
480
506
  --format=<option> [default: json] Specify the output format of the returned translations.
481
507
  <options: json|po>
482
508
  --hide-uncommitted-changes Hide any uncommitted changes.
483
- --service-token=<value> (required) The service token to authenticate with.
509
+ --service-token=<value> The service token to authenticate with.
484
510
 
485
511
  GLOBAL FLAGS
486
512
  --json Format output as json.
487
513
  ```
488
514
 
489
- _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/translation/get.ts)_
515
+ _See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/get.ts)_
490
516
 
491
517
  ## `knock translation list`
492
518
 
@@ -494,7 +520,7 @@ Display all translations for an environment.
494
520
 
495
521
  ```
496
522
  USAGE
497
- $ knock translation list --service-token <value> [--json] [--environment <value>] [--hide-uncommitted-changes]
523
+ $ knock translation list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
498
524
  [--after <value>] [--before <value>] [--limit <value>]
499
525
 
500
526
  FLAGS
@@ -503,13 +529,13 @@ FLAGS
503
529
  --environment=<value> [default: development] The environment to use.
504
530
  --hide-uncommitted-changes Hide any uncommitted changes.
505
531
  --limit=<value> The total number of entries to fetch per page.
506
- --service-token=<value> (required) The service token to authenticate with.
532
+ --service-token=<value> The service token to authenticate with.
507
533
 
508
534
  GLOBAL FLAGS
509
535
  --json Format output as json.
510
536
  ```
511
537
 
512
- _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/translation/list.ts)_
538
+ _See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/list.ts)_
513
539
 
514
540
  ## `knock translation pull [TRANSLATIONREF]`
515
541
 
@@ -517,7 +543,7 @@ Pull one or more translations from an environment into a local file system.
517
543
 
518
544
  ```
519
545
  USAGE
520
- $ knock translation pull [TRANSLATIONREF] --service-token <value> [--environment <value>] [--translations-dir
546
+ $ knock translation pull [TRANSLATIONREF] [--service-token <value>] [--environment <value>] [--translations-dir
521
547
  <value> --all] [--hide-uncommitted-changes] [--force] [--format json|po]
522
548
 
523
549
  ARGUMENTS
@@ -532,11 +558,11 @@ FLAGS
532
558
  --format=<option> [default: json] Specify the output format of the returned translations.
533
559
  <options: json|po>
534
560
  --hide-uncommitted-changes Hide any uncommitted changes.
535
- --service-token=<value> (required) The service token to authenticate with.
561
+ --service-token=<value> The service token to authenticate with.
536
562
  --translations-dir=<value> The target directory path to pull all translations into.
537
563
  ```
538
564
 
539
- _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/translation/pull.ts)_
565
+ _See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/pull.ts)_
540
566
 
541
567
  ## `knock translation push [TRANSLATIONREF]`
542
568
 
@@ -544,7 +570,7 @@ Push one or more translations from a local file system to Knock.
544
570
 
545
571
  ```
546
572
  USAGE
547
- $ knock translation push [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
573
+ $ knock translation push [TRANSLATIONREF] [--service-token <value>] [--environment development] [--translations-dir
548
574
  <value> --all] [-m <value> --commit]
549
575
 
550
576
  ARGUMENTS
@@ -559,11 +585,11 @@ FLAGS
559
585
  --environment=<option> [default: development] Pushing a translation is only allowed in the development
560
586
  environment
561
587
  <options: development>
562
- --service-token=<value> (required) The service token to authenticate with.
588
+ --service-token=<value> The service token to authenticate with.
563
589
  --translations-dir=<value> The target directory path to find all translations to push.
564
590
  ```
565
591
 
566
- _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/translation/push.ts)_
592
+ _See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/push.ts)_
567
593
 
568
594
  ## `knock translation validate [TRANSLATIONREF]`
569
595
 
@@ -571,7 +597,7 @@ Validate one or more translations from a local file system.
571
597
 
572
598
  ```
573
599
  USAGE
574
- $ knock translation validate [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
600
+ $ knock translation validate [TRANSLATIONREF] [--service-token <value>] [--environment development] [--translations-dir
575
601
  <value> --all]
576
602
 
577
603
  ARGUMENTS
@@ -584,11 +610,11 @@ FLAGS
584
610
  --environment=<option> [default: development] Validating a translation is only done in the development
585
611
  environment
586
612
  <options: development>
587
- --service-token=<value> (required) The service token to authenticate with.
613
+ --service-token=<value> The service token to authenticate with.
588
614
  --translations-dir=<value> The target directory path to find all translations to validate.
589
615
  ```
590
616
 
591
- _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/translation/validate.ts)_
617
+ _See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/translation/validate.ts)_
592
618
 
593
619
  ## `knock whoami`
594
620
 
@@ -596,16 +622,16 @@ Verify the provided service token.
596
622
 
597
623
  ```
598
624
  USAGE
599
- $ knock whoami --service-token <value> [--json]
625
+ $ knock whoami [--json] [--service-token <value>]
600
626
 
601
627
  FLAGS
602
- --service-token=<value> (required) The service token to authenticate with.
628
+ --service-token=<value> The service token to authenticate with.
603
629
 
604
630
  GLOBAL FLAGS
605
631
  --json Format output as json.
606
632
  ```
607
633
 
608
- _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/whoami.ts)_
634
+ _See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/whoami.ts)_
609
635
 
610
636
  ## `knock workflow activate WORKFLOWKEY`
611
637
 
@@ -613,12 +639,12 @@ Activate or deactivate a workflow in a given environment.
613
639
 
614
640
  ```
615
641
  USAGE
616
- $ knock workflow activate WORKFLOWKEY --service-token <value> --environment <value> [--status true|false] [--force]
642
+ $ knock workflow activate WORKFLOWKEY --environment <value> [--service-token <value>] [--status true|false] [--force]
617
643
 
618
644
  FLAGS
619
645
  --environment=<value> (required) The environment to use.
620
646
  --force Remove the confirmation prompt.
621
- --service-token=<value> (required) The service token to authenticate with.
647
+ --service-token=<value> The service token to authenticate with.
622
648
  --status=<option> [default: true] The workflow active status to set.
623
649
  <options: true|false>
624
650
 
@@ -632,7 +658,7 @@ DESCRIPTION
632
658
  with `false` in order to deactivate it.
633
659
  ```
634
660
 
635
- _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/activate.ts)_
661
+ _See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/activate.ts)_
636
662
 
637
663
  ## `knock workflow generate-types`
638
664
 
@@ -640,20 +666,20 @@ Generate types for all workflows in an environment and write them to a file.
640
666
 
641
667
  ```
642
668
  USAGE
643
- $ knock workflow generate-types --service-token <value> --output-file <value> [--environment <value>]
669
+ $ knock workflow generate-types --output-file <value> [--service-token <value>] [--environment <value>]
644
670
 
645
671
  FLAGS
646
672
  --environment=<value> [default: development] Select the environment to generate types for.
647
673
  --output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .rb,
648
674
  .go, .py files only. Your file extension will determine the target language for the generated
649
675
  types.
650
- --service-token=<value> (required) The service token to authenticate with.
676
+ --service-token=<value> The service token to authenticate with.
651
677
 
652
678
  DESCRIPTION
653
679
  Generate types for all workflows in an environment and write them to a file.
654
680
  ```
655
681
 
656
- _See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/generate-types.ts)_
682
+ _See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/generate-types.ts)_
657
683
 
658
684
  ## `knock workflow get WORKFLOWKEY`
659
685
 
@@ -661,19 +687,19 @@ Display a single workflow from an environment.
661
687
 
662
688
  ```
663
689
  USAGE
664
- $ knock workflow get WORKFLOWKEY --service-token <value> [--json] [--environment <value>]
690
+ $ knock workflow get WORKFLOWKEY [--json] [--service-token <value>] [--environment <value>]
665
691
  [--hide-uncommitted-changes]
666
692
 
667
693
  FLAGS
668
694
  --environment=<value> [default: development] The environment to use.
669
695
  --hide-uncommitted-changes Hide any uncommitted changes.
670
- --service-token=<value> (required) The service token to authenticate with.
696
+ --service-token=<value> The service token to authenticate with.
671
697
 
672
698
  GLOBAL FLAGS
673
699
  --json Format output as json.
674
700
  ```
675
701
 
676
- _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/get.ts)_
702
+ _See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/get.ts)_
677
703
 
678
704
  ## `knock workflow list`
679
705
 
@@ -681,7 +707,7 @@ Display all workflows for an environment.
681
707
 
682
708
  ```
683
709
  USAGE
684
- $ knock workflow list --service-token <value> [--json] [--environment <value>] [--hide-uncommitted-changes]
710
+ $ knock workflow list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
685
711
  [--after <value>] [--before <value>] [--limit <value>]
686
712
 
687
713
  FLAGS
@@ -690,13 +716,13 @@ FLAGS
690
716
  --environment=<value> [default: development] The environment to use.
691
717
  --hide-uncommitted-changes Hide any uncommitted changes.
692
718
  --limit=<value> The total number of entries to fetch per page.
693
- --service-token=<value> (required) The service token to authenticate with.
719
+ --service-token=<value> The service token to authenticate with.
694
720
 
695
721
  GLOBAL FLAGS
696
722
  --json Format output as json.
697
723
  ```
698
724
 
699
- _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/list.ts)_
725
+ _See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/list.ts)_
700
726
 
701
727
  ## `knock workflow pull [WORKFLOWKEY]`
702
728
 
@@ -704,7 +730,7 @@ Pull one or more workflows from an environment into a local file system.
704
730
 
705
731
  ```
706
732
  USAGE
707
- $ knock workflow pull [WORKFLOWKEY] --service-token <value> [--environment <value>] [--workflows-dir <value>
733
+ $ knock workflow pull [WORKFLOWKEY] [--service-token <value>] [--environment <value>] [--workflows-dir <value>
708
734
  --all] [--hide-uncommitted-changes] [--force]
709
735
 
710
736
  FLAGS
@@ -712,11 +738,11 @@ FLAGS
712
738
  --environment=<value> [default: development] The environment to use.
713
739
  --force Remove the confirmation prompt.
714
740
  --hide-uncommitted-changes Hide any uncommitted changes.
715
- --service-token=<value> (required) The service token to authenticate with.
741
+ --service-token=<value> The service token to authenticate with.
716
742
  --workflows-dir=<value> The target directory path to pull all workflows into.
717
743
  ```
718
744
 
719
- _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/pull.ts)_
745
+ _See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/pull.ts)_
720
746
 
721
747
  ## `knock workflow push [WORKFLOWKEY]`
722
748
 
@@ -724,8 +750,8 @@ Push one or more workflows from a local file system to Knock.
724
750
 
725
751
  ```
726
752
  USAGE
727
- $ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
728
- --all] [-m <value> --commit]
753
+ $ knock workflow push [WORKFLOWKEY] [--service-token <value>] [--environment development] [--workflows-dir
754
+ <value> --all] [-m <value> --commit]
729
755
 
730
756
  FLAGS
731
757
  -m, --commit-message=<value> Use the given value as the commit message
@@ -733,11 +759,11 @@ FLAGS
733
759
  --commit Push and commit the workflow(s) at the same time
734
760
  --environment=<option> [default: development] Pushing a workflow is only allowed in the development environment
735
761
  <options: development>
736
- --service-token=<value> (required) The service token to authenticate with.
762
+ --service-token=<value> The service token to authenticate with.
737
763
  --workflows-dir=<value> The target directory path to find all workflows to push.
738
764
  ```
739
765
 
740
- _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/push.ts)_
766
+ _See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/push.ts)_
741
767
 
742
768
  ## `knock workflow run WORKFLOWKEY`
743
769
 
@@ -745,7 +771,7 @@ Test run a workflow using the latest version from Knock.
745
771
 
746
772
  ```
747
773
  USAGE
748
- $ knock workflow run WORKFLOWKEY --service-token <value> --recipients <value> [--environment <value>] [--actor
774
+ $ knock workflow run WORKFLOWKEY --recipients <value> [--service-token <value>] [--environment <value>] [--actor
749
775
  <value>] [--tenant <value>] [--data <value>]
750
776
 
751
777
  FLAGS
@@ -754,11 +780,11 @@ FLAGS
754
780
  --environment=<value> [default: development] The environment in which to run the workflow
755
781
  --recipients=<value> (required) One or more recipient user ids separated by comma, or a JSON string containing one
756
782
  or more recipient object references for this workflow run.
757
- --service-token=<value> (required) The service token to authenticate with.
783
+ --service-token=<value> The service token to authenticate with.
758
784
  --tenant=<value> A tenant id for the workflow run.
759
785
  ```
760
786
 
761
- _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/run.ts)_
787
+ _See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/run.ts)_
762
788
 
763
789
  ## `knock workflow validate [WORKFLOWKEY]`
764
790
 
@@ -766,16 +792,16 @@ Validate one or more workflows from a local file system.
766
792
 
767
793
  ```
768
794
  USAGE
769
- $ knock workflow validate [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
770
- --all]
795
+ $ knock workflow validate [WORKFLOWKEY] [--service-token <value>] [--environment development] [--workflows-dir
796
+ <value> --all]
771
797
 
772
798
  FLAGS
773
799
  --all Whether to validate all workflows from the target directory.
774
800
  --environment=<option> [default: development] Validating a workflow is only done in the development environment
775
801
  <options: development>
776
- --service-token=<value> (required) The service token to authenticate with.
802
+ --service-token=<value> The service token to authenticate with.
777
803
  --workflows-dir=<value> The target directory path to find all workflows to validate.
778
804
  ```
779
805
 
780
- _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.23/src/commands/workflow/validate.ts)_
806
+ _See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.1/src/commands/workflow/validate.ts)_
781
807
  <!-- commandsstop -->