@knocklabs/cli 1.0.2 → 1.0.3
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 +104 -80
- package/dist/commands/audience/push.js +6 -1
- package/dist/commands/guide/push.js +2 -1
- package/dist/commands/layout/push.js +2 -1
- package/dist/commands/message-type/push.js +2 -1
- package/dist/commands/partial/push.js +2 -1
- package/dist/commands/push.js +5 -1
- package/dist/commands/translation/push.js +2 -1
- package/dist/commands/workflow/push.js +2 -1
- package/dist/lib/api-v1.js +12 -6
- package/dist/lib/helpers/flag.js +6 -0
- package/dist/lib/marshal/translation/helpers.js +2 -1
- package/dist/lib/marshal/translation/reader.js +1 -1
- package/dist/lib/run-context/loader.js +0 -3
- package/oclif.manifest.json +222 -174
- package/package.json +3 -3
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/1.0.
|
|
19
|
+
@knocklabs/cli/1.0.3 linux-x64 node-v22.22.1
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -125,7 +125,7 @@ DESCRIPTION
|
|
|
125
125
|
Use this command with caution.
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
-
_See code: [src/commands/audience/archive.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
128
|
+
_See code: [src/commands/audience/archive.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/archive.ts)_
|
|
129
129
|
|
|
130
130
|
## `knock audience get AUDIENCEKEY`
|
|
131
131
|
|
|
@@ -146,7 +146,7 @@ GLOBAL FLAGS
|
|
|
146
146
|
--json Format output as json.
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
_See code: [src/commands/audience/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
149
|
+
_See code: [src/commands/audience/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/get.ts)_
|
|
150
150
|
|
|
151
151
|
## `knock audience list`
|
|
152
152
|
|
|
@@ -170,7 +170,7 @@ GLOBAL FLAGS
|
|
|
170
170
|
--json Format output as json.
|
|
171
171
|
```
|
|
172
172
|
|
|
173
|
-
_See code: [src/commands/audience/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
173
|
+
_See code: [src/commands/audience/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/list.ts)_
|
|
174
174
|
|
|
175
175
|
## `knock audience new`
|
|
176
176
|
|
|
@@ -195,7 +195,7 @@ FLAGS
|
|
|
195
195
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
_See code: [src/commands/audience/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
198
|
+
_See code: [src/commands/audience/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/new.ts)_
|
|
199
199
|
|
|
200
200
|
## `knock audience open AUDIENCEKEY`
|
|
201
201
|
|
|
@@ -211,7 +211,7 @@ FLAGS
|
|
|
211
211
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
212
212
|
```
|
|
213
213
|
|
|
214
|
-
_See code: [src/commands/audience/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
214
|
+
_See code: [src/commands/audience/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/open.ts)_
|
|
215
215
|
|
|
216
216
|
## `knock audience pull [AUDIENCEKEY]`
|
|
217
217
|
|
|
@@ -232,7 +232,7 @@ FLAGS
|
|
|
232
232
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
233
233
|
```
|
|
234
234
|
|
|
235
|
-
_See code: [src/commands/audience/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
235
|
+
_See code: [src/commands/audience/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/pull.ts)_
|
|
236
236
|
|
|
237
237
|
## `knock audience push [AUDIENCEKEY]`
|
|
238
238
|
|
|
@@ -241,7 +241,7 @@ Push one or more audiences from a local file system to Knock.
|
|
|
241
241
|
```
|
|
242
242
|
USAGE
|
|
243
243
|
$ knock audience push [AUDIENCEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
244
|
-
[--audiences-dir <value> --all] [-m <value> --commit]
|
|
244
|
+
[--audiences-dir <value> --all] [-m <value> --commit] [--force]
|
|
245
245
|
|
|
246
246
|
FLAGS
|
|
247
247
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -250,10 +250,13 @@ FLAGS
|
|
|
250
250
|
--branch=<value> The slug of the branch to use.
|
|
251
251
|
--commit Push and commit the audience(s) at the same time
|
|
252
252
|
--environment=<value> [default: development] The environment to push the audience to. Defaults to development.
|
|
253
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
254
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
255
|
+
you `commit` the changes.
|
|
253
256
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
254
257
|
```
|
|
255
258
|
|
|
256
|
-
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
259
|
+
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/push.ts)_
|
|
257
260
|
|
|
258
261
|
## `knock audience validate [AUDIENCEKEY]`
|
|
259
262
|
|
|
@@ -273,7 +276,7 @@ FLAGS
|
|
|
273
276
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
274
277
|
```
|
|
275
278
|
|
|
276
|
-
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
279
|
+
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/validate.ts)_
|
|
277
280
|
|
|
278
281
|
## `knock branch create [SLUG]`
|
|
279
282
|
|
|
@@ -293,7 +296,7 @@ GLOBAL FLAGS
|
|
|
293
296
|
--json Format output as json.
|
|
294
297
|
```
|
|
295
298
|
|
|
296
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
299
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/create.ts)_
|
|
297
300
|
|
|
298
301
|
## `knock branch delete SLUG`
|
|
299
302
|
|
|
@@ -311,7 +314,7 @@ FLAGS
|
|
|
311
314
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
312
315
|
```
|
|
313
316
|
|
|
314
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
317
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/delete.ts)_
|
|
315
318
|
|
|
316
319
|
## `knock branch exit`
|
|
317
320
|
|
|
@@ -325,7 +328,7 @@ FLAGS
|
|
|
325
328
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
326
329
|
```
|
|
327
330
|
|
|
328
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
331
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/exit.ts)_
|
|
329
332
|
|
|
330
333
|
## `knock branch list`
|
|
331
334
|
|
|
@@ -345,7 +348,7 @@ GLOBAL FLAGS
|
|
|
345
348
|
--json Format output as json.
|
|
346
349
|
```
|
|
347
350
|
|
|
348
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
351
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/list.ts)_
|
|
349
352
|
|
|
350
353
|
## `knock branch merge SLUG`
|
|
351
354
|
|
|
@@ -364,7 +367,7 @@ FLAGS
|
|
|
364
367
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
365
368
|
```
|
|
366
369
|
|
|
367
|
-
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
370
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/merge.ts)_
|
|
368
371
|
|
|
369
372
|
## `knock branch switch SLUG`
|
|
370
373
|
|
|
@@ -383,7 +386,7 @@ FLAGS
|
|
|
383
386
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
384
387
|
```
|
|
385
388
|
|
|
386
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
389
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/switch.ts)_
|
|
387
390
|
|
|
388
391
|
## `knock channel list`
|
|
389
392
|
|
|
@@ -400,7 +403,7 @@ GLOBAL FLAGS
|
|
|
400
403
|
--json Format output as json.
|
|
401
404
|
```
|
|
402
405
|
|
|
403
|
-
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
406
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/channel/list.ts)_
|
|
404
407
|
|
|
405
408
|
## `knock commit`
|
|
406
409
|
|
|
@@ -421,7 +424,7 @@ FLAGS
|
|
|
421
424
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
422
425
|
```
|
|
423
426
|
|
|
424
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
427
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/index.ts)_
|
|
425
428
|
|
|
426
429
|
## `knock commit get ID`
|
|
427
430
|
|
|
@@ -438,7 +441,7 @@ GLOBAL FLAGS
|
|
|
438
441
|
--json Format output as json.
|
|
439
442
|
```
|
|
440
443
|
|
|
441
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
444
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/get.ts)_
|
|
442
445
|
|
|
443
446
|
## `knock commit list`
|
|
444
447
|
|
|
@@ -470,7 +473,7 @@ GLOBAL FLAGS
|
|
|
470
473
|
--json Format output as json.
|
|
471
474
|
```
|
|
472
475
|
|
|
473
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
476
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/list.ts)_
|
|
474
477
|
|
|
475
478
|
## `knock commit promote`
|
|
476
479
|
|
|
@@ -487,7 +490,7 @@ FLAGS
|
|
|
487
490
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
488
491
|
```
|
|
489
492
|
|
|
490
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
493
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/promote.ts)_
|
|
491
494
|
|
|
492
495
|
## `knock environment list`
|
|
493
496
|
|
|
@@ -504,7 +507,7 @@ GLOBAL FLAGS
|
|
|
504
507
|
--json Format output as json.
|
|
505
508
|
```
|
|
506
509
|
|
|
507
|
-
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
510
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/environment/list.ts)_
|
|
508
511
|
|
|
509
512
|
## `knock guide activate GUIDEKEY`
|
|
510
513
|
|
|
@@ -535,7 +538,7 @@ DESCRIPTION
|
|
|
535
538
|
or deactivated at a later time using the --from and --until flags.
|
|
536
539
|
```
|
|
537
540
|
|
|
538
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
541
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/activate.ts)_
|
|
539
542
|
|
|
540
543
|
## `knock guide generate-types`
|
|
541
544
|
|
|
@@ -558,7 +561,7 @@ DESCRIPTION
|
|
|
558
561
|
Generate types for all guides in an environment and write them to a file.
|
|
559
562
|
```
|
|
560
563
|
|
|
561
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
564
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/generate-types.ts)_
|
|
562
565
|
|
|
563
566
|
## `knock guide get GUIDEKEY`
|
|
564
567
|
|
|
@@ -579,7 +582,7 @@ GLOBAL FLAGS
|
|
|
579
582
|
--json Format output as json.
|
|
580
583
|
```
|
|
581
584
|
|
|
582
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
585
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/get.ts)_
|
|
583
586
|
|
|
584
587
|
## `knock guide list`
|
|
585
588
|
|
|
@@ -603,7 +606,7 @@ GLOBAL FLAGS
|
|
|
603
606
|
--json Format output as json.
|
|
604
607
|
```
|
|
605
608
|
|
|
606
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
609
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/list.ts)_
|
|
607
610
|
|
|
608
611
|
## `knock guide new`
|
|
609
612
|
|
|
@@ -627,7 +630,7 @@ FLAGS
|
|
|
627
630
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
628
631
|
```
|
|
629
632
|
|
|
630
|
-
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
633
|
+
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/new.ts)_
|
|
631
634
|
|
|
632
635
|
## `knock guide open GUIDEKEY`
|
|
633
636
|
|
|
@@ -643,7 +646,7 @@ FLAGS
|
|
|
643
646
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
644
647
|
```
|
|
645
648
|
|
|
646
|
-
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
649
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/open.ts)_
|
|
647
650
|
|
|
648
651
|
## `knock guide pull [GUIDEKEY]`
|
|
649
652
|
|
|
@@ -664,7 +667,7 @@ FLAGS
|
|
|
664
667
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
665
668
|
```
|
|
666
669
|
|
|
667
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
670
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/pull.ts)_
|
|
668
671
|
|
|
669
672
|
## `knock guide push [GUIDEKEY]`
|
|
670
673
|
|
|
@@ -673,7 +676,7 @@ Push one or more guides from a local file system to Knock.
|
|
|
673
676
|
```
|
|
674
677
|
USAGE
|
|
675
678
|
$ knock guide push [GUIDEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
676
|
-
[--guides-dir <value> --all] [-m <value> --commit]
|
|
679
|
+
[--guides-dir <value> --all] [-m <value> --commit] [--force]
|
|
677
680
|
|
|
678
681
|
FLAGS
|
|
679
682
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -681,11 +684,14 @@ FLAGS
|
|
|
681
684
|
--branch=<value> The slug of the branch to use.
|
|
682
685
|
--commit Push and commit the guide(s) at the same time
|
|
683
686
|
--environment=<value> [default: development] The environment to push the guide to. Defaults to development.
|
|
687
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
688
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
689
|
+
you `commit` the changes.
|
|
684
690
|
--guides-dir=<value> The target directory path to find all guides to push.
|
|
685
691
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
686
692
|
```
|
|
687
693
|
|
|
688
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
694
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/push.ts)_
|
|
689
695
|
|
|
690
696
|
## `knock guide validate [GUIDEKEY]`
|
|
691
697
|
|
|
@@ -704,7 +710,7 @@ FLAGS
|
|
|
704
710
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
705
711
|
```
|
|
706
712
|
|
|
707
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
713
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/validate.ts)_
|
|
708
714
|
|
|
709
715
|
## `knock help [COMMAND]`
|
|
710
716
|
|
|
@@ -744,7 +750,7 @@ DESCRIPTION
|
|
|
744
750
|
resources directory.
|
|
745
751
|
```
|
|
746
752
|
|
|
747
|
-
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
753
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/init.ts)_
|
|
748
754
|
|
|
749
755
|
## `knock layout get EMAILLAYOUTKEY`
|
|
750
756
|
|
|
@@ -765,7 +771,7 @@ GLOBAL FLAGS
|
|
|
765
771
|
--json Format output as json.
|
|
766
772
|
```
|
|
767
773
|
|
|
768
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
774
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/get.ts)_
|
|
769
775
|
|
|
770
776
|
## `knock layout list`
|
|
771
777
|
|
|
@@ -789,7 +795,7 @@ GLOBAL FLAGS
|
|
|
789
795
|
--json Format output as json.
|
|
790
796
|
```
|
|
791
797
|
|
|
792
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
798
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/list.ts)_
|
|
793
799
|
|
|
794
800
|
## `knock layout new`
|
|
795
801
|
|
|
@@ -812,7 +818,7 @@ FLAGS
|
|
|
812
818
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
813
819
|
```
|
|
814
820
|
|
|
815
|
-
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
821
|
+
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/new.ts)_
|
|
816
822
|
|
|
817
823
|
## `knock layout open LAYOUTKEY`
|
|
818
824
|
|
|
@@ -828,7 +834,7 @@ FLAGS
|
|
|
828
834
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
829
835
|
```
|
|
830
836
|
|
|
831
|
-
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
837
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/open.ts)_
|
|
832
838
|
|
|
833
839
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
834
840
|
|
|
@@ -849,7 +855,7 @@ FLAGS
|
|
|
849
855
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
850
856
|
```
|
|
851
857
|
|
|
852
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
858
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/pull.ts)_
|
|
853
859
|
|
|
854
860
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
855
861
|
|
|
@@ -858,7 +864,7 @@ Push one or more email layouts from a local file system to Knock.
|
|
|
858
864
|
```
|
|
859
865
|
USAGE
|
|
860
866
|
$ knock layout push [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
861
|
-
[--layouts-dir <value> --all] [-m <value> --commit]
|
|
867
|
+
[--layouts-dir <value> --all] [-m <value> --commit] [--force]
|
|
862
868
|
|
|
863
869
|
FLAGS
|
|
864
870
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -868,11 +874,14 @@ FLAGS
|
|
|
868
874
|
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
869
875
|
environment
|
|
870
876
|
<options: development>
|
|
877
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
878
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
879
|
+
you `commit` the changes.
|
|
871
880
|
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
872
881
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
873
882
|
```
|
|
874
883
|
|
|
875
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
884
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/push.ts)_
|
|
876
885
|
|
|
877
886
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
878
887
|
|
|
@@ -892,7 +901,7 @@ FLAGS
|
|
|
892
901
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
893
902
|
```
|
|
894
903
|
|
|
895
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
904
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/validate.ts)_
|
|
896
905
|
|
|
897
906
|
## `knock login`
|
|
898
907
|
|
|
@@ -906,7 +915,7 @@ FLAGS
|
|
|
906
915
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
907
916
|
```
|
|
908
917
|
|
|
909
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
918
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/login.ts)_
|
|
910
919
|
|
|
911
920
|
## `knock logout`
|
|
912
921
|
|
|
@@ -920,7 +929,7 @@ FLAGS
|
|
|
920
929
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
921
930
|
```
|
|
922
931
|
|
|
923
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
932
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/logout.ts)_
|
|
924
933
|
|
|
925
934
|
## `knock message-type get MESSAGETYPEKEY`
|
|
926
935
|
|
|
@@ -941,7 +950,7 @@ GLOBAL FLAGS
|
|
|
941
950
|
--json Format output as json.
|
|
942
951
|
```
|
|
943
952
|
|
|
944
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
953
|
+
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/get.ts)_
|
|
945
954
|
|
|
946
955
|
## `knock message-type list`
|
|
947
956
|
|
|
@@ -965,7 +974,7 @@ GLOBAL FLAGS
|
|
|
965
974
|
--json Format output as json.
|
|
966
975
|
```
|
|
967
976
|
|
|
968
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
977
|
+
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/list.ts)_
|
|
969
978
|
|
|
970
979
|
## `knock message-type new`
|
|
971
980
|
|
|
@@ -988,7 +997,7 @@ FLAGS
|
|
|
988
997
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
989
998
|
```
|
|
990
999
|
|
|
991
|
-
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1000
|
+
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/new.ts)_
|
|
992
1001
|
|
|
993
1002
|
## `knock message-type open MESSAGETYPEKEY`
|
|
994
1003
|
|
|
@@ -1004,7 +1013,7 @@ FLAGS
|
|
|
1004
1013
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1005
1014
|
```
|
|
1006
1015
|
|
|
1007
|
-
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1016
|
+
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/open.ts)_
|
|
1008
1017
|
|
|
1009
1018
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
1010
1019
|
|
|
@@ -1025,7 +1034,7 @@ FLAGS
|
|
|
1025
1034
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1026
1035
|
```
|
|
1027
1036
|
|
|
1028
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1037
|
+
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/pull.ts)_
|
|
1029
1038
|
|
|
1030
1039
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
1031
1040
|
|
|
@@ -1034,7 +1043,7 @@ Push one or more message types from a local file system to Knock.
|
|
|
1034
1043
|
```
|
|
1035
1044
|
USAGE
|
|
1036
1045
|
$ knock message-type push [MESSAGETYPEKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1037
|
-
[--message-types-dir <value> --all] [-m <value> --commit]
|
|
1046
|
+
[--message-types-dir <value> --all] [-m <value> --commit] [--force]
|
|
1038
1047
|
|
|
1039
1048
|
FLAGS
|
|
1040
1049
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1044,11 +1053,14 @@ FLAGS
|
|
|
1044
1053
|
--environment=<option> [default: development] Pushing a message type is only allowed in the development
|
|
1045
1054
|
environment
|
|
1046
1055
|
<options: development>
|
|
1056
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1057
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1058
|
+
you `commit` the changes.
|
|
1047
1059
|
--message-types-dir=<value> The target directory path to find all message types to push.
|
|
1048
1060
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1049
1061
|
```
|
|
1050
1062
|
|
|
1051
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1063
|
+
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/push.ts)_
|
|
1052
1064
|
|
|
1053
1065
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
1054
1066
|
|
|
@@ -1069,7 +1081,7 @@ FLAGS
|
|
|
1069
1081
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1070
1082
|
```
|
|
1071
1083
|
|
|
1072
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1084
|
+
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/validate.ts)_
|
|
1073
1085
|
|
|
1074
1086
|
## `knock partial get PARTIALKEY`
|
|
1075
1087
|
|
|
@@ -1090,7 +1102,7 @@ GLOBAL FLAGS
|
|
|
1090
1102
|
--json Format output as json.
|
|
1091
1103
|
```
|
|
1092
1104
|
|
|
1093
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1105
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/get.ts)_
|
|
1094
1106
|
|
|
1095
1107
|
## `knock partial list`
|
|
1096
1108
|
|
|
@@ -1114,7 +1126,7 @@ GLOBAL FLAGS
|
|
|
1114
1126
|
--json Format output as json.
|
|
1115
1127
|
```
|
|
1116
1128
|
|
|
1117
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1129
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/list.ts)_
|
|
1118
1130
|
|
|
1119
1131
|
## `knock partial new`
|
|
1120
1132
|
|
|
@@ -1140,7 +1152,7 @@ FLAGS
|
|
|
1140
1152
|
with --type.
|
|
1141
1153
|
```
|
|
1142
1154
|
|
|
1143
|
-
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1155
|
+
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/new.ts)_
|
|
1144
1156
|
|
|
1145
1157
|
## `knock partial open PARTIALKEY`
|
|
1146
1158
|
|
|
@@ -1156,7 +1168,7 @@ FLAGS
|
|
|
1156
1168
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1157
1169
|
```
|
|
1158
1170
|
|
|
1159
|
-
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1171
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/open.ts)_
|
|
1160
1172
|
|
|
1161
1173
|
## `knock partial pull [PARTIALKEY]`
|
|
1162
1174
|
|
|
@@ -1177,7 +1189,7 @@ FLAGS
|
|
|
1177
1189
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1178
1190
|
```
|
|
1179
1191
|
|
|
1180
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1192
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/pull.ts)_
|
|
1181
1193
|
|
|
1182
1194
|
## `knock partial push [PARTIALKEY]`
|
|
1183
1195
|
|
|
@@ -1186,7 +1198,7 @@ Push one or more partials from a local file system to Knock.
|
|
|
1186
1198
|
```
|
|
1187
1199
|
USAGE
|
|
1188
1200
|
$ knock partial push [PARTIALKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1189
|
-
[--partials-dir <value> --all] [-m <value> --commit]
|
|
1201
|
+
[--partials-dir <value> --all] [-m <value> --commit] [--force]
|
|
1190
1202
|
|
|
1191
1203
|
FLAGS
|
|
1192
1204
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1195,11 +1207,14 @@ FLAGS
|
|
|
1195
1207
|
--commit Push and commit the partial(s) at the same time
|
|
1196
1208
|
--environment=<option> [default: development] Pushing a partial is only allowed in the development environment
|
|
1197
1209
|
<options: development>
|
|
1210
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1211
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1212
|
+
you `commit` the changes.
|
|
1198
1213
|
--partials-dir=<value> The target directory path to find all partials to push.
|
|
1199
1214
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1200
1215
|
```
|
|
1201
1216
|
|
|
1202
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1217
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/push.ts)_
|
|
1203
1218
|
|
|
1204
1219
|
## `knock partial validate [PARTIALKEY]`
|
|
1205
1220
|
|
|
@@ -1219,7 +1234,7 @@ FLAGS
|
|
|
1219
1234
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1220
1235
|
```
|
|
1221
1236
|
|
|
1222
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1237
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/validate.ts)_
|
|
1223
1238
|
|
|
1224
1239
|
## `knock pull`
|
|
1225
1240
|
|
|
@@ -1239,7 +1254,7 @@ FLAGS
|
|
|
1239
1254
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1240
1255
|
```
|
|
1241
1256
|
|
|
1242
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1257
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/pull.ts)_
|
|
1243
1258
|
|
|
1244
1259
|
## `knock push`
|
|
1245
1260
|
|
|
@@ -1248,7 +1263,7 @@ Push all resources from a local file system to Knock.
|
|
|
1248
1263
|
```
|
|
1249
1264
|
USAGE
|
|
1250
1265
|
$ knock push [--service-token <value>] [--environment development] [--branch <value>] [--knock-dir
|
|
1251
|
-
<value>] [-m <value> --commit]
|
|
1266
|
+
<value>] [-m <value> --commit] [--force]
|
|
1252
1267
|
|
|
1253
1268
|
FLAGS
|
|
1254
1269
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1256,11 +1271,14 @@ FLAGS
|
|
|
1256
1271
|
--commit Push and commit the resource(s) at the same time
|
|
1257
1272
|
--environment=<option> [default: development] Pushing resources is only allowed in the development environment
|
|
1258
1273
|
<options: development>
|
|
1274
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1275
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1276
|
+
you `commit` the changes.
|
|
1259
1277
|
--knock-dir=<value> The target directory path to find all resources to push.
|
|
1260
1278
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1261
1279
|
```
|
|
1262
1280
|
|
|
1263
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1281
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/push.ts)_
|
|
1264
1282
|
|
|
1265
1283
|
## `knock translation get TRANSLATIONREF`
|
|
1266
1284
|
|
|
@@ -1288,7 +1306,7 @@ GLOBAL FLAGS
|
|
|
1288
1306
|
--json Format output as json.
|
|
1289
1307
|
```
|
|
1290
1308
|
|
|
1291
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1309
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/get.ts)_
|
|
1292
1310
|
|
|
1293
1311
|
## `knock translation list`
|
|
1294
1312
|
|
|
@@ -1312,7 +1330,7 @@ GLOBAL FLAGS
|
|
|
1312
1330
|
--json Format output as json.
|
|
1313
1331
|
```
|
|
1314
1332
|
|
|
1315
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1333
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/list.ts)_
|
|
1316
1334
|
|
|
1317
1335
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1318
1336
|
|
|
@@ -1340,7 +1358,7 @@ FLAGS
|
|
|
1340
1358
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1341
1359
|
```
|
|
1342
1360
|
|
|
1343
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1361
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/pull.ts)_
|
|
1344
1362
|
|
|
1345
1363
|
## `knock translation push [TRANSLATIONREF]`
|
|
1346
1364
|
|
|
@@ -1349,7 +1367,7 @@ Push one or more translations from a local file system to Knock.
|
|
|
1349
1367
|
```
|
|
1350
1368
|
USAGE
|
|
1351
1369
|
$ knock translation push [TRANSLATIONREF] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1352
|
-
[--translations-dir <value> --all] [-m <value> --commit]
|
|
1370
|
+
[--translations-dir <value> --all] [-m <value> --commit] [--force]
|
|
1353
1371
|
|
|
1354
1372
|
ARGUMENTS
|
|
1355
1373
|
[TRANSLATIONREF] Translation ref is a identifier string that refers to a unique translation.
|
|
@@ -1364,11 +1382,14 @@ FLAGS
|
|
|
1364
1382
|
--environment=<option> [default: development] Pushing a translation is only allowed in the development
|
|
1365
1383
|
environment
|
|
1366
1384
|
<options: development>
|
|
1385
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1386
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1387
|
+
you `commit` the changes.
|
|
1367
1388
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1368
1389
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1369
1390
|
```
|
|
1370
1391
|
|
|
1371
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1392
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/push.ts)_
|
|
1372
1393
|
|
|
1373
1394
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1374
1395
|
|
|
@@ -1394,7 +1415,7 @@ FLAGS
|
|
|
1394
1415
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1395
1416
|
```
|
|
1396
1417
|
|
|
1397
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1418
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/validate.ts)_
|
|
1398
1419
|
|
|
1399
1420
|
## `knock whoami`
|
|
1400
1421
|
|
|
@@ -1411,7 +1432,7 @@ GLOBAL FLAGS
|
|
|
1411
1432
|
--json Format output as json.
|
|
1412
1433
|
```
|
|
1413
1434
|
|
|
1414
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1435
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/whoami.ts)_
|
|
1415
1436
|
|
|
1416
1437
|
## `knock workflow activate WORKFLOWKEY`
|
|
1417
1438
|
|
|
@@ -1440,7 +1461,7 @@ DESCRIPTION
|
|
|
1440
1461
|
with `false` in order to deactivate it.
|
|
1441
1462
|
```
|
|
1442
1463
|
|
|
1443
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1464
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/activate.ts)_
|
|
1444
1465
|
|
|
1445
1466
|
## `knock workflow generate-types`
|
|
1446
1467
|
|
|
@@ -1463,7 +1484,7 @@ DESCRIPTION
|
|
|
1463
1484
|
Generate types for all workflows in an environment and write them to a file.
|
|
1464
1485
|
```
|
|
1465
1486
|
|
|
1466
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1487
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/generate-types.ts)_
|
|
1467
1488
|
|
|
1468
1489
|
## `knock workflow get WORKFLOWKEY`
|
|
1469
1490
|
|
|
@@ -1484,7 +1505,7 @@ GLOBAL FLAGS
|
|
|
1484
1505
|
--json Format output as json.
|
|
1485
1506
|
```
|
|
1486
1507
|
|
|
1487
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1508
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/get.ts)_
|
|
1488
1509
|
|
|
1489
1510
|
## `knock workflow list`
|
|
1490
1511
|
|
|
@@ -1508,7 +1529,7 @@ GLOBAL FLAGS
|
|
|
1508
1529
|
--json Format output as json.
|
|
1509
1530
|
```
|
|
1510
1531
|
|
|
1511
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1532
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/list.ts)_
|
|
1512
1533
|
|
|
1513
1534
|
## `knock workflow new`
|
|
1514
1535
|
|
|
@@ -1533,7 +1554,7 @@ FLAGS
|
|
|
1533
1554
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1534
1555
|
```
|
|
1535
1556
|
|
|
1536
|
-
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1557
|
+
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/new.ts)_
|
|
1537
1558
|
|
|
1538
1559
|
## `knock workflow open WORKFLOWKEY`
|
|
1539
1560
|
|
|
@@ -1549,7 +1570,7 @@ FLAGS
|
|
|
1549
1570
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1550
1571
|
```
|
|
1551
1572
|
|
|
1552
|
-
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1573
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/open.ts)_
|
|
1553
1574
|
|
|
1554
1575
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1555
1576
|
|
|
@@ -1570,7 +1591,7 @@ FLAGS
|
|
|
1570
1591
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1571
1592
|
```
|
|
1572
1593
|
|
|
1573
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1594
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/pull.ts)_
|
|
1574
1595
|
|
|
1575
1596
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1576
1597
|
|
|
@@ -1579,7 +1600,7 @@ Push one or more workflows from a local file system to Knock.
|
|
|
1579
1600
|
```
|
|
1580
1601
|
USAGE
|
|
1581
1602
|
$ knock workflow push [WORKFLOWKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1582
|
-
[--workflows-dir <value> --all] [-m <value> --commit]
|
|
1603
|
+
[--workflows-dir <value> --all] [-m <value> --commit] [--force]
|
|
1583
1604
|
|
|
1584
1605
|
FLAGS
|
|
1585
1606
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1587,11 +1608,14 @@ FLAGS
|
|
|
1587
1608
|
--branch=<value> The slug of the branch to use.
|
|
1588
1609
|
--commit Push and commit the workflow(s) at the same time
|
|
1589
1610
|
--environment=<value> [default: development] The environment to push the workflow to. Defaults to development.
|
|
1611
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1612
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1613
|
+
you `commit` the changes.
|
|
1590
1614
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1591
1615
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1592
1616
|
```
|
|
1593
1617
|
|
|
1594
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1618
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/push.ts)_
|
|
1595
1619
|
|
|
1596
1620
|
## `knock workflow run WORKFLOWKEY`
|
|
1597
1621
|
|
|
@@ -1613,7 +1637,7 @@ FLAGS
|
|
|
1613
1637
|
--tenant=<value> A tenant id for the workflow run.
|
|
1614
1638
|
```
|
|
1615
1639
|
|
|
1616
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1640
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/run.ts)_
|
|
1617
1641
|
|
|
1618
1642
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1619
1643
|
|
|
@@ -1632,5 +1656,5 @@ FLAGS
|
|
|
1632
1656
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1633
1657
|
```
|
|
1634
1658
|
|
|
1635
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1659
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/validate.ts)_
|
|
1636
1660
|
<!-- commandsstop -->
|