@knocklabs/cli 1.0.0-rc.1 → 1.0.0
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 +144 -59
- package/dist/commands/guide/open.js +106 -0
- package/dist/commands/layout/open.js +106 -0
- package/dist/commands/message-type/open.js +106 -0
- package/dist/commands/partial/open.js +106 -0
- package/dist/commands/workflow/open.js +106 -0
- package/dist/lib/urls.js +16 -0
- package/oclif.manifest.json +630 -335
- package/package.json +2 -2
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.0
|
|
19
|
+
@knocklabs/cli/1.0.0 linux-x64 node-v18.20.8
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -44,6 +44,7 @@ USAGE
|
|
|
44
44
|
* [`knock guide get GUIDEKEY`](#knock-guide-get-guidekey)
|
|
45
45
|
* [`knock guide list`](#knock-guide-list)
|
|
46
46
|
* [`knock guide new`](#knock-guide-new)
|
|
47
|
+
* [`knock guide open GUIDEKEY`](#knock-guide-open-guidekey)
|
|
47
48
|
* [`knock guide pull [GUIDEKEY]`](#knock-guide-pull-guidekey)
|
|
48
49
|
* [`knock guide push [GUIDEKEY]`](#knock-guide-push-guidekey)
|
|
49
50
|
* [`knock guide validate [GUIDEKEY]`](#knock-guide-validate-guidekey)
|
|
@@ -52,6 +53,7 @@ USAGE
|
|
|
52
53
|
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
53
54
|
* [`knock layout list`](#knock-layout-list)
|
|
54
55
|
* [`knock layout new`](#knock-layout-new)
|
|
56
|
+
* [`knock layout open LAYOUTKEY`](#knock-layout-open-layoutkey)
|
|
55
57
|
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
56
58
|
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
57
59
|
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
@@ -60,12 +62,14 @@ USAGE
|
|
|
60
62
|
* [`knock message-type get MESSAGETYPEKEY`](#knock-message-type-get-messagetypekey)
|
|
61
63
|
* [`knock message-type list`](#knock-message-type-list)
|
|
62
64
|
* [`knock message-type new`](#knock-message-type-new)
|
|
65
|
+
* [`knock message-type open MESSAGETYPEKEY`](#knock-message-type-open-messagetypekey)
|
|
63
66
|
* [`knock message-type pull [MESSAGETYPEKEY]`](#knock-message-type-pull-messagetypekey)
|
|
64
67
|
* [`knock message-type push [MESSAGETYPEKEY]`](#knock-message-type-push-messagetypekey)
|
|
65
68
|
* [`knock message-type validate [MESSAGETYPEKEY]`](#knock-message-type-validate-messagetypekey)
|
|
66
69
|
* [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
|
|
67
70
|
* [`knock partial list`](#knock-partial-list)
|
|
68
71
|
* [`knock partial new`](#knock-partial-new)
|
|
72
|
+
* [`knock partial open PARTIALKEY`](#knock-partial-open-partialkey)
|
|
69
73
|
* [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
|
|
70
74
|
* [`knock partial push [PARTIALKEY]`](#knock-partial-push-partialkey)
|
|
71
75
|
* [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
|
|
@@ -82,6 +86,7 @@ USAGE
|
|
|
82
86
|
* [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
|
|
83
87
|
* [`knock workflow list`](#knock-workflow-list)
|
|
84
88
|
* [`knock workflow new`](#knock-workflow-new)
|
|
89
|
+
* [`knock workflow open WORKFLOWKEY`](#knock-workflow-open-workflowkey)
|
|
85
90
|
* [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
|
|
86
91
|
* [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
|
|
87
92
|
* [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
|
|
@@ -105,7 +110,7 @@ GLOBAL FLAGS
|
|
|
105
110
|
--json Format output as json.
|
|
106
111
|
```
|
|
107
112
|
|
|
108
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
113
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/create.ts)_
|
|
109
114
|
|
|
110
115
|
## `knock branch delete SLUG`
|
|
111
116
|
|
|
@@ -123,7 +128,7 @@ FLAGS
|
|
|
123
128
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
124
129
|
```
|
|
125
130
|
|
|
126
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
131
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/delete.ts)_
|
|
127
132
|
|
|
128
133
|
## `knock branch exit`
|
|
129
134
|
|
|
@@ -137,7 +142,7 @@ FLAGS
|
|
|
137
142
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
138
143
|
```
|
|
139
144
|
|
|
140
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
145
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/exit.ts)_
|
|
141
146
|
|
|
142
147
|
## `knock branch list`
|
|
143
148
|
|
|
@@ -157,7 +162,7 @@ GLOBAL FLAGS
|
|
|
157
162
|
--json Format output as json.
|
|
158
163
|
```
|
|
159
164
|
|
|
160
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
165
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/list.ts)_
|
|
161
166
|
|
|
162
167
|
## `knock branch merge SLUG`
|
|
163
168
|
|
|
@@ -176,7 +181,7 @@ FLAGS
|
|
|
176
181
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
177
182
|
```
|
|
178
183
|
|
|
179
|
-
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
184
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/merge.ts)_
|
|
180
185
|
|
|
181
186
|
## `knock branch switch SLUG`
|
|
182
187
|
|
|
@@ -195,7 +200,7 @@ FLAGS
|
|
|
195
200
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
196
201
|
```
|
|
197
202
|
|
|
198
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
203
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/switch.ts)_
|
|
199
204
|
|
|
200
205
|
## `knock channel list`
|
|
201
206
|
|
|
@@ -212,7 +217,7 @@ GLOBAL FLAGS
|
|
|
212
217
|
--json Format output as json.
|
|
213
218
|
```
|
|
214
219
|
|
|
215
|
-
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
220
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/channel/list.ts)_
|
|
216
221
|
|
|
217
222
|
## `knock commit`
|
|
218
223
|
|
|
@@ -233,7 +238,7 @@ FLAGS
|
|
|
233
238
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
234
239
|
```
|
|
235
240
|
|
|
236
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
241
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/index.ts)_
|
|
237
242
|
|
|
238
243
|
## `knock commit get ID`
|
|
239
244
|
|
|
@@ -250,7 +255,7 @@ GLOBAL FLAGS
|
|
|
250
255
|
--json Format output as json.
|
|
251
256
|
```
|
|
252
257
|
|
|
253
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
258
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/get.ts)_
|
|
254
259
|
|
|
255
260
|
## `knock commit list`
|
|
256
261
|
|
|
@@ -282,7 +287,7 @@ GLOBAL FLAGS
|
|
|
282
287
|
--json Format output as json.
|
|
283
288
|
```
|
|
284
289
|
|
|
285
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
290
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/list.ts)_
|
|
286
291
|
|
|
287
292
|
## `knock commit promote`
|
|
288
293
|
|
|
@@ -299,7 +304,7 @@ FLAGS
|
|
|
299
304
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
300
305
|
```
|
|
301
306
|
|
|
302
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
307
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/promote.ts)_
|
|
303
308
|
|
|
304
309
|
## `knock environment list`
|
|
305
310
|
|
|
@@ -316,7 +321,7 @@ GLOBAL FLAGS
|
|
|
316
321
|
--json Format output as json.
|
|
317
322
|
```
|
|
318
323
|
|
|
319
|
-
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
324
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/environment/list.ts)_
|
|
320
325
|
|
|
321
326
|
## `knock guide activate GUIDEKEY`
|
|
322
327
|
|
|
@@ -347,7 +352,7 @@ DESCRIPTION
|
|
|
347
352
|
or deactivated at a later time using the --from and --until flags.
|
|
348
353
|
```
|
|
349
354
|
|
|
350
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
355
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/activate.ts)_
|
|
351
356
|
|
|
352
357
|
## `knock guide generate-types`
|
|
353
358
|
|
|
@@ -370,7 +375,7 @@ DESCRIPTION
|
|
|
370
375
|
Generate types for all guides in an environment and write them to a file.
|
|
371
376
|
```
|
|
372
377
|
|
|
373
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
378
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/generate-types.ts)_
|
|
374
379
|
|
|
375
380
|
## `knock guide get GUIDEKEY`
|
|
376
381
|
|
|
@@ -391,7 +396,7 @@ GLOBAL FLAGS
|
|
|
391
396
|
--json Format output as json.
|
|
392
397
|
```
|
|
393
398
|
|
|
394
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
399
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/get.ts)_
|
|
395
400
|
|
|
396
401
|
## `knock guide list`
|
|
397
402
|
|
|
@@ -415,7 +420,7 @@ GLOBAL FLAGS
|
|
|
415
420
|
--json Format output as json.
|
|
416
421
|
```
|
|
417
422
|
|
|
418
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
423
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/list.ts)_
|
|
419
424
|
|
|
420
425
|
## `knock guide new`
|
|
421
426
|
|
|
@@ -439,7 +444,23 @@ FLAGS
|
|
|
439
444
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
440
445
|
```
|
|
441
446
|
|
|
442
|
-
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
447
|
+
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/new.ts)_
|
|
448
|
+
|
|
449
|
+
## `knock guide open GUIDEKEY`
|
|
450
|
+
|
|
451
|
+
Open a guide in the Knock dashboard.
|
|
452
|
+
|
|
453
|
+
```
|
|
454
|
+
USAGE
|
|
455
|
+
$ knock guide open GUIDEKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
456
|
+
|
|
457
|
+
FLAGS
|
|
458
|
+
--branch=<value> The slug of the branch to use.
|
|
459
|
+
--environment=<value> [default: development] The environment to use.
|
|
460
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/open.ts)_
|
|
443
464
|
|
|
444
465
|
## `knock guide pull [GUIDEKEY]`
|
|
445
466
|
|
|
@@ -460,7 +481,7 @@ FLAGS
|
|
|
460
481
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
461
482
|
```
|
|
462
483
|
|
|
463
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
484
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/pull.ts)_
|
|
464
485
|
|
|
465
486
|
## `knock guide push [GUIDEKEY]`
|
|
466
487
|
|
|
@@ -481,7 +502,7 @@ FLAGS
|
|
|
481
502
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
482
503
|
```
|
|
483
504
|
|
|
484
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
505
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/push.ts)_
|
|
485
506
|
|
|
486
507
|
## `knock guide validate [GUIDEKEY]`
|
|
487
508
|
|
|
@@ -500,7 +521,7 @@ FLAGS
|
|
|
500
521
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
501
522
|
```
|
|
502
523
|
|
|
503
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
524
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/validate.ts)_
|
|
504
525
|
|
|
505
526
|
## `knock help [COMMAND]`
|
|
506
527
|
|
|
@@ -540,7 +561,7 @@ DESCRIPTION
|
|
|
540
561
|
resources directory.
|
|
541
562
|
```
|
|
542
563
|
|
|
543
|
-
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
564
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/init.ts)_
|
|
544
565
|
|
|
545
566
|
## `knock layout get EMAILLAYOUTKEY`
|
|
546
567
|
|
|
@@ -561,7 +582,7 @@ GLOBAL FLAGS
|
|
|
561
582
|
--json Format output as json.
|
|
562
583
|
```
|
|
563
584
|
|
|
564
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
585
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/get.ts)_
|
|
565
586
|
|
|
566
587
|
## `knock layout list`
|
|
567
588
|
|
|
@@ -585,7 +606,7 @@ GLOBAL FLAGS
|
|
|
585
606
|
--json Format output as json.
|
|
586
607
|
```
|
|
587
608
|
|
|
588
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
609
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/list.ts)_
|
|
589
610
|
|
|
590
611
|
## `knock layout new`
|
|
591
612
|
|
|
@@ -608,7 +629,23 @@ FLAGS
|
|
|
608
629
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
609
630
|
```
|
|
610
631
|
|
|
611
|
-
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
632
|
+
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/new.ts)_
|
|
633
|
+
|
|
634
|
+
## `knock layout open LAYOUTKEY`
|
|
635
|
+
|
|
636
|
+
Open a layout in the Knock dashboard.
|
|
637
|
+
|
|
638
|
+
```
|
|
639
|
+
USAGE
|
|
640
|
+
$ knock layout open LAYOUTKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
641
|
+
|
|
642
|
+
FLAGS
|
|
643
|
+
--branch=<value> The slug of the branch to use.
|
|
644
|
+
--environment=<value> [default: development] The environment to use.
|
|
645
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/open.ts)_
|
|
612
649
|
|
|
613
650
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
614
651
|
|
|
@@ -629,7 +666,7 @@ FLAGS
|
|
|
629
666
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
630
667
|
```
|
|
631
668
|
|
|
632
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
669
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/pull.ts)_
|
|
633
670
|
|
|
634
671
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
635
672
|
|
|
@@ -652,7 +689,7 @@ FLAGS
|
|
|
652
689
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
653
690
|
```
|
|
654
691
|
|
|
655
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
692
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/push.ts)_
|
|
656
693
|
|
|
657
694
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
658
695
|
|
|
@@ -672,7 +709,7 @@ FLAGS
|
|
|
672
709
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
673
710
|
```
|
|
674
711
|
|
|
675
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
712
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/validate.ts)_
|
|
676
713
|
|
|
677
714
|
## `knock login`
|
|
678
715
|
|
|
@@ -686,7 +723,7 @@ FLAGS
|
|
|
686
723
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
687
724
|
```
|
|
688
725
|
|
|
689
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
726
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/login.ts)_
|
|
690
727
|
|
|
691
728
|
## `knock logout`
|
|
692
729
|
|
|
@@ -700,7 +737,7 @@ FLAGS
|
|
|
700
737
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
701
738
|
```
|
|
702
739
|
|
|
703
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
740
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/logout.ts)_
|
|
704
741
|
|
|
705
742
|
## `knock message-type get MESSAGETYPEKEY`
|
|
706
743
|
|
|
@@ -721,7 +758,7 @@ GLOBAL FLAGS
|
|
|
721
758
|
--json Format output as json.
|
|
722
759
|
```
|
|
723
760
|
|
|
724
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
761
|
+
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/get.ts)_
|
|
725
762
|
|
|
726
763
|
## `knock message-type list`
|
|
727
764
|
|
|
@@ -745,7 +782,7 @@ GLOBAL FLAGS
|
|
|
745
782
|
--json Format output as json.
|
|
746
783
|
```
|
|
747
784
|
|
|
748
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
785
|
+
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/list.ts)_
|
|
749
786
|
|
|
750
787
|
## `knock message-type new`
|
|
751
788
|
|
|
@@ -768,7 +805,23 @@ FLAGS
|
|
|
768
805
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
769
806
|
```
|
|
770
807
|
|
|
771
|
-
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
808
|
+
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/new.ts)_
|
|
809
|
+
|
|
810
|
+
## `knock message-type open MESSAGETYPEKEY`
|
|
811
|
+
|
|
812
|
+
Open a message type in the Knock dashboard.
|
|
813
|
+
|
|
814
|
+
```
|
|
815
|
+
USAGE
|
|
816
|
+
$ knock message-type open MESSAGETYPEKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
817
|
+
|
|
818
|
+
FLAGS
|
|
819
|
+
--branch=<value> The slug of the branch to use.
|
|
820
|
+
--environment=<value> [default: development] The environment to use.
|
|
821
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
822
|
+
```
|
|
823
|
+
|
|
824
|
+
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/open.ts)_
|
|
772
825
|
|
|
773
826
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
774
827
|
|
|
@@ -789,7 +842,7 @@ FLAGS
|
|
|
789
842
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
790
843
|
```
|
|
791
844
|
|
|
792
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
845
|
+
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/pull.ts)_
|
|
793
846
|
|
|
794
847
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
795
848
|
|
|
@@ -812,7 +865,7 @@ FLAGS
|
|
|
812
865
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
813
866
|
```
|
|
814
867
|
|
|
815
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
868
|
+
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/push.ts)_
|
|
816
869
|
|
|
817
870
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
818
871
|
|
|
@@ -833,7 +886,7 @@ FLAGS
|
|
|
833
886
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
834
887
|
```
|
|
835
888
|
|
|
836
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
889
|
+
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/message-type/validate.ts)_
|
|
837
890
|
|
|
838
891
|
## `knock partial get PARTIALKEY`
|
|
839
892
|
|
|
@@ -854,7 +907,7 @@ GLOBAL FLAGS
|
|
|
854
907
|
--json Format output as json.
|
|
855
908
|
```
|
|
856
909
|
|
|
857
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
910
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/get.ts)_
|
|
858
911
|
|
|
859
912
|
## `knock partial list`
|
|
860
913
|
|
|
@@ -878,7 +931,7 @@ GLOBAL FLAGS
|
|
|
878
931
|
--json Format output as json.
|
|
879
932
|
```
|
|
880
933
|
|
|
881
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
934
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/list.ts)_
|
|
882
935
|
|
|
883
936
|
## `knock partial new`
|
|
884
937
|
|
|
@@ -904,7 +957,23 @@ FLAGS
|
|
|
904
957
|
with --type.
|
|
905
958
|
```
|
|
906
959
|
|
|
907
|
-
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
960
|
+
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/new.ts)_
|
|
961
|
+
|
|
962
|
+
## `knock partial open PARTIALKEY`
|
|
963
|
+
|
|
964
|
+
Open a partial in the Knock dashboard.
|
|
965
|
+
|
|
966
|
+
```
|
|
967
|
+
USAGE
|
|
968
|
+
$ knock partial open PARTIALKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
969
|
+
|
|
970
|
+
FLAGS
|
|
971
|
+
--branch=<value> The slug of the branch to use.
|
|
972
|
+
--environment=<value> [default: development] The environment to use.
|
|
973
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/open.ts)_
|
|
908
977
|
|
|
909
978
|
## `knock partial pull [PARTIALKEY]`
|
|
910
979
|
|
|
@@ -925,7 +994,7 @@ FLAGS
|
|
|
925
994
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
926
995
|
```
|
|
927
996
|
|
|
928
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
997
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/pull.ts)_
|
|
929
998
|
|
|
930
999
|
## `knock partial push [PARTIALKEY]`
|
|
931
1000
|
|
|
@@ -947,7 +1016,7 @@ FLAGS
|
|
|
947
1016
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
948
1017
|
```
|
|
949
1018
|
|
|
950
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1019
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/push.ts)_
|
|
951
1020
|
|
|
952
1021
|
## `knock partial validate [PARTIALKEY]`
|
|
953
1022
|
|
|
@@ -967,7 +1036,7 @@ FLAGS
|
|
|
967
1036
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
968
1037
|
```
|
|
969
1038
|
|
|
970
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1039
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/validate.ts)_
|
|
971
1040
|
|
|
972
1041
|
## `knock pull`
|
|
973
1042
|
|
|
@@ -987,7 +1056,7 @@ FLAGS
|
|
|
987
1056
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
988
1057
|
```
|
|
989
1058
|
|
|
990
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1059
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/pull.ts)_
|
|
991
1060
|
|
|
992
1061
|
## `knock push`
|
|
993
1062
|
|
|
@@ -1008,7 +1077,7 @@ FLAGS
|
|
|
1008
1077
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1009
1078
|
```
|
|
1010
1079
|
|
|
1011
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1080
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/push.ts)_
|
|
1012
1081
|
|
|
1013
1082
|
## `knock translation get TRANSLATIONREF`
|
|
1014
1083
|
|
|
@@ -1036,7 +1105,7 @@ GLOBAL FLAGS
|
|
|
1036
1105
|
--json Format output as json.
|
|
1037
1106
|
```
|
|
1038
1107
|
|
|
1039
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1108
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/get.ts)_
|
|
1040
1109
|
|
|
1041
1110
|
## `knock translation list`
|
|
1042
1111
|
|
|
@@ -1060,7 +1129,7 @@ GLOBAL FLAGS
|
|
|
1060
1129
|
--json Format output as json.
|
|
1061
1130
|
```
|
|
1062
1131
|
|
|
1063
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1132
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/list.ts)_
|
|
1064
1133
|
|
|
1065
1134
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1066
1135
|
|
|
@@ -1088,7 +1157,7 @@ FLAGS
|
|
|
1088
1157
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1089
1158
|
```
|
|
1090
1159
|
|
|
1091
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1160
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/pull.ts)_
|
|
1092
1161
|
|
|
1093
1162
|
## `knock translation push [TRANSLATIONREF]`
|
|
1094
1163
|
|
|
@@ -1116,7 +1185,7 @@ FLAGS
|
|
|
1116
1185
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1117
1186
|
```
|
|
1118
1187
|
|
|
1119
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1188
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/push.ts)_
|
|
1120
1189
|
|
|
1121
1190
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1122
1191
|
|
|
@@ -1142,7 +1211,7 @@ FLAGS
|
|
|
1142
1211
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1143
1212
|
```
|
|
1144
1213
|
|
|
1145
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1214
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/validate.ts)_
|
|
1146
1215
|
|
|
1147
1216
|
## `knock whoami`
|
|
1148
1217
|
|
|
@@ -1159,7 +1228,7 @@ GLOBAL FLAGS
|
|
|
1159
1228
|
--json Format output as json.
|
|
1160
1229
|
```
|
|
1161
1230
|
|
|
1162
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1231
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/whoami.ts)_
|
|
1163
1232
|
|
|
1164
1233
|
## `knock workflow activate WORKFLOWKEY`
|
|
1165
1234
|
|
|
@@ -1188,7 +1257,7 @@ DESCRIPTION
|
|
|
1188
1257
|
with `false` in order to deactivate it.
|
|
1189
1258
|
```
|
|
1190
1259
|
|
|
1191
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1260
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/activate.ts)_
|
|
1192
1261
|
|
|
1193
1262
|
## `knock workflow generate-types`
|
|
1194
1263
|
|
|
@@ -1211,7 +1280,7 @@ DESCRIPTION
|
|
|
1211
1280
|
Generate types for all workflows in an environment and write them to a file.
|
|
1212
1281
|
```
|
|
1213
1282
|
|
|
1214
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1283
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/generate-types.ts)_
|
|
1215
1284
|
|
|
1216
1285
|
## `knock workflow get WORKFLOWKEY`
|
|
1217
1286
|
|
|
@@ -1232,7 +1301,7 @@ GLOBAL FLAGS
|
|
|
1232
1301
|
--json Format output as json.
|
|
1233
1302
|
```
|
|
1234
1303
|
|
|
1235
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1304
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/get.ts)_
|
|
1236
1305
|
|
|
1237
1306
|
## `knock workflow list`
|
|
1238
1307
|
|
|
@@ -1256,7 +1325,7 @@ GLOBAL FLAGS
|
|
|
1256
1325
|
--json Format output as json.
|
|
1257
1326
|
```
|
|
1258
1327
|
|
|
1259
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1328
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/list.ts)_
|
|
1260
1329
|
|
|
1261
1330
|
## `knock workflow new`
|
|
1262
1331
|
|
|
@@ -1281,7 +1350,23 @@ FLAGS
|
|
|
1281
1350
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1282
1351
|
```
|
|
1283
1352
|
|
|
1284
|
-
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1353
|
+
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/new.ts)_
|
|
1354
|
+
|
|
1355
|
+
## `knock workflow open WORKFLOWKEY`
|
|
1356
|
+
|
|
1357
|
+
Open a workflow in the Knock dashboard.
|
|
1358
|
+
|
|
1359
|
+
```
|
|
1360
|
+
USAGE
|
|
1361
|
+
$ knock workflow open WORKFLOWKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1362
|
+
|
|
1363
|
+
FLAGS
|
|
1364
|
+
--branch=<value> The slug of the branch to use.
|
|
1365
|
+
--environment=<value> [default: development] The environment to use.
|
|
1366
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1367
|
+
```
|
|
1368
|
+
|
|
1369
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/open.ts)_
|
|
1285
1370
|
|
|
1286
1371
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1287
1372
|
|
|
@@ -1302,7 +1387,7 @@ FLAGS
|
|
|
1302
1387
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1303
1388
|
```
|
|
1304
1389
|
|
|
1305
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1390
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/pull.ts)_
|
|
1306
1391
|
|
|
1307
1392
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1308
1393
|
|
|
@@ -1323,7 +1408,7 @@ FLAGS
|
|
|
1323
1408
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1324
1409
|
```
|
|
1325
1410
|
|
|
1326
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1411
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/push.ts)_
|
|
1327
1412
|
|
|
1328
1413
|
## `knock workflow run WORKFLOWKEY`
|
|
1329
1414
|
|
|
@@ -1345,7 +1430,7 @@ FLAGS
|
|
|
1345
1430
|
--tenant=<value> A tenant id for the workflow run.
|
|
1346
1431
|
```
|
|
1347
1432
|
|
|
1348
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1433
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/run.ts)_
|
|
1349
1434
|
|
|
1350
1435
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1351
1436
|
|
|
@@ -1364,5 +1449,5 @@ FLAGS
|
|
|
1364
1449
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1365
1450
|
```
|
|
1366
1451
|
|
|
1367
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0
|
|
1452
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/validate.ts)_
|
|
1368
1453
|
<!-- commandsstop -->
|