@knocklabs/cli 0.3.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 +343 -55
- package/dist/commands/branch/delete.js +4 -1
- package/dist/commands/branch/merge.js +82 -0
- package/dist/commands/channel/list.js +73 -0
- package/dist/commands/environment/list.js +73 -0
- package/dist/commands/guide/new.js +276 -0
- package/dist/commands/guide/open.js +106 -0
- package/dist/commands/guide/pull.js +5 -6
- package/dist/commands/guide/push.js +1 -1
- package/dist/commands/guide/validate.js +1 -1
- package/dist/commands/init.js +108 -0
- package/dist/commands/layout/new.js +228 -0
- package/dist/commands/layout/open.js +106 -0
- package/dist/commands/layout/pull.js +5 -6
- package/dist/commands/layout/push.js +1 -1
- package/dist/commands/layout/validate.js +1 -1
- package/dist/commands/message-type/new.js +228 -0
- package/dist/commands/message-type/open.js +106 -0
- package/dist/commands/message-type/pull.js +5 -6
- package/dist/commands/message-type/push.js +1 -1
- package/dist/commands/message-type/validate.js +1 -1
- package/dist/commands/partial/new.js +274 -0
- package/dist/commands/partial/open.js +106 -0
- package/dist/commands/partial/pull.js +5 -6
- package/dist/commands/partial/push.js +1 -1
- package/dist/commands/partial/validate.js +1 -1
- package/dist/commands/pull.js +7 -2
- package/dist/commands/push.js +6 -4
- package/dist/commands/translation/pull.js +1 -1
- package/dist/commands/translation/push.js +1 -1
- package/dist/commands/translation/validate.js +1 -1
- package/dist/commands/workflow/new.js +179 -54
- package/dist/commands/workflow/open.js +106 -0
- package/dist/commands/workflow/pull.js +6 -8
- package/dist/commands/workflow/push.js +1 -1
- package/dist/commands/workflow/validate.js +1 -1
- package/dist/lib/api-v1.js +23 -2
- package/dist/lib/auth.js +1 -1
- package/dist/lib/base-command.js +18 -15
- package/dist/lib/helpers/project-config.js +158 -0
- package/dist/lib/helpers/request.js +1 -2
- package/dist/lib/helpers/string.js +4 -4
- package/dist/lib/helpers/typegen.js +1 -1
- package/dist/lib/marshal/email-layout/generator.js +152 -0
- package/dist/lib/marshal/email-layout/helpers.js +6 -9
- package/dist/lib/marshal/email-layout/index.js +1 -0
- package/dist/lib/marshal/email-layout/writer.js +15 -3
- package/dist/lib/marshal/guide/generator.js +163 -0
- package/dist/lib/marshal/guide/helpers.js +6 -10
- package/dist/lib/marshal/guide/index.js +1 -0
- package/dist/lib/marshal/guide/writer.js +5 -9
- package/dist/lib/marshal/message-type/generator.js +139 -0
- package/dist/lib/marshal/message-type/helpers.js +6 -10
- package/dist/lib/marshal/message-type/index.js +1 -0
- package/dist/lib/marshal/message-type/writer.js +5 -1
- package/dist/lib/marshal/partial/generator.js +159 -0
- package/dist/lib/marshal/partial/helpers.js +6 -10
- package/dist/lib/marshal/partial/index.js +1 -0
- package/dist/lib/marshal/partial/writer.js +3 -0
- package/dist/lib/marshal/translation/helpers.js +6 -10
- package/dist/lib/marshal/translation/processor.isomorphic.js +4 -4
- package/dist/lib/marshal/translation/writer.js +2 -2
- package/dist/lib/marshal/workflow/generator.js +175 -19
- package/dist/lib/marshal/workflow/helpers.js +7 -10
- package/dist/lib/run-context/loader.js +5 -0
- package/dist/lib/templates.js +131 -0
- package/dist/lib/urls.js +16 -0
- package/oclif.manifest.json +1446 -547
- package/package.json +11 -9
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
|
|
|
16
16
|
$ knock COMMAND
|
|
17
17
|
running command...
|
|
18
18
|
$ knock (--version)
|
|
19
|
-
@knocklabs/cli/0.
|
|
19
|
+
@knocklabs/cli/1.0.0 linux-x64 node-v18.20.8
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -31,21 +31,29 @@ USAGE
|
|
|
31
31
|
* [`knock branch delete SLUG`](#knock-branch-delete-slug)
|
|
32
32
|
* [`knock branch exit`](#knock-branch-exit)
|
|
33
33
|
* [`knock branch list`](#knock-branch-list)
|
|
34
|
+
* [`knock branch merge SLUG`](#knock-branch-merge-slug)
|
|
34
35
|
* [`knock branch switch SLUG`](#knock-branch-switch-slug)
|
|
36
|
+
* [`knock channel list`](#knock-channel-list)
|
|
35
37
|
* [`knock commit`](#knock-commit)
|
|
36
38
|
* [`knock commit get ID`](#knock-commit-get-id)
|
|
37
39
|
* [`knock commit list`](#knock-commit-list)
|
|
38
40
|
* [`knock commit promote`](#knock-commit-promote)
|
|
41
|
+
* [`knock environment list`](#knock-environment-list)
|
|
39
42
|
* [`knock guide activate GUIDEKEY`](#knock-guide-activate-guidekey)
|
|
40
43
|
* [`knock guide generate-types`](#knock-guide-generate-types)
|
|
41
44
|
* [`knock guide get GUIDEKEY`](#knock-guide-get-guidekey)
|
|
42
45
|
* [`knock guide list`](#knock-guide-list)
|
|
46
|
+
* [`knock guide new`](#knock-guide-new)
|
|
47
|
+
* [`knock guide open GUIDEKEY`](#knock-guide-open-guidekey)
|
|
43
48
|
* [`knock guide pull [GUIDEKEY]`](#knock-guide-pull-guidekey)
|
|
44
49
|
* [`knock guide push [GUIDEKEY]`](#knock-guide-push-guidekey)
|
|
45
50
|
* [`knock guide validate [GUIDEKEY]`](#knock-guide-validate-guidekey)
|
|
46
51
|
* [`knock help [COMMAND]`](#knock-help-command)
|
|
52
|
+
* [`knock init`](#knock-init)
|
|
47
53
|
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
48
54
|
* [`knock layout list`](#knock-layout-list)
|
|
55
|
+
* [`knock layout new`](#knock-layout-new)
|
|
56
|
+
* [`knock layout open LAYOUTKEY`](#knock-layout-open-layoutkey)
|
|
49
57
|
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
50
58
|
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
51
59
|
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
@@ -53,11 +61,15 @@ USAGE
|
|
|
53
61
|
* [`knock logout`](#knock-logout)
|
|
54
62
|
* [`knock message-type get MESSAGETYPEKEY`](#knock-message-type-get-messagetypekey)
|
|
55
63
|
* [`knock message-type list`](#knock-message-type-list)
|
|
64
|
+
* [`knock message-type new`](#knock-message-type-new)
|
|
65
|
+
* [`knock message-type open MESSAGETYPEKEY`](#knock-message-type-open-messagetypekey)
|
|
56
66
|
* [`knock message-type pull [MESSAGETYPEKEY]`](#knock-message-type-pull-messagetypekey)
|
|
57
67
|
* [`knock message-type push [MESSAGETYPEKEY]`](#knock-message-type-push-messagetypekey)
|
|
58
68
|
* [`knock message-type validate [MESSAGETYPEKEY]`](#knock-message-type-validate-messagetypekey)
|
|
59
69
|
* [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
|
|
60
70
|
* [`knock partial list`](#knock-partial-list)
|
|
71
|
+
* [`knock partial new`](#knock-partial-new)
|
|
72
|
+
* [`knock partial open PARTIALKEY`](#knock-partial-open-partialkey)
|
|
61
73
|
* [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
|
|
62
74
|
* [`knock partial push [PARTIALKEY]`](#knock-partial-push-partialkey)
|
|
63
75
|
* [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
|
|
@@ -73,6 +85,8 @@ USAGE
|
|
|
73
85
|
* [`knock workflow generate-types`](#knock-workflow-generate-types)
|
|
74
86
|
* [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
|
|
75
87
|
* [`knock workflow list`](#knock-workflow-list)
|
|
88
|
+
* [`knock workflow new`](#knock-workflow-new)
|
|
89
|
+
* [`knock workflow open WORKFLOWKEY`](#knock-workflow-open-workflowkey)
|
|
76
90
|
* [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
|
|
77
91
|
* [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
|
|
78
92
|
* [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
|
|
@@ -96,7 +110,7 @@ GLOBAL FLAGS
|
|
|
96
110
|
--json Format output as json.
|
|
97
111
|
```
|
|
98
112
|
|
|
99
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
113
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/create.ts)_
|
|
100
114
|
|
|
101
115
|
## `knock branch delete SLUG`
|
|
102
116
|
|
|
@@ -114,7 +128,7 @@ FLAGS
|
|
|
114
128
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
115
129
|
```
|
|
116
130
|
|
|
117
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
131
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/delete.ts)_
|
|
118
132
|
|
|
119
133
|
## `knock branch exit`
|
|
120
134
|
|
|
@@ -128,7 +142,7 @@ FLAGS
|
|
|
128
142
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
129
143
|
```
|
|
130
144
|
|
|
131
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
145
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/exit.ts)_
|
|
132
146
|
|
|
133
147
|
## `knock branch list`
|
|
134
148
|
|
|
@@ -148,7 +162,26 @@ GLOBAL FLAGS
|
|
|
148
162
|
--json Format output as json.
|
|
149
163
|
```
|
|
150
164
|
|
|
151
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
165
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/list.ts)_
|
|
166
|
+
|
|
167
|
+
## `knock branch merge SLUG`
|
|
168
|
+
|
|
169
|
+
Merges a branch into the development environment.
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
USAGE
|
|
173
|
+
$ knock branch merge SLUG [--service-token <value>] [--force] [--delete]
|
|
174
|
+
|
|
175
|
+
ARGUMENTS
|
|
176
|
+
SLUG The slug of the branch to merge
|
|
177
|
+
|
|
178
|
+
FLAGS
|
|
179
|
+
--[no-]delete Delete the branch after merging.
|
|
180
|
+
--force Remove the confirmation prompt.
|
|
181
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/merge.ts)_
|
|
152
185
|
|
|
153
186
|
## `knock branch switch SLUG`
|
|
154
187
|
|
|
@@ -167,7 +200,24 @@ FLAGS
|
|
|
167
200
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
168
201
|
```
|
|
169
202
|
|
|
170
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
203
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/branch/switch.ts)_
|
|
204
|
+
|
|
205
|
+
## `knock channel list`
|
|
206
|
+
|
|
207
|
+
Display all channels configured for the account.
|
|
208
|
+
|
|
209
|
+
```
|
|
210
|
+
USAGE
|
|
211
|
+
$ knock channel list [--json] [--service-token <value>]
|
|
212
|
+
|
|
213
|
+
FLAGS
|
|
214
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
215
|
+
|
|
216
|
+
GLOBAL FLAGS
|
|
217
|
+
--json Format output as json.
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/channel/list.ts)_
|
|
171
221
|
|
|
172
222
|
## `knock commit`
|
|
173
223
|
|
|
@@ -188,7 +238,7 @@ FLAGS
|
|
|
188
238
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
189
239
|
```
|
|
190
240
|
|
|
191
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
241
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/index.ts)_
|
|
192
242
|
|
|
193
243
|
## `knock commit get ID`
|
|
194
244
|
|
|
@@ -205,7 +255,7 @@ GLOBAL FLAGS
|
|
|
205
255
|
--json Format output as json.
|
|
206
256
|
```
|
|
207
257
|
|
|
208
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
258
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/get.ts)_
|
|
209
259
|
|
|
210
260
|
## `knock commit list`
|
|
211
261
|
|
|
@@ -237,7 +287,7 @@ GLOBAL FLAGS
|
|
|
237
287
|
--json Format output as json.
|
|
238
288
|
```
|
|
239
289
|
|
|
240
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
290
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/list.ts)_
|
|
241
291
|
|
|
242
292
|
## `knock commit promote`
|
|
243
293
|
|
|
@@ -254,7 +304,24 @@ FLAGS
|
|
|
254
304
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
255
305
|
```
|
|
256
306
|
|
|
257
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
307
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/commit/promote.ts)_
|
|
308
|
+
|
|
309
|
+
## `knock environment list`
|
|
310
|
+
|
|
311
|
+
Display all environments configured for the account.
|
|
312
|
+
|
|
313
|
+
```
|
|
314
|
+
USAGE
|
|
315
|
+
$ knock environment list [--json] [--service-token <value>]
|
|
316
|
+
|
|
317
|
+
FLAGS
|
|
318
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
319
|
+
|
|
320
|
+
GLOBAL FLAGS
|
|
321
|
+
--json Format output as json.
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/environment/list.ts)_
|
|
258
325
|
|
|
259
326
|
## `knock guide activate GUIDEKEY`
|
|
260
327
|
|
|
@@ -285,7 +352,7 @@ DESCRIPTION
|
|
|
285
352
|
or deactivated at a later time using the --from and --until flags.
|
|
286
353
|
```
|
|
287
354
|
|
|
288
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
355
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/activate.ts)_
|
|
289
356
|
|
|
290
357
|
## `knock guide generate-types`
|
|
291
358
|
|
|
@@ -308,7 +375,7 @@ DESCRIPTION
|
|
|
308
375
|
Generate types for all guides in an environment and write them to a file.
|
|
309
376
|
```
|
|
310
377
|
|
|
311
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
312
379
|
|
|
313
380
|
## `knock guide get GUIDEKEY`
|
|
314
381
|
|
|
@@ -329,7 +396,7 @@ GLOBAL FLAGS
|
|
|
329
396
|
--json Format output as json.
|
|
330
397
|
```
|
|
331
398
|
|
|
332
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
399
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/get.ts)_
|
|
333
400
|
|
|
334
401
|
## `knock guide list`
|
|
335
402
|
|
|
@@ -353,7 +420,47 @@ GLOBAL FLAGS
|
|
|
353
420
|
--json Format output as json.
|
|
354
421
|
```
|
|
355
422
|
|
|
356
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
423
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/list.ts)_
|
|
424
|
+
|
|
425
|
+
## `knock guide new`
|
|
426
|
+
|
|
427
|
+
Create a new guide with a minimal configuration.
|
|
428
|
+
|
|
429
|
+
```
|
|
430
|
+
USAGE
|
|
431
|
+
$ knock guide new [--service-token <value>] [-n <value>] [-k <value>] [-m <value>] [--environment <value>]
|
|
432
|
+
[--branch <value>] [--force] [-p] [-t <value>]
|
|
433
|
+
|
|
434
|
+
FLAGS
|
|
435
|
+
-k, --key=<value> The key of the guide
|
|
436
|
+
-m, --message-type=<value> The message type key to use for the guide. You cannot use this flag with --template.
|
|
437
|
+
-n, --name=<value> The name of the guide
|
|
438
|
+
-p, --push Whether or not to push the guide to Knock after creation.
|
|
439
|
+
-t, --template=<value> The template to use for the guide. Should be `guides/{key}`. You cannot use this flag
|
|
440
|
+
with --message-type.
|
|
441
|
+
--branch=<value> The slug of the branch to use.
|
|
442
|
+
--environment=<value> [default: development] The environment to create the guide in. Defaults to development.
|
|
443
|
+
--force Force the creation of the guide directory without confirmation.
|
|
444
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
445
|
+
```
|
|
446
|
+
|
|
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)_
|
|
357
464
|
|
|
358
465
|
## `knock guide pull [GUIDEKEY]`
|
|
359
466
|
|
|
@@ -374,7 +481,7 @@ FLAGS
|
|
|
374
481
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
375
482
|
```
|
|
376
483
|
|
|
377
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
484
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/pull.ts)_
|
|
378
485
|
|
|
379
486
|
## `knock guide push [GUIDEKEY]`
|
|
380
487
|
|
|
@@ -395,7 +502,7 @@ FLAGS
|
|
|
395
502
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
396
503
|
```
|
|
397
504
|
|
|
398
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
505
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/push.ts)_
|
|
399
506
|
|
|
400
507
|
## `knock guide validate [GUIDEKEY]`
|
|
401
508
|
|
|
@@ -414,7 +521,7 @@ FLAGS
|
|
|
414
521
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
415
522
|
```
|
|
416
523
|
|
|
417
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
524
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/guide/validate.ts)_
|
|
418
525
|
|
|
419
526
|
## `knock help [COMMAND]`
|
|
420
527
|
|
|
@@ -434,7 +541,27 @@ DESCRIPTION
|
|
|
434
541
|
Display help for knock.
|
|
435
542
|
```
|
|
436
543
|
|
|
437
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
544
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
|
|
545
|
+
|
|
546
|
+
## `knock init`
|
|
547
|
+
|
|
548
|
+
Initialize a new Knock project with a knock.json configuration file.
|
|
549
|
+
|
|
550
|
+
```
|
|
551
|
+
USAGE
|
|
552
|
+
$ knock init [--service-token <value>]
|
|
553
|
+
|
|
554
|
+
FLAGS
|
|
555
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
556
|
+
|
|
557
|
+
DESCRIPTION
|
|
558
|
+
Initialize a new Knock project with a knock.json configuration file.
|
|
559
|
+
|
|
560
|
+
Creates a knock.json configuration file in the current directory to store project-level settings like the knock
|
|
561
|
+
resources directory.
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/init.ts)_
|
|
438
565
|
|
|
439
566
|
## `knock layout get EMAILLAYOUTKEY`
|
|
440
567
|
|
|
@@ -455,7 +582,7 @@ GLOBAL FLAGS
|
|
|
455
582
|
--json Format output as json.
|
|
456
583
|
```
|
|
457
584
|
|
|
458
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
585
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/get.ts)_
|
|
459
586
|
|
|
460
587
|
## `knock layout list`
|
|
461
588
|
|
|
@@ -479,7 +606,46 @@ GLOBAL FLAGS
|
|
|
479
606
|
--json Format output as json.
|
|
480
607
|
```
|
|
481
608
|
|
|
482
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
609
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/list.ts)_
|
|
610
|
+
|
|
611
|
+
## `knock layout new`
|
|
612
|
+
|
|
613
|
+
Create a new email layout with a minimal configuration.
|
|
614
|
+
|
|
615
|
+
```
|
|
616
|
+
USAGE
|
|
617
|
+
$ knock layout new [--service-token <value>] [-n <value>] [-k <value>] [--environment <value>] [--branch
|
|
618
|
+
<value>] [--force] [-p] [--template <value>]
|
|
619
|
+
|
|
620
|
+
FLAGS
|
|
621
|
+
-k, --key=<value> The key of the email layout
|
|
622
|
+
-n, --name=<value> The name of the email layout
|
|
623
|
+
-p, --push Whether or not to push the email layout to Knock after creation.
|
|
624
|
+
--branch=<value> The slug of the branch to use.
|
|
625
|
+
--environment=<value> [default: development] The environment to create the email layout in. Defaults to
|
|
626
|
+
development.
|
|
627
|
+
--force Force the creation of the email layout directory without confirmation.
|
|
628
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
629
|
+
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
630
|
+
```
|
|
631
|
+
|
|
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)_
|
|
483
649
|
|
|
484
650
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
485
651
|
|
|
@@ -500,7 +666,7 @@ FLAGS
|
|
|
500
666
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
501
667
|
```
|
|
502
668
|
|
|
503
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
669
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/pull.ts)_
|
|
504
670
|
|
|
505
671
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
506
672
|
|
|
@@ -523,7 +689,7 @@ FLAGS
|
|
|
523
689
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
524
690
|
```
|
|
525
691
|
|
|
526
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
692
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/push.ts)_
|
|
527
693
|
|
|
528
694
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
529
695
|
|
|
@@ -543,7 +709,7 @@ FLAGS
|
|
|
543
709
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
544
710
|
```
|
|
545
711
|
|
|
546
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
712
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/layout/validate.ts)_
|
|
547
713
|
|
|
548
714
|
## `knock login`
|
|
549
715
|
|
|
@@ -557,7 +723,7 @@ FLAGS
|
|
|
557
723
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
558
724
|
```
|
|
559
725
|
|
|
560
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
726
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/login.ts)_
|
|
561
727
|
|
|
562
728
|
## `knock logout`
|
|
563
729
|
|
|
@@ -571,7 +737,7 @@ FLAGS
|
|
|
571
737
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
572
738
|
```
|
|
573
739
|
|
|
574
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
740
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/logout.ts)_
|
|
575
741
|
|
|
576
742
|
## `knock message-type get MESSAGETYPEKEY`
|
|
577
743
|
|
|
@@ -592,7 +758,7 @@ GLOBAL FLAGS
|
|
|
592
758
|
--json Format output as json.
|
|
593
759
|
```
|
|
594
760
|
|
|
595
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
596
762
|
|
|
597
763
|
## `knock message-type list`
|
|
598
764
|
|
|
@@ -616,7 +782,46 @@ GLOBAL FLAGS
|
|
|
616
782
|
--json Format output as json.
|
|
617
783
|
```
|
|
618
784
|
|
|
619
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
786
|
+
|
|
787
|
+
## `knock message-type new`
|
|
788
|
+
|
|
789
|
+
Create a new message type with a minimal configuration.
|
|
790
|
+
|
|
791
|
+
```
|
|
792
|
+
USAGE
|
|
793
|
+
$ knock message-type new [--service-token <value>] [-n <value>] [-k <value>] [--environment <value>] [--branch
|
|
794
|
+
<value>] [--force] [-p] [--template <value>]
|
|
795
|
+
|
|
796
|
+
FLAGS
|
|
797
|
+
-k, --key=<value> The key of the message type
|
|
798
|
+
-n, --name=<value> The name of the message type
|
|
799
|
+
-p, --push Whether or not to push the message type to Knock after creation.
|
|
800
|
+
--branch=<value> The slug of the branch to use.
|
|
801
|
+
--environment=<value> [default: development] The environment to create the message type in. Defaults to
|
|
802
|
+
development.
|
|
803
|
+
--force Force the creation of the message type directory without confirmation.
|
|
804
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
805
|
+
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
806
|
+
```
|
|
807
|
+
|
|
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)_
|
|
620
825
|
|
|
621
826
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
622
827
|
|
|
@@ -637,7 +842,7 @@ FLAGS
|
|
|
637
842
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
638
843
|
```
|
|
639
844
|
|
|
640
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
641
846
|
|
|
642
847
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
643
848
|
|
|
@@ -660,7 +865,7 @@ FLAGS
|
|
|
660
865
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
661
866
|
```
|
|
662
867
|
|
|
663
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
664
869
|
|
|
665
870
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
666
871
|
|
|
@@ -681,7 +886,7 @@ FLAGS
|
|
|
681
886
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
682
887
|
```
|
|
683
888
|
|
|
684
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
685
890
|
|
|
686
891
|
## `knock partial get PARTIALKEY`
|
|
687
892
|
|
|
@@ -702,7 +907,7 @@ GLOBAL FLAGS
|
|
|
702
907
|
--json Format output as json.
|
|
703
908
|
```
|
|
704
909
|
|
|
705
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
910
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/get.ts)_
|
|
706
911
|
|
|
707
912
|
## `knock partial list`
|
|
708
913
|
|
|
@@ -726,7 +931,49 @@ GLOBAL FLAGS
|
|
|
726
931
|
--json Format output as json.
|
|
727
932
|
```
|
|
728
933
|
|
|
729
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
934
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/list.ts)_
|
|
935
|
+
|
|
936
|
+
## `knock partial new`
|
|
937
|
+
|
|
938
|
+
Create a new partial with a minimal configuration.
|
|
939
|
+
|
|
940
|
+
```
|
|
941
|
+
USAGE
|
|
942
|
+
$ knock partial new [--service-token <value>] [-n <value>] [-k <value>] [-t html|json|markdown|text]
|
|
943
|
+
[--environment <value>] [--branch <value>] [--force] [-p] [--template <value>]
|
|
944
|
+
|
|
945
|
+
FLAGS
|
|
946
|
+
-k, --key=<value> The key of the partial
|
|
947
|
+
-n, --name=<value> The name of the partial
|
|
948
|
+
-p, --push Whether or not to push the partial to Knock after creation.
|
|
949
|
+
-t, --type=<option> The type of the partial (html, json, markdown, text). You cannot use this flag with
|
|
950
|
+
--template.
|
|
951
|
+
<options: html|json|markdown|text>
|
|
952
|
+
--branch=<value> The slug of the branch to use.
|
|
953
|
+
--environment=<value> [default: development] The environment to create the partial in. Defaults to development.
|
|
954
|
+
--force Force the creation of the partial directory without confirmation.
|
|
955
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
956
|
+
--template=<value> The template to use for the partial. Should be `partials/{key}`. You cannot use this flag
|
|
957
|
+
with --type.
|
|
958
|
+
```
|
|
959
|
+
|
|
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)_
|
|
730
977
|
|
|
731
978
|
## `knock partial pull [PARTIALKEY]`
|
|
732
979
|
|
|
@@ -747,7 +994,7 @@ FLAGS
|
|
|
747
994
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
748
995
|
```
|
|
749
996
|
|
|
750
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
997
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/pull.ts)_
|
|
751
998
|
|
|
752
999
|
## `knock partial push [PARTIALKEY]`
|
|
753
1000
|
|
|
@@ -769,7 +1016,7 @@ FLAGS
|
|
|
769
1016
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
770
1017
|
```
|
|
771
1018
|
|
|
772
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1019
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/push.ts)_
|
|
773
1020
|
|
|
774
1021
|
## `knock partial validate [PARTIALKEY]`
|
|
775
1022
|
|
|
@@ -789,7 +1036,7 @@ FLAGS
|
|
|
789
1036
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
790
1037
|
```
|
|
791
1038
|
|
|
792
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1039
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/partial/validate.ts)_
|
|
793
1040
|
|
|
794
1041
|
## `knock pull`
|
|
795
1042
|
|
|
@@ -797,7 +1044,7 @@ Pull all resources from an environment into a local file system.
|
|
|
797
1044
|
|
|
798
1045
|
```
|
|
799
1046
|
USAGE
|
|
800
|
-
$ knock pull --
|
|
1047
|
+
$ knock pull [--service-token <value>] [--environment <value>] [--branch <value>] [--knock-dir <value>]
|
|
801
1048
|
[--hide-uncommitted-changes] [--force]
|
|
802
1049
|
|
|
803
1050
|
FLAGS
|
|
@@ -805,11 +1052,11 @@ FLAGS
|
|
|
805
1052
|
--environment=<value> [default: development] The environment to use.
|
|
806
1053
|
--force Remove the confirmation prompt.
|
|
807
1054
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
808
|
-
--knock-dir=<value>
|
|
1055
|
+
--knock-dir=<value> The target directory path to pull all resources into.
|
|
809
1056
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
810
1057
|
```
|
|
811
1058
|
|
|
812
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1059
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/pull.ts)_
|
|
813
1060
|
|
|
814
1061
|
## `knock push`
|
|
815
1062
|
|
|
@@ -817,7 +1064,7 @@ Push all resources from a local file system to Knock.
|
|
|
817
1064
|
|
|
818
1065
|
```
|
|
819
1066
|
USAGE
|
|
820
|
-
$ knock push
|
|
1067
|
+
$ knock push [--service-token <value>] [--environment development] [--branch <value>] [--knock-dir
|
|
821
1068
|
<value>] [-m <value> --commit]
|
|
822
1069
|
|
|
823
1070
|
FLAGS
|
|
@@ -826,11 +1073,11 @@ FLAGS
|
|
|
826
1073
|
--commit Push and commit the resource(s) at the same time
|
|
827
1074
|
--environment=<option> [default: development] Pushing resources is only allowed in the development environment
|
|
828
1075
|
<options: development>
|
|
829
|
-
--knock-dir=<value>
|
|
1076
|
+
--knock-dir=<value> The target directory path to find all resources to push.
|
|
830
1077
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
831
1078
|
```
|
|
832
1079
|
|
|
833
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1080
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/push.ts)_
|
|
834
1081
|
|
|
835
1082
|
## `knock translation get TRANSLATIONREF`
|
|
836
1083
|
|
|
@@ -858,7 +1105,7 @@ GLOBAL FLAGS
|
|
|
858
1105
|
--json Format output as json.
|
|
859
1106
|
```
|
|
860
1107
|
|
|
861
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1108
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/get.ts)_
|
|
862
1109
|
|
|
863
1110
|
## `knock translation list`
|
|
864
1111
|
|
|
@@ -882,7 +1129,7 @@ GLOBAL FLAGS
|
|
|
882
1129
|
--json Format output as json.
|
|
883
1130
|
```
|
|
884
1131
|
|
|
885
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1132
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/list.ts)_
|
|
886
1133
|
|
|
887
1134
|
## `knock translation pull [TRANSLATIONREF]`
|
|
888
1135
|
|
|
@@ -910,7 +1157,7 @@ FLAGS
|
|
|
910
1157
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
911
1158
|
```
|
|
912
1159
|
|
|
913
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1160
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/pull.ts)_
|
|
914
1161
|
|
|
915
1162
|
## `knock translation push [TRANSLATIONREF]`
|
|
916
1163
|
|
|
@@ -938,7 +1185,7 @@ FLAGS
|
|
|
938
1185
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
939
1186
|
```
|
|
940
1187
|
|
|
941
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1188
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/push.ts)_
|
|
942
1189
|
|
|
943
1190
|
## `knock translation validate [TRANSLATIONREF]`
|
|
944
1191
|
|
|
@@ -964,7 +1211,7 @@ FLAGS
|
|
|
964
1211
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
965
1212
|
```
|
|
966
1213
|
|
|
967
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1214
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/translation/validate.ts)_
|
|
968
1215
|
|
|
969
1216
|
## `knock whoami`
|
|
970
1217
|
|
|
@@ -981,7 +1228,7 @@ GLOBAL FLAGS
|
|
|
981
1228
|
--json Format output as json.
|
|
982
1229
|
```
|
|
983
1230
|
|
|
984
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1231
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/whoami.ts)_
|
|
985
1232
|
|
|
986
1233
|
## `knock workflow activate WORKFLOWKEY`
|
|
987
1234
|
|
|
@@ -1010,7 +1257,7 @@ DESCRIPTION
|
|
|
1010
1257
|
with `false` in order to deactivate it.
|
|
1011
1258
|
```
|
|
1012
1259
|
|
|
1013
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1260
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/activate.ts)_
|
|
1014
1261
|
|
|
1015
1262
|
## `knock workflow generate-types`
|
|
1016
1263
|
|
|
@@ -1033,7 +1280,7 @@ DESCRIPTION
|
|
|
1033
1280
|
Generate types for all workflows in an environment and write them to a file.
|
|
1034
1281
|
```
|
|
1035
1282
|
|
|
1036
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
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)_
|
|
1037
1284
|
|
|
1038
1285
|
## `knock workflow get WORKFLOWKEY`
|
|
1039
1286
|
|
|
@@ -1054,7 +1301,7 @@ GLOBAL FLAGS
|
|
|
1054
1301
|
--json Format output as json.
|
|
1055
1302
|
```
|
|
1056
1303
|
|
|
1057
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1304
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/get.ts)_
|
|
1058
1305
|
|
|
1059
1306
|
## `knock workflow list`
|
|
1060
1307
|
|
|
@@ -1078,7 +1325,48 @@ GLOBAL FLAGS
|
|
|
1078
1325
|
--json Format output as json.
|
|
1079
1326
|
```
|
|
1080
1327
|
|
|
1081
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1328
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/list.ts)_
|
|
1329
|
+
|
|
1330
|
+
## `knock workflow new`
|
|
1331
|
+
|
|
1332
|
+
Create a new workflow with a minimal configuration.
|
|
1333
|
+
|
|
1334
|
+
```
|
|
1335
|
+
USAGE
|
|
1336
|
+
$ knock workflow new [--service-token <value>] [-n <value>] [-k <value>] [-s <value>] [--environment <value>]
|
|
1337
|
+
[--branch <value>] [--force] [-p] [-t <value>]
|
|
1338
|
+
|
|
1339
|
+
FLAGS
|
|
1340
|
+
-k, --key=<value> The key of the workflow
|
|
1341
|
+
-n, --name=<value> The name of the workflow
|
|
1342
|
+
-p, --push Whether or not to push the workflow to Knock after creation.
|
|
1343
|
+
-s, --steps=<value> Comma-separated list of step types to include in the workflow
|
|
1344
|
+
-t, --template=<value> The template repository to use for the workflow. Should be `workflows/{type}`. You cannot
|
|
1345
|
+
use this flag with --steps.
|
|
1346
|
+
--branch=<value> The slug of the branch to use.
|
|
1347
|
+
--environment=<value> [default: development] The environment to create the workflow in. Defaults to
|
|
1348
|
+
development.
|
|
1349
|
+
--force Force the creation of the workflow directory without confirmation.
|
|
1350
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1351
|
+
```
|
|
1352
|
+
|
|
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)_
|
|
1082
1370
|
|
|
1083
1371
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1084
1372
|
|
|
@@ -1099,7 +1387,7 @@ FLAGS
|
|
|
1099
1387
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1100
1388
|
```
|
|
1101
1389
|
|
|
1102
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1390
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/pull.ts)_
|
|
1103
1391
|
|
|
1104
1392
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1105
1393
|
|
|
@@ -1120,7 +1408,7 @@ FLAGS
|
|
|
1120
1408
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1121
1409
|
```
|
|
1122
1410
|
|
|
1123
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1411
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/push.ts)_
|
|
1124
1412
|
|
|
1125
1413
|
## `knock workflow run WORKFLOWKEY`
|
|
1126
1414
|
|
|
@@ -1142,7 +1430,7 @@ FLAGS
|
|
|
1142
1430
|
--tenant=<value> A tenant id for the workflow run.
|
|
1143
1431
|
```
|
|
1144
1432
|
|
|
1145
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1433
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/run.ts)_
|
|
1146
1434
|
|
|
1147
1435
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1148
1436
|
|
|
@@ -1161,5 +1449,5 @@ FLAGS
|
|
|
1161
1449
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1162
1450
|
```
|
|
1163
1451
|
|
|
1164
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/
|
|
1452
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.0/src/commands/workflow/validate.ts)_
|
|
1165
1453
|
<!-- commandsstop -->
|