@knocklabs/cli 1.0.0-rc.1 → 1.0.2
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 +332 -64
- package/dist/commands/audience/archive.js +120 -0
- package/dist/commands/audience/get.js +169 -0
- package/dist/commands/audience/list.js +159 -0
- package/dist/commands/audience/new.js +243 -0
- package/dist/commands/audience/open.js +106 -0
- package/dist/commands/audience/pull.js +214 -0
- package/dist/commands/audience/push.js +167 -0
- package/dist/commands/audience/validate.js +147 -0
- package/dist/commands/branch/create.js +40 -3
- package/dist/commands/branch/list.js +14 -9
- package/dist/commands/branch/switch.js +7 -2
- 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/pull.js +19 -12
- package/dist/commands/push.js +19 -12
- package/dist/commands/workflow/open.js +106 -0
- package/dist/lib/helpers/git.js +22 -3
- package/dist/lib/helpers/project-config.js +1 -0
- package/dist/lib/marshal/audience/generator.js +38 -0
- package/dist/lib/marshal/audience/helpers.js +142 -0
- package/dist/lib/marshal/audience/index.js +23 -0
- package/dist/lib/marshal/audience/processor.isomorphic.js +25 -0
- package/dist/lib/marshal/audience/reader.js +149 -0
- package/dist/lib/marshal/audience/types.js +15 -0
- package/dist/lib/marshal/audience/writer.js +177 -0
- package/dist/lib/marshal/index.isomorphic.js +18 -14
- package/dist/lib/resources.js +3 -0
- package/dist/lib/run-context/loader.js +12 -20
- package/dist/lib/urls.js +20 -0
- package/oclif.manifest.json +1368 -430
- package/package.json +11 -11
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.2 linux-x64 node-v22.22.0
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -27,7 +27,15 @@ USAGE
|
|
|
27
27
|
# Commands
|
|
28
28
|
|
|
29
29
|
<!-- commands -->
|
|
30
|
-
* [`knock
|
|
30
|
+
* [`knock audience archive AUDIENCEKEY`](#knock-audience-archive-audiencekey)
|
|
31
|
+
* [`knock audience get AUDIENCEKEY`](#knock-audience-get-audiencekey)
|
|
32
|
+
* [`knock audience list`](#knock-audience-list)
|
|
33
|
+
* [`knock audience new`](#knock-audience-new)
|
|
34
|
+
* [`knock audience open AUDIENCEKEY`](#knock-audience-open-audiencekey)
|
|
35
|
+
* [`knock audience pull [AUDIENCEKEY]`](#knock-audience-pull-audiencekey)
|
|
36
|
+
* [`knock audience push [AUDIENCEKEY]`](#knock-audience-push-audiencekey)
|
|
37
|
+
* [`knock audience validate [AUDIENCEKEY]`](#knock-audience-validate-audiencekey)
|
|
38
|
+
* [`knock branch create [SLUG]`](#knock-branch-create-slug)
|
|
31
39
|
* [`knock branch delete SLUG`](#knock-branch-delete-slug)
|
|
32
40
|
* [`knock branch exit`](#knock-branch-exit)
|
|
33
41
|
* [`knock branch list`](#knock-branch-list)
|
|
@@ -44,6 +52,7 @@ USAGE
|
|
|
44
52
|
* [`knock guide get GUIDEKEY`](#knock-guide-get-guidekey)
|
|
45
53
|
* [`knock guide list`](#knock-guide-list)
|
|
46
54
|
* [`knock guide new`](#knock-guide-new)
|
|
55
|
+
* [`knock guide open GUIDEKEY`](#knock-guide-open-guidekey)
|
|
47
56
|
* [`knock guide pull [GUIDEKEY]`](#knock-guide-pull-guidekey)
|
|
48
57
|
* [`knock guide push [GUIDEKEY]`](#knock-guide-push-guidekey)
|
|
49
58
|
* [`knock guide validate [GUIDEKEY]`](#knock-guide-validate-guidekey)
|
|
@@ -52,6 +61,7 @@ USAGE
|
|
|
52
61
|
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
53
62
|
* [`knock layout list`](#knock-layout-list)
|
|
54
63
|
* [`knock layout new`](#knock-layout-new)
|
|
64
|
+
* [`knock layout open LAYOUTKEY`](#knock-layout-open-layoutkey)
|
|
55
65
|
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
56
66
|
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
57
67
|
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
@@ -60,12 +70,14 @@ USAGE
|
|
|
60
70
|
* [`knock message-type get MESSAGETYPEKEY`](#knock-message-type-get-messagetypekey)
|
|
61
71
|
* [`knock message-type list`](#knock-message-type-list)
|
|
62
72
|
* [`knock message-type new`](#knock-message-type-new)
|
|
73
|
+
* [`knock message-type open MESSAGETYPEKEY`](#knock-message-type-open-messagetypekey)
|
|
63
74
|
* [`knock message-type pull [MESSAGETYPEKEY]`](#knock-message-type-pull-messagetypekey)
|
|
64
75
|
* [`knock message-type push [MESSAGETYPEKEY]`](#knock-message-type-push-messagetypekey)
|
|
65
76
|
* [`knock message-type validate [MESSAGETYPEKEY]`](#knock-message-type-validate-messagetypekey)
|
|
66
77
|
* [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
|
|
67
78
|
* [`knock partial list`](#knock-partial-list)
|
|
68
79
|
* [`knock partial new`](#knock-partial-new)
|
|
80
|
+
* [`knock partial open PARTIALKEY`](#knock-partial-open-partialkey)
|
|
69
81
|
* [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
|
|
70
82
|
* [`knock partial push [PARTIALKEY]`](#knock-partial-push-partialkey)
|
|
71
83
|
* [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
|
|
@@ -82,21 +94,197 @@ USAGE
|
|
|
82
94
|
* [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
|
|
83
95
|
* [`knock workflow list`](#knock-workflow-list)
|
|
84
96
|
* [`knock workflow new`](#knock-workflow-new)
|
|
97
|
+
* [`knock workflow open WORKFLOWKEY`](#knock-workflow-open-workflowkey)
|
|
85
98
|
* [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
|
|
86
99
|
* [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
|
|
87
100
|
* [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
|
|
88
101
|
* [`knock workflow validate [WORKFLOWKEY]`](#knock-workflow-validate-workflowkey)
|
|
89
102
|
|
|
90
|
-
## `knock
|
|
103
|
+
## `knock audience archive AUDIENCEKEY`
|
|
104
|
+
|
|
105
|
+
Archive an audience (affects ALL environments).
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
USAGE
|
|
109
|
+
$ knock audience archive AUDIENCEKEY --environment <value> [--service-token <value>] [--branch <value>] [--force]
|
|
110
|
+
|
|
111
|
+
ARGUMENTS
|
|
112
|
+
AUDIENCEKEY The key of the audience to archive.
|
|
113
|
+
|
|
114
|
+
FLAGS
|
|
115
|
+
--branch=<value> The slug of the branch to use.
|
|
116
|
+
--environment=<value> (required) The environment to use.
|
|
117
|
+
--force Skip confirmation prompt.
|
|
118
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
119
|
+
|
|
120
|
+
DESCRIPTION
|
|
121
|
+
Archive an audience (affects ALL environments).
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
WARNING: Archiving an audience affects ALL environments and cannot be undone.
|
|
125
|
+
Use this command with caution.
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
_See code: [src/commands/audience/archive.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/archive.ts)_
|
|
129
|
+
|
|
130
|
+
## `knock audience get AUDIENCEKEY`
|
|
131
|
+
|
|
132
|
+
Display a single audience from an environment.
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
USAGE
|
|
136
|
+
$ knock audience get AUDIENCEKEY [--json] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
137
|
+
[--hide-uncommitted-changes]
|
|
138
|
+
|
|
139
|
+
FLAGS
|
|
140
|
+
--branch=<value> The slug of the branch to use.
|
|
141
|
+
--environment=<value> [default: development] The environment to use.
|
|
142
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
143
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
144
|
+
|
|
145
|
+
GLOBAL FLAGS
|
|
146
|
+
--json Format output as json.
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
_See code: [src/commands/audience/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/get.ts)_
|
|
150
|
+
|
|
151
|
+
## `knock audience list`
|
|
152
|
+
|
|
153
|
+
Display all audiences for an environment.
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
USAGE
|
|
157
|
+
$ knock audience list [--json] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
158
|
+
[--hide-uncommitted-changes] [--after <value>] [--before <value>] [--limit <value>]
|
|
159
|
+
|
|
160
|
+
FLAGS
|
|
161
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
162
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
163
|
+
--branch=<value> The slug of the branch to use.
|
|
164
|
+
--environment=<value> [default: development] The environment to use.
|
|
165
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
166
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
167
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
168
|
+
|
|
169
|
+
GLOBAL FLAGS
|
|
170
|
+
--json Format output as json.
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
_See code: [src/commands/audience/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/list.ts)_
|
|
174
|
+
|
|
175
|
+
## `knock audience new`
|
|
176
|
+
|
|
177
|
+
Create a new audience with a minimal configuration.
|
|
178
|
+
|
|
179
|
+
```
|
|
180
|
+
USAGE
|
|
181
|
+
$ knock audience new [--service-token <value>] [-n <value>] [-k <value>] [-t static|dynamic] [-d <value>]
|
|
182
|
+
[--environment <value>] [--branch <value>] [--force] [-p]
|
|
183
|
+
|
|
184
|
+
FLAGS
|
|
185
|
+
-d, --description=<value> The description of the audience
|
|
186
|
+
-k, --key=<value> The key of the audience
|
|
187
|
+
-n, --name=<value> The name of the audience
|
|
188
|
+
-p, --push Whether or not to push the audience to Knock after creation.
|
|
189
|
+
-t, --type=<option> The type of the audience (static, dynamic). Note: dynamic is in beta and requires access.
|
|
190
|
+
<options: static|dynamic>
|
|
191
|
+
--branch=<value> The slug of the branch to use.
|
|
192
|
+
--environment=<value> [default: development] The environment to create the audience in. Defaults to
|
|
193
|
+
development.
|
|
194
|
+
--force Force the creation of the audience directory without confirmation.
|
|
195
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
_See code: [src/commands/audience/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/new.ts)_
|
|
199
|
+
|
|
200
|
+
## `knock audience open AUDIENCEKEY`
|
|
201
|
+
|
|
202
|
+
Open an audience in the Knock dashboard.
|
|
203
|
+
|
|
204
|
+
```
|
|
205
|
+
USAGE
|
|
206
|
+
$ knock audience open AUDIENCEKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
207
|
+
|
|
208
|
+
FLAGS
|
|
209
|
+
--branch=<value> The slug of the branch to use.
|
|
210
|
+
--environment=<value> [default: development] The environment to use.
|
|
211
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
_See code: [src/commands/audience/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/open.ts)_
|
|
215
|
+
|
|
216
|
+
## `knock audience pull [AUDIENCEKEY]`
|
|
217
|
+
|
|
218
|
+
Pull one or more audiences from an environment into a local file system.
|
|
219
|
+
|
|
220
|
+
```
|
|
221
|
+
USAGE
|
|
222
|
+
$ knock audience pull [AUDIENCEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
223
|
+
[--audiences-dir <value> --all] [--hide-uncommitted-changes] [--force]
|
|
224
|
+
|
|
225
|
+
FLAGS
|
|
226
|
+
--all Whether to pull all audiences from the specified environment.
|
|
227
|
+
--audiences-dir=<value> The target directory path to pull all audiences into.
|
|
228
|
+
--branch=<value> The slug of the branch to use.
|
|
229
|
+
--environment=<value> [default: development] The environment to use.
|
|
230
|
+
--force Remove the confirmation prompt.
|
|
231
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
232
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
_See code: [src/commands/audience/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/pull.ts)_
|
|
236
|
+
|
|
237
|
+
## `knock audience push [AUDIENCEKEY]`
|
|
238
|
+
|
|
239
|
+
Push one or more audiences from a local file system to Knock.
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
USAGE
|
|
243
|
+
$ knock audience push [AUDIENCEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
244
|
+
[--audiences-dir <value> --all] [-m <value> --commit]
|
|
245
|
+
|
|
246
|
+
FLAGS
|
|
247
|
+
-m, --commit-message=<value> Use the given value as the commit message
|
|
248
|
+
--all Whether to push all audiences from the target directory.
|
|
249
|
+
--audiences-dir=<value> The target directory path to find all audiences to push.
|
|
250
|
+
--branch=<value> The slug of the branch to use.
|
|
251
|
+
--commit Push and commit the audience(s) at the same time
|
|
252
|
+
--environment=<value> [default: development] The environment to push the audience to. Defaults to development.
|
|
253
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/push.ts)_
|
|
257
|
+
|
|
258
|
+
## `knock audience validate [AUDIENCEKEY]`
|
|
259
|
+
|
|
260
|
+
Validate one or more audiences from a local file system.
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
USAGE
|
|
264
|
+
$ knock audience validate [AUDIENCEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
265
|
+
[--audiences-dir <value> --all]
|
|
266
|
+
|
|
267
|
+
FLAGS
|
|
268
|
+
--all Whether to validate all audiences from the target directory.
|
|
269
|
+
--audiences-dir=<value> The target directory path to find all audiences to validate.
|
|
270
|
+
--branch=<value> The slug of the branch to use.
|
|
271
|
+
--environment=<value> [default: development] The environment to validate the audience against. Defaults to
|
|
272
|
+
development.
|
|
273
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/audience/validate.ts)_
|
|
277
|
+
|
|
278
|
+
## `knock branch create [SLUG]`
|
|
91
279
|
|
|
92
280
|
Creates a new branch off of the development environment.
|
|
93
281
|
|
|
94
282
|
```
|
|
95
283
|
USAGE
|
|
96
|
-
$ knock branch create SLUG [--json] [--service-token <value>]
|
|
284
|
+
$ knock branch create [SLUG] [--json] [--service-token <value>]
|
|
97
285
|
|
|
98
286
|
ARGUMENTS
|
|
99
|
-
SLUG The slug for the new branch
|
|
287
|
+
[SLUG] The slug for the new branch
|
|
100
288
|
|
|
101
289
|
FLAGS
|
|
102
290
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
@@ -105,7 +293,7 @@ GLOBAL FLAGS
|
|
|
105
293
|
--json Format output as json.
|
|
106
294
|
```
|
|
107
295
|
|
|
108
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
296
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/create.ts)_
|
|
109
297
|
|
|
110
298
|
## `knock branch delete SLUG`
|
|
111
299
|
|
|
@@ -123,7 +311,7 @@ FLAGS
|
|
|
123
311
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
124
312
|
```
|
|
125
313
|
|
|
126
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
314
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/delete.ts)_
|
|
127
315
|
|
|
128
316
|
## `knock branch exit`
|
|
129
317
|
|
|
@@ -137,7 +325,7 @@ FLAGS
|
|
|
137
325
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
138
326
|
```
|
|
139
327
|
|
|
140
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
328
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/exit.ts)_
|
|
141
329
|
|
|
142
330
|
## `knock branch list`
|
|
143
331
|
|
|
@@ -157,7 +345,7 @@ GLOBAL FLAGS
|
|
|
157
345
|
--json Format output as json.
|
|
158
346
|
```
|
|
159
347
|
|
|
160
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
348
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/list.ts)_
|
|
161
349
|
|
|
162
350
|
## `knock branch merge SLUG`
|
|
163
351
|
|
|
@@ -176,7 +364,7 @@ FLAGS
|
|
|
176
364
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
177
365
|
```
|
|
178
366
|
|
|
179
|
-
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
367
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/merge.ts)_
|
|
180
368
|
|
|
181
369
|
## `knock branch switch SLUG`
|
|
182
370
|
|
|
@@ -195,7 +383,7 @@ FLAGS
|
|
|
195
383
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
196
384
|
```
|
|
197
385
|
|
|
198
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
386
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/branch/switch.ts)_
|
|
199
387
|
|
|
200
388
|
## `knock channel list`
|
|
201
389
|
|
|
@@ -212,7 +400,7 @@ GLOBAL FLAGS
|
|
|
212
400
|
--json Format output as json.
|
|
213
401
|
```
|
|
214
402
|
|
|
215
|
-
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
403
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/channel/list.ts)_
|
|
216
404
|
|
|
217
405
|
## `knock commit`
|
|
218
406
|
|
|
@@ -233,7 +421,7 @@ FLAGS
|
|
|
233
421
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
234
422
|
```
|
|
235
423
|
|
|
236
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
424
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/commit/index.ts)_
|
|
237
425
|
|
|
238
426
|
## `knock commit get ID`
|
|
239
427
|
|
|
@@ -250,7 +438,7 @@ GLOBAL FLAGS
|
|
|
250
438
|
--json Format output as json.
|
|
251
439
|
```
|
|
252
440
|
|
|
253
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
441
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/commit/get.ts)_
|
|
254
442
|
|
|
255
443
|
## `knock commit list`
|
|
256
444
|
|
|
@@ -282,7 +470,7 @@ GLOBAL FLAGS
|
|
|
282
470
|
--json Format output as json.
|
|
283
471
|
```
|
|
284
472
|
|
|
285
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
473
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/commit/list.ts)_
|
|
286
474
|
|
|
287
475
|
## `knock commit promote`
|
|
288
476
|
|
|
@@ -299,7 +487,7 @@ FLAGS
|
|
|
299
487
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
300
488
|
```
|
|
301
489
|
|
|
302
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
490
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/commit/promote.ts)_
|
|
303
491
|
|
|
304
492
|
## `knock environment list`
|
|
305
493
|
|
|
@@ -316,7 +504,7 @@ GLOBAL FLAGS
|
|
|
316
504
|
--json Format output as json.
|
|
317
505
|
```
|
|
318
506
|
|
|
319
|
-
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
507
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/environment/list.ts)_
|
|
320
508
|
|
|
321
509
|
## `knock guide activate GUIDEKEY`
|
|
322
510
|
|
|
@@ -347,7 +535,7 @@ DESCRIPTION
|
|
|
347
535
|
or deactivated at a later time using the --from and --until flags.
|
|
348
536
|
```
|
|
349
537
|
|
|
350
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
538
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/activate.ts)_
|
|
351
539
|
|
|
352
540
|
## `knock guide generate-types`
|
|
353
541
|
|
|
@@ -370,7 +558,7 @@ DESCRIPTION
|
|
|
370
558
|
Generate types for all guides in an environment and write them to a file.
|
|
371
559
|
```
|
|
372
560
|
|
|
373
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
561
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/generate-types.ts)_
|
|
374
562
|
|
|
375
563
|
## `knock guide get GUIDEKEY`
|
|
376
564
|
|
|
@@ -391,7 +579,7 @@ GLOBAL FLAGS
|
|
|
391
579
|
--json Format output as json.
|
|
392
580
|
```
|
|
393
581
|
|
|
394
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
582
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/get.ts)_
|
|
395
583
|
|
|
396
584
|
## `knock guide list`
|
|
397
585
|
|
|
@@ -415,7 +603,7 @@ GLOBAL FLAGS
|
|
|
415
603
|
--json Format output as json.
|
|
416
604
|
```
|
|
417
605
|
|
|
418
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
606
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/list.ts)_
|
|
419
607
|
|
|
420
608
|
## `knock guide new`
|
|
421
609
|
|
|
@@ -439,7 +627,23 @@ FLAGS
|
|
|
439
627
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
440
628
|
```
|
|
441
629
|
|
|
442
|
-
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
630
|
+
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/new.ts)_
|
|
631
|
+
|
|
632
|
+
## `knock guide open GUIDEKEY`
|
|
633
|
+
|
|
634
|
+
Open a guide in the Knock dashboard.
|
|
635
|
+
|
|
636
|
+
```
|
|
637
|
+
USAGE
|
|
638
|
+
$ knock guide open GUIDEKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
639
|
+
|
|
640
|
+
FLAGS
|
|
641
|
+
--branch=<value> The slug of the branch to use.
|
|
642
|
+
--environment=<value> [default: development] The environment to use.
|
|
643
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
644
|
+
```
|
|
645
|
+
|
|
646
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/open.ts)_
|
|
443
647
|
|
|
444
648
|
## `knock guide pull [GUIDEKEY]`
|
|
445
649
|
|
|
@@ -460,7 +664,7 @@ FLAGS
|
|
|
460
664
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
461
665
|
```
|
|
462
666
|
|
|
463
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
667
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/pull.ts)_
|
|
464
668
|
|
|
465
669
|
## `knock guide push [GUIDEKEY]`
|
|
466
670
|
|
|
@@ -481,7 +685,7 @@ FLAGS
|
|
|
481
685
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
482
686
|
```
|
|
483
687
|
|
|
484
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
688
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/push.ts)_
|
|
485
689
|
|
|
486
690
|
## `knock guide validate [GUIDEKEY]`
|
|
487
691
|
|
|
@@ -500,7 +704,7 @@ FLAGS
|
|
|
500
704
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
501
705
|
```
|
|
502
706
|
|
|
503
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
707
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/validate.ts)_
|
|
504
708
|
|
|
505
709
|
## `knock help [COMMAND]`
|
|
506
710
|
|
|
@@ -520,7 +724,7 @@ DESCRIPTION
|
|
|
520
724
|
Display help for knock.
|
|
521
725
|
```
|
|
522
726
|
|
|
523
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
727
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
524
728
|
|
|
525
729
|
## `knock init`
|
|
526
730
|
|
|
@@ -540,7 +744,7 @@ DESCRIPTION
|
|
|
540
744
|
resources directory.
|
|
541
745
|
```
|
|
542
746
|
|
|
543
|
-
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
747
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/init.ts)_
|
|
544
748
|
|
|
545
749
|
## `knock layout get EMAILLAYOUTKEY`
|
|
546
750
|
|
|
@@ -561,7 +765,7 @@ GLOBAL FLAGS
|
|
|
561
765
|
--json Format output as json.
|
|
562
766
|
```
|
|
563
767
|
|
|
564
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
768
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/get.ts)_
|
|
565
769
|
|
|
566
770
|
## `knock layout list`
|
|
567
771
|
|
|
@@ -585,7 +789,7 @@ GLOBAL FLAGS
|
|
|
585
789
|
--json Format output as json.
|
|
586
790
|
```
|
|
587
791
|
|
|
588
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
792
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/list.ts)_
|
|
589
793
|
|
|
590
794
|
## `knock layout new`
|
|
591
795
|
|
|
@@ -608,7 +812,23 @@ FLAGS
|
|
|
608
812
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
609
813
|
```
|
|
610
814
|
|
|
611
|
-
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
815
|
+
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/new.ts)_
|
|
816
|
+
|
|
817
|
+
## `knock layout open LAYOUTKEY`
|
|
818
|
+
|
|
819
|
+
Open a layout in the Knock dashboard.
|
|
820
|
+
|
|
821
|
+
```
|
|
822
|
+
USAGE
|
|
823
|
+
$ knock layout open LAYOUTKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
824
|
+
|
|
825
|
+
FLAGS
|
|
826
|
+
--branch=<value> The slug of the branch to use.
|
|
827
|
+
--environment=<value> [default: development] The environment to use.
|
|
828
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/open.ts)_
|
|
612
832
|
|
|
613
833
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
614
834
|
|
|
@@ -629,7 +849,7 @@ FLAGS
|
|
|
629
849
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
630
850
|
```
|
|
631
851
|
|
|
632
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
852
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/pull.ts)_
|
|
633
853
|
|
|
634
854
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
635
855
|
|
|
@@ -652,7 +872,7 @@ FLAGS
|
|
|
652
872
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
653
873
|
```
|
|
654
874
|
|
|
655
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
875
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/push.ts)_
|
|
656
876
|
|
|
657
877
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
658
878
|
|
|
@@ -672,7 +892,7 @@ FLAGS
|
|
|
672
892
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
673
893
|
```
|
|
674
894
|
|
|
675
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
895
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/validate.ts)_
|
|
676
896
|
|
|
677
897
|
## `knock login`
|
|
678
898
|
|
|
@@ -686,7 +906,7 @@ FLAGS
|
|
|
686
906
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
687
907
|
```
|
|
688
908
|
|
|
689
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
909
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/login.ts)_
|
|
690
910
|
|
|
691
911
|
## `knock logout`
|
|
692
912
|
|
|
@@ -700,7 +920,7 @@ FLAGS
|
|
|
700
920
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
701
921
|
```
|
|
702
922
|
|
|
703
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
923
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/logout.ts)_
|
|
704
924
|
|
|
705
925
|
## `knock message-type get MESSAGETYPEKEY`
|
|
706
926
|
|
|
@@ -721,7 +941,7 @@ GLOBAL FLAGS
|
|
|
721
941
|
--json Format output as json.
|
|
722
942
|
```
|
|
723
943
|
|
|
724
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
944
|
+
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/get.ts)_
|
|
725
945
|
|
|
726
946
|
## `knock message-type list`
|
|
727
947
|
|
|
@@ -745,7 +965,7 @@ GLOBAL FLAGS
|
|
|
745
965
|
--json Format output as json.
|
|
746
966
|
```
|
|
747
967
|
|
|
748
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
968
|
+
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/list.ts)_
|
|
749
969
|
|
|
750
970
|
## `knock message-type new`
|
|
751
971
|
|
|
@@ -768,7 +988,23 @@ FLAGS
|
|
|
768
988
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
769
989
|
```
|
|
770
990
|
|
|
771
|
-
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
991
|
+
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/new.ts)_
|
|
992
|
+
|
|
993
|
+
## `knock message-type open MESSAGETYPEKEY`
|
|
994
|
+
|
|
995
|
+
Open a message type in the Knock dashboard.
|
|
996
|
+
|
|
997
|
+
```
|
|
998
|
+
USAGE
|
|
999
|
+
$ knock message-type open MESSAGETYPEKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1000
|
+
|
|
1001
|
+
FLAGS
|
|
1002
|
+
--branch=<value> The slug of the branch to use.
|
|
1003
|
+
--environment=<value> [default: development] The environment to use.
|
|
1004
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1005
|
+
```
|
|
1006
|
+
|
|
1007
|
+
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/open.ts)_
|
|
772
1008
|
|
|
773
1009
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
774
1010
|
|
|
@@ -789,7 +1025,7 @@ FLAGS
|
|
|
789
1025
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
790
1026
|
```
|
|
791
1027
|
|
|
792
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1028
|
+
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/pull.ts)_
|
|
793
1029
|
|
|
794
1030
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
795
1031
|
|
|
@@ -812,7 +1048,7 @@ FLAGS
|
|
|
812
1048
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
813
1049
|
```
|
|
814
1050
|
|
|
815
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1051
|
+
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/push.ts)_
|
|
816
1052
|
|
|
817
1053
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
818
1054
|
|
|
@@ -833,7 +1069,7 @@ FLAGS
|
|
|
833
1069
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
834
1070
|
```
|
|
835
1071
|
|
|
836
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1072
|
+
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/message-type/validate.ts)_
|
|
837
1073
|
|
|
838
1074
|
## `knock partial get PARTIALKEY`
|
|
839
1075
|
|
|
@@ -854,7 +1090,7 @@ GLOBAL FLAGS
|
|
|
854
1090
|
--json Format output as json.
|
|
855
1091
|
```
|
|
856
1092
|
|
|
857
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1093
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/get.ts)_
|
|
858
1094
|
|
|
859
1095
|
## `knock partial list`
|
|
860
1096
|
|
|
@@ -878,7 +1114,7 @@ GLOBAL FLAGS
|
|
|
878
1114
|
--json Format output as json.
|
|
879
1115
|
```
|
|
880
1116
|
|
|
881
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1117
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/list.ts)_
|
|
882
1118
|
|
|
883
1119
|
## `knock partial new`
|
|
884
1120
|
|
|
@@ -904,7 +1140,23 @@ FLAGS
|
|
|
904
1140
|
with --type.
|
|
905
1141
|
```
|
|
906
1142
|
|
|
907
|
-
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1143
|
+
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/new.ts)_
|
|
1144
|
+
|
|
1145
|
+
## `knock partial open PARTIALKEY`
|
|
1146
|
+
|
|
1147
|
+
Open a partial in the Knock dashboard.
|
|
1148
|
+
|
|
1149
|
+
```
|
|
1150
|
+
USAGE
|
|
1151
|
+
$ knock partial open PARTIALKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1152
|
+
|
|
1153
|
+
FLAGS
|
|
1154
|
+
--branch=<value> The slug of the branch to use.
|
|
1155
|
+
--environment=<value> [default: development] The environment to use.
|
|
1156
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/open.ts)_
|
|
908
1160
|
|
|
909
1161
|
## `knock partial pull [PARTIALKEY]`
|
|
910
1162
|
|
|
@@ -925,7 +1177,7 @@ FLAGS
|
|
|
925
1177
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
926
1178
|
```
|
|
927
1179
|
|
|
928
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1180
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/pull.ts)_
|
|
929
1181
|
|
|
930
1182
|
## `knock partial push [PARTIALKEY]`
|
|
931
1183
|
|
|
@@ -947,7 +1199,7 @@ FLAGS
|
|
|
947
1199
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
948
1200
|
```
|
|
949
1201
|
|
|
950
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1202
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/push.ts)_
|
|
951
1203
|
|
|
952
1204
|
## `knock partial validate [PARTIALKEY]`
|
|
953
1205
|
|
|
@@ -967,7 +1219,7 @@ FLAGS
|
|
|
967
1219
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
968
1220
|
```
|
|
969
1221
|
|
|
970
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1222
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/validate.ts)_
|
|
971
1223
|
|
|
972
1224
|
## `knock pull`
|
|
973
1225
|
|
|
@@ -987,7 +1239,7 @@ FLAGS
|
|
|
987
1239
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
988
1240
|
```
|
|
989
1241
|
|
|
990
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1242
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/pull.ts)_
|
|
991
1243
|
|
|
992
1244
|
## `knock push`
|
|
993
1245
|
|
|
@@ -1008,7 +1260,7 @@ FLAGS
|
|
|
1008
1260
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1009
1261
|
```
|
|
1010
1262
|
|
|
1011
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1263
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/push.ts)_
|
|
1012
1264
|
|
|
1013
1265
|
## `knock translation get TRANSLATIONREF`
|
|
1014
1266
|
|
|
@@ -1036,7 +1288,7 @@ GLOBAL FLAGS
|
|
|
1036
1288
|
--json Format output as json.
|
|
1037
1289
|
```
|
|
1038
1290
|
|
|
1039
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1291
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/translation/get.ts)_
|
|
1040
1292
|
|
|
1041
1293
|
## `knock translation list`
|
|
1042
1294
|
|
|
@@ -1060,7 +1312,7 @@ GLOBAL FLAGS
|
|
|
1060
1312
|
--json Format output as json.
|
|
1061
1313
|
```
|
|
1062
1314
|
|
|
1063
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1315
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/translation/list.ts)_
|
|
1064
1316
|
|
|
1065
1317
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1066
1318
|
|
|
@@ -1088,7 +1340,7 @@ FLAGS
|
|
|
1088
1340
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1089
1341
|
```
|
|
1090
1342
|
|
|
1091
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1343
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/translation/pull.ts)_
|
|
1092
1344
|
|
|
1093
1345
|
## `knock translation push [TRANSLATIONREF]`
|
|
1094
1346
|
|
|
@@ -1116,7 +1368,7 @@ FLAGS
|
|
|
1116
1368
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1117
1369
|
```
|
|
1118
1370
|
|
|
1119
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1371
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/translation/push.ts)_
|
|
1120
1372
|
|
|
1121
1373
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1122
1374
|
|
|
@@ -1142,7 +1394,7 @@ FLAGS
|
|
|
1142
1394
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1143
1395
|
```
|
|
1144
1396
|
|
|
1145
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1397
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/translation/validate.ts)_
|
|
1146
1398
|
|
|
1147
1399
|
## `knock whoami`
|
|
1148
1400
|
|
|
@@ -1159,7 +1411,7 @@ GLOBAL FLAGS
|
|
|
1159
1411
|
--json Format output as json.
|
|
1160
1412
|
```
|
|
1161
1413
|
|
|
1162
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1414
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/whoami.ts)_
|
|
1163
1415
|
|
|
1164
1416
|
## `knock workflow activate WORKFLOWKEY`
|
|
1165
1417
|
|
|
@@ -1188,7 +1440,7 @@ DESCRIPTION
|
|
|
1188
1440
|
with `false` in order to deactivate it.
|
|
1189
1441
|
```
|
|
1190
1442
|
|
|
1191
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1443
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/activate.ts)_
|
|
1192
1444
|
|
|
1193
1445
|
## `knock workflow generate-types`
|
|
1194
1446
|
|
|
@@ -1211,7 +1463,7 @@ DESCRIPTION
|
|
|
1211
1463
|
Generate types for all workflows in an environment and write them to a file.
|
|
1212
1464
|
```
|
|
1213
1465
|
|
|
1214
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1466
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/generate-types.ts)_
|
|
1215
1467
|
|
|
1216
1468
|
## `knock workflow get WORKFLOWKEY`
|
|
1217
1469
|
|
|
@@ -1232,7 +1484,7 @@ GLOBAL FLAGS
|
|
|
1232
1484
|
--json Format output as json.
|
|
1233
1485
|
```
|
|
1234
1486
|
|
|
1235
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1487
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/get.ts)_
|
|
1236
1488
|
|
|
1237
1489
|
## `knock workflow list`
|
|
1238
1490
|
|
|
@@ -1256,7 +1508,7 @@ GLOBAL FLAGS
|
|
|
1256
1508
|
--json Format output as json.
|
|
1257
1509
|
```
|
|
1258
1510
|
|
|
1259
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1511
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/list.ts)_
|
|
1260
1512
|
|
|
1261
1513
|
## `knock workflow new`
|
|
1262
1514
|
|
|
@@ -1281,7 +1533,23 @@ FLAGS
|
|
|
1281
1533
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1282
1534
|
```
|
|
1283
1535
|
|
|
1284
|
-
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1536
|
+
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/new.ts)_
|
|
1537
|
+
|
|
1538
|
+
## `knock workflow open WORKFLOWKEY`
|
|
1539
|
+
|
|
1540
|
+
Open a workflow in the Knock dashboard.
|
|
1541
|
+
|
|
1542
|
+
```
|
|
1543
|
+
USAGE
|
|
1544
|
+
$ knock workflow open WORKFLOWKEY [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1545
|
+
|
|
1546
|
+
FLAGS
|
|
1547
|
+
--branch=<value> The slug of the branch to use.
|
|
1548
|
+
--environment=<value> [default: development] The environment to use.
|
|
1549
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1550
|
+
```
|
|
1551
|
+
|
|
1552
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/open.ts)_
|
|
1285
1553
|
|
|
1286
1554
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1287
1555
|
|
|
@@ -1302,7 +1570,7 @@ FLAGS
|
|
|
1302
1570
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1303
1571
|
```
|
|
1304
1572
|
|
|
1305
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1573
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/pull.ts)_
|
|
1306
1574
|
|
|
1307
1575
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1308
1576
|
|
|
@@ -1323,7 +1591,7 @@ FLAGS
|
|
|
1323
1591
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1324
1592
|
```
|
|
1325
1593
|
|
|
1326
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1594
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/push.ts)_
|
|
1327
1595
|
|
|
1328
1596
|
## `knock workflow run WORKFLOWKEY`
|
|
1329
1597
|
|
|
@@ -1345,7 +1613,7 @@ FLAGS
|
|
|
1345
1613
|
--tenant=<value> A tenant id for the workflow run.
|
|
1346
1614
|
```
|
|
1347
1615
|
|
|
1348
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1616
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/run.ts)_
|
|
1349
1617
|
|
|
1350
1618
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1351
1619
|
|
|
@@ -1364,5 +1632,5 @@ FLAGS
|
|
|
1364
1632
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1365
1633
|
```
|
|
1366
1634
|
|
|
1367
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1635
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/validate.ts)_
|
|
1368
1636
|
<!-- commandsstop -->
|