@knocklabs/cli 1.0.0 → 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 +252 -69
- 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/pull.js +19 -12
- package/dist/commands/push.js +19 -12
- 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 +4 -0
- package/oclif.manifest.json +737 -94
- package/package.json +10 -10
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)
|
|
@@ -92,16 +100,191 @@ USAGE
|
|
|
92
100
|
* [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
|
|
93
101
|
* [`knock workflow validate [WORKFLOWKEY]`](#knock-workflow-validate-workflowkey)
|
|
94
102
|
|
|
95
|
-
## `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]`
|
|
96
279
|
|
|
97
280
|
Creates a new branch off of the development environment.
|
|
98
281
|
|
|
99
282
|
```
|
|
100
283
|
USAGE
|
|
101
|
-
$ knock branch create SLUG [--json] [--service-token <value>]
|
|
284
|
+
$ knock branch create [SLUG] [--json] [--service-token <value>]
|
|
102
285
|
|
|
103
286
|
ARGUMENTS
|
|
104
|
-
SLUG The slug for the new branch
|
|
287
|
+
[SLUG] The slug for the new branch
|
|
105
288
|
|
|
106
289
|
FLAGS
|
|
107
290
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
@@ -110,7 +293,7 @@ GLOBAL FLAGS
|
|
|
110
293
|
--json Format output as json.
|
|
111
294
|
```
|
|
112
295
|
|
|
113
|
-
_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)_
|
|
114
297
|
|
|
115
298
|
## `knock branch delete SLUG`
|
|
116
299
|
|
|
@@ -128,7 +311,7 @@ FLAGS
|
|
|
128
311
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
129
312
|
```
|
|
130
313
|
|
|
131
|
-
_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)_
|
|
132
315
|
|
|
133
316
|
## `knock branch exit`
|
|
134
317
|
|
|
@@ -142,7 +325,7 @@ FLAGS
|
|
|
142
325
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
143
326
|
```
|
|
144
327
|
|
|
145
|
-
_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)_
|
|
146
329
|
|
|
147
330
|
## `knock branch list`
|
|
148
331
|
|
|
@@ -162,7 +345,7 @@ GLOBAL FLAGS
|
|
|
162
345
|
--json Format output as json.
|
|
163
346
|
```
|
|
164
347
|
|
|
165
|
-
_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)_
|
|
166
349
|
|
|
167
350
|
## `knock branch merge SLUG`
|
|
168
351
|
|
|
@@ -181,7 +364,7 @@ FLAGS
|
|
|
181
364
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
182
365
|
```
|
|
183
366
|
|
|
184
|
-
_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)_
|
|
185
368
|
|
|
186
369
|
## `knock branch switch SLUG`
|
|
187
370
|
|
|
@@ -200,7 +383,7 @@ FLAGS
|
|
|
200
383
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
201
384
|
```
|
|
202
385
|
|
|
203
|
-
_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)_
|
|
204
387
|
|
|
205
388
|
## `knock channel list`
|
|
206
389
|
|
|
@@ -217,7 +400,7 @@ GLOBAL FLAGS
|
|
|
217
400
|
--json Format output as json.
|
|
218
401
|
```
|
|
219
402
|
|
|
220
|
-
_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)_
|
|
221
404
|
|
|
222
405
|
## `knock commit`
|
|
223
406
|
|
|
@@ -238,7 +421,7 @@ FLAGS
|
|
|
238
421
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
239
422
|
```
|
|
240
423
|
|
|
241
|
-
_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)_
|
|
242
425
|
|
|
243
426
|
## `knock commit get ID`
|
|
244
427
|
|
|
@@ -255,7 +438,7 @@ GLOBAL FLAGS
|
|
|
255
438
|
--json Format output as json.
|
|
256
439
|
```
|
|
257
440
|
|
|
258
|
-
_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)_
|
|
259
442
|
|
|
260
443
|
## `knock commit list`
|
|
261
444
|
|
|
@@ -287,7 +470,7 @@ GLOBAL FLAGS
|
|
|
287
470
|
--json Format output as json.
|
|
288
471
|
```
|
|
289
472
|
|
|
290
|
-
_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)_
|
|
291
474
|
|
|
292
475
|
## `knock commit promote`
|
|
293
476
|
|
|
@@ -304,7 +487,7 @@ FLAGS
|
|
|
304
487
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
305
488
|
```
|
|
306
489
|
|
|
307
|
-
_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)_
|
|
308
491
|
|
|
309
492
|
## `knock environment list`
|
|
310
493
|
|
|
@@ -321,7 +504,7 @@ GLOBAL FLAGS
|
|
|
321
504
|
--json Format output as json.
|
|
322
505
|
```
|
|
323
506
|
|
|
324
|
-
_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)_
|
|
325
508
|
|
|
326
509
|
## `knock guide activate GUIDEKEY`
|
|
327
510
|
|
|
@@ -352,7 +535,7 @@ DESCRIPTION
|
|
|
352
535
|
or deactivated at a later time using the --from and --until flags.
|
|
353
536
|
```
|
|
354
537
|
|
|
355
|
-
_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)_
|
|
356
539
|
|
|
357
540
|
## `knock guide generate-types`
|
|
358
541
|
|
|
@@ -375,7 +558,7 @@ DESCRIPTION
|
|
|
375
558
|
Generate types for all guides in an environment and write them to a file.
|
|
376
559
|
```
|
|
377
560
|
|
|
378
|
-
_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)_
|
|
379
562
|
|
|
380
563
|
## `knock guide get GUIDEKEY`
|
|
381
564
|
|
|
@@ -396,7 +579,7 @@ GLOBAL FLAGS
|
|
|
396
579
|
--json Format output as json.
|
|
397
580
|
```
|
|
398
581
|
|
|
399
|
-
_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)_
|
|
400
583
|
|
|
401
584
|
## `knock guide list`
|
|
402
585
|
|
|
@@ -420,7 +603,7 @@ GLOBAL FLAGS
|
|
|
420
603
|
--json Format output as json.
|
|
421
604
|
```
|
|
422
605
|
|
|
423
|
-
_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)_
|
|
424
607
|
|
|
425
608
|
## `knock guide new`
|
|
426
609
|
|
|
@@ -444,7 +627,7 @@ FLAGS
|
|
|
444
627
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
445
628
|
```
|
|
446
629
|
|
|
447
|
-
_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)_
|
|
448
631
|
|
|
449
632
|
## `knock guide open GUIDEKEY`
|
|
450
633
|
|
|
@@ -460,7 +643,7 @@ FLAGS
|
|
|
460
643
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
461
644
|
```
|
|
462
645
|
|
|
463
|
-
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
646
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/guide/open.ts)_
|
|
464
647
|
|
|
465
648
|
## `knock guide pull [GUIDEKEY]`
|
|
466
649
|
|
|
@@ -481,7 +664,7 @@ FLAGS
|
|
|
481
664
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
482
665
|
```
|
|
483
666
|
|
|
484
|
-
_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)_
|
|
485
668
|
|
|
486
669
|
## `knock guide push [GUIDEKEY]`
|
|
487
670
|
|
|
@@ -502,7 +685,7 @@ FLAGS
|
|
|
502
685
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
503
686
|
```
|
|
504
687
|
|
|
505
|
-
_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)_
|
|
506
689
|
|
|
507
690
|
## `knock guide validate [GUIDEKEY]`
|
|
508
691
|
|
|
@@ -521,7 +704,7 @@ FLAGS
|
|
|
521
704
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
522
705
|
```
|
|
523
706
|
|
|
524
|
-
_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)_
|
|
525
708
|
|
|
526
709
|
## `knock help [COMMAND]`
|
|
527
710
|
|
|
@@ -541,7 +724,7 @@ DESCRIPTION
|
|
|
541
724
|
Display help for knock.
|
|
542
725
|
```
|
|
543
726
|
|
|
544
|
-
_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)_
|
|
545
728
|
|
|
546
729
|
## `knock init`
|
|
547
730
|
|
|
@@ -561,7 +744,7 @@ DESCRIPTION
|
|
|
561
744
|
resources directory.
|
|
562
745
|
```
|
|
563
746
|
|
|
564
|
-
_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)_
|
|
565
748
|
|
|
566
749
|
## `knock layout get EMAILLAYOUTKEY`
|
|
567
750
|
|
|
@@ -582,7 +765,7 @@ GLOBAL FLAGS
|
|
|
582
765
|
--json Format output as json.
|
|
583
766
|
```
|
|
584
767
|
|
|
585
|
-
_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)_
|
|
586
769
|
|
|
587
770
|
## `knock layout list`
|
|
588
771
|
|
|
@@ -606,7 +789,7 @@ GLOBAL FLAGS
|
|
|
606
789
|
--json Format output as json.
|
|
607
790
|
```
|
|
608
791
|
|
|
609
|
-
_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)_
|
|
610
793
|
|
|
611
794
|
## `knock layout new`
|
|
612
795
|
|
|
@@ -629,7 +812,7 @@ FLAGS
|
|
|
629
812
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
630
813
|
```
|
|
631
814
|
|
|
632
|
-
_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)_
|
|
633
816
|
|
|
634
817
|
## `knock layout open LAYOUTKEY`
|
|
635
818
|
|
|
@@ -645,7 +828,7 @@ FLAGS
|
|
|
645
828
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
646
829
|
```
|
|
647
830
|
|
|
648
|
-
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
831
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/layout/open.ts)_
|
|
649
832
|
|
|
650
833
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
651
834
|
|
|
@@ -666,7 +849,7 @@ FLAGS
|
|
|
666
849
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
667
850
|
```
|
|
668
851
|
|
|
669
|
-
_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)_
|
|
670
853
|
|
|
671
854
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
672
855
|
|
|
@@ -689,7 +872,7 @@ FLAGS
|
|
|
689
872
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
690
873
|
```
|
|
691
874
|
|
|
692
|
-
_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)_
|
|
693
876
|
|
|
694
877
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
695
878
|
|
|
@@ -709,7 +892,7 @@ FLAGS
|
|
|
709
892
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
710
893
|
```
|
|
711
894
|
|
|
712
|
-
_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)_
|
|
713
896
|
|
|
714
897
|
## `knock login`
|
|
715
898
|
|
|
@@ -723,7 +906,7 @@ FLAGS
|
|
|
723
906
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
724
907
|
```
|
|
725
908
|
|
|
726
|
-
_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)_
|
|
727
910
|
|
|
728
911
|
## `knock logout`
|
|
729
912
|
|
|
@@ -737,7 +920,7 @@ FLAGS
|
|
|
737
920
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
738
921
|
```
|
|
739
922
|
|
|
740
|
-
_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)_
|
|
741
924
|
|
|
742
925
|
## `knock message-type get MESSAGETYPEKEY`
|
|
743
926
|
|
|
@@ -758,7 +941,7 @@ GLOBAL FLAGS
|
|
|
758
941
|
--json Format output as json.
|
|
759
942
|
```
|
|
760
943
|
|
|
761
|
-
_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)_
|
|
762
945
|
|
|
763
946
|
## `knock message-type list`
|
|
764
947
|
|
|
@@ -782,7 +965,7 @@ GLOBAL FLAGS
|
|
|
782
965
|
--json Format output as json.
|
|
783
966
|
```
|
|
784
967
|
|
|
785
|
-
_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)_
|
|
786
969
|
|
|
787
970
|
## `knock message-type new`
|
|
788
971
|
|
|
@@ -805,7 +988,7 @@ FLAGS
|
|
|
805
988
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
806
989
|
```
|
|
807
990
|
|
|
808
|
-
_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)_
|
|
809
992
|
|
|
810
993
|
## `knock message-type open MESSAGETYPEKEY`
|
|
811
994
|
|
|
@@ -821,7 +1004,7 @@ FLAGS
|
|
|
821
1004
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
822
1005
|
```
|
|
823
1006
|
|
|
824
|
-
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
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)_
|
|
825
1008
|
|
|
826
1009
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
827
1010
|
|
|
@@ -842,7 +1025,7 @@ FLAGS
|
|
|
842
1025
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
843
1026
|
```
|
|
844
1027
|
|
|
845
|
-
_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)_
|
|
846
1029
|
|
|
847
1030
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
848
1031
|
|
|
@@ -865,7 +1048,7 @@ FLAGS
|
|
|
865
1048
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
866
1049
|
```
|
|
867
1050
|
|
|
868
|
-
_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)_
|
|
869
1052
|
|
|
870
1053
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
871
1054
|
|
|
@@ -886,7 +1069,7 @@ FLAGS
|
|
|
886
1069
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
887
1070
|
```
|
|
888
1071
|
|
|
889
|
-
_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)_
|
|
890
1073
|
|
|
891
1074
|
## `knock partial get PARTIALKEY`
|
|
892
1075
|
|
|
@@ -907,7 +1090,7 @@ GLOBAL FLAGS
|
|
|
907
1090
|
--json Format output as json.
|
|
908
1091
|
```
|
|
909
1092
|
|
|
910
|
-
_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)_
|
|
911
1094
|
|
|
912
1095
|
## `knock partial list`
|
|
913
1096
|
|
|
@@ -931,7 +1114,7 @@ GLOBAL FLAGS
|
|
|
931
1114
|
--json Format output as json.
|
|
932
1115
|
```
|
|
933
1116
|
|
|
934
|
-
_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)_
|
|
935
1118
|
|
|
936
1119
|
## `knock partial new`
|
|
937
1120
|
|
|
@@ -957,7 +1140,7 @@ FLAGS
|
|
|
957
1140
|
with --type.
|
|
958
1141
|
```
|
|
959
1142
|
|
|
960
|
-
_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)_
|
|
961
1144
|
|
|
962
1145
|
## `knock partial open PARTIALKEY`
|
|
963
1146
|
|
|
@@ -973,7 +1156,7 @@ FLAGS
|
|
|
973
1156
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
974
1157
|
```
|
|
975
1158
|
|
|
976
|
-
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1159
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/partial/open.ts)_
|
|
977
1160
|
|
|
978
1161
|
## `knock partial pull [PARTIALKEY]`
|
|
979
1162
|
|
|
@@ -994,7 +1177,7 @@ FLAGS
|
|
|
994
1177
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
995
1178
|
```
|
|
996
1179
|
|
|
997
|
-
_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)_
|
|
998
1181
|
|
|
999
1182
|
## `knock partial push [PARTIALKEY]`
|
|
1000
1183
|
|
|
@@ -1016,7 +1199,7 @@ FLAGS
|
|
|
1016
1199
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1017
1200
|
```
|
|
1018
1201
|
|
|
1019
|
-
_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)_
|
|
1020
1203
|
|
|
1021
1204
|
## `knock partial validate [PARTIALKEY]`
|
|
1022
1205
|
|
|
@@ -1036,7 +1219,7 @@ FLAGS
|
|
|
1036
1219
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1037
1220
|
```
|
|
1038
1221
|
|
|
1039
|
-
_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)_
|
|
1040
1223
|
|
|
1041
1224
|
## `knock pull`
|
|
1042
1225
|
|
|
@@ -1056,7 +1239,7 @@ FLAGS
|
|
|
1056
1239
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1057
1240
|
```
|
|
1058
1241
|
|
|
1059
|
-
_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)_
|
|
1060
1243
|
|
|
1061
1244
|
## `knock push`
|
|
1062
1245
|
|
|
@@ -1077,7 +1260,7 @@ FLAGS
|
|
|
1077
1260
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1078
1261
|
```
|
|
1079
1262
|
|
|
1080
|
-
_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)_
|
|
1081
1264
|
|
|
1082
1265
|
## `knock translation get TRANSLATIONREF`
|
|
1083
1266
|
|
|
@@ -1105,7 +1288,7 @@ GLOBAL FLAGS
|
|
|
1105
1288
|
--json Format output as json.
|
|
1106
1289
|
```
|
|
1107
1290
|
|
|
1108
|
-
_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)_
|
|
1109
1292
|
|
|
1110
1293
|
## `knock translation list`
|
|
1111
1294
|
|
|
@@ -1129,7 +1312,7 @@ GLOBAL FLAGS
|
|
|
1129
1312
|
--json Format output as json.
|
|
1130
1313
|
```
|
|
1131
1314
|
|
|
1132
|
-
_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)_
|
|
1133
1316
|
|
|
1134
1317
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1135
1318
|
|
|
@@ -1157,7 +1340,7 @@ FLAGS
|
|
|
1157
1340
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1158
1341
|
```
|
|
1159
1342
|
|
|
1160
|
-
_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)_
|
|
1161
1344
|
|
|
1162
1345
|
## `knock translation push [TRANSLATIONREF]`
|
|
1163
1346
|
|
|
@@ -1185,7 +1368,7 @@ FLAGS
|
|
|
1185
1368
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1186
1369
|
```
|
|
1187
1370
|
|
|
1188
|
-
_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)_
|
|
1189
1372
|
|
|
1190
1373
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1191
1374
|
|
|
@@ -1211,7 +1394,7 @@ FLAGS
|
|
|
1211
1394
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1212
1395
|
```
|
|
1213
1396
|
|
|
1214
|
-
_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)_
|
|
1215
1398
|
|
|
1216
1399
|
## `knock whoami`
|
|
1217
1400
|
|
|
@@ -1228,7 +1411,7 @@ GLOBAL FLAGS
|
|
|
1228
1411
|
--json Format output as json.
|
|
1229
1412
|
```
|
|
1230
1413
|
|
|
1231
|
-
_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)_
|
|
1232
1415
|
|
|
1233
1416
|
## `knock workflow activate WORKFLOWKEY`
|
|
1234
1417
|
|
|
@@ -1257,7 +1440,7 @@ DESCRIPTION
|
|
|
1257
1440
|
with `false` in order to deactivate it.
|
|
1258
1441
|
```
|
|
1259
1442
|
|
|
1260
|
-
_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)_
|
|
1261
1444
|
|
|
1262
1445
|
## `knock workflow generate-types`
|
|
1263
1446
|
|
|
@@ -1280,7 +1463,7 @@ DESCRIPTION
|
|
|
1280
1463
|
Generate types for all workflows in an environment and write them to a file.
|
|
1281
1464
|
```
|
|
1282
1465
|
|
|
1283
|
-
_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)_
|
|
1284
1467
|
|
|
1285
1468
|
## `knock workflow get WORKFLOWKEY`
|
|
1286
1469
|
|
|
@@ -1301,7 +1484,7 @@ GLOBAL FLAGS
|
|
|
1301
1484
|
--json Format output as json.
|
|
1302
1485
|
```
|
|
1303
1486
|
|
|
1304
|
-
_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)_
|
|
1305
1488
|
|
|
1306
1489
|
## `knock workflow list`
|
|
1307
1490
|
|
|
@@ -1325,7 +1508,7 @@ GLOBAL FLAGS
|
|
|
1325
1508
|
--json Format output as json.
|
|
1326
1509
|
```
|
|
1327
1510
|
|
|
1328
|
-
_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)_
|
|
1329
1512
|
|
|
1330
1513
|
## `knock workflow new`
|
|
1331
1514
|
|
|
@@ -1350,7 +1533,7 @@ FLAGS
|
|
|
1350
1533
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1351
1534
|
```
|
|
1352
1535
|
|
|
1353
|
-
_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)_
|
|
1354
1537
|
|
|
1355
1538
|
## `knock workflow open WORKFLOWKEY`
|
|
1356
1539
|
|
|
@@ -1366,7 +1549,7 @@ FLAGS
|
|
|
1366
1549
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1367
1550
|
```
|
|
1368
1551
|
|
|
1369
|
-
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1552
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.2/src/commands/workflow/open.ts)_
|
|
1370
1553
|
|
|
1371
1554
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1372
1555
|
|
|
@@ -1387,7 +1570,7 @@ FLAGS
|
|
|
1387
1570
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1388
1571
|
```
|
|
1389
1572
|
|
|
1390
|
-
_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)_
|
|
1391
1574
|
|
|
1392
1575
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1393
1576
|
|
|
@@ -1408,7 +1591,7 @@ FLAGS
|
|
|
1408
1591
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1409
1592
|
```
|
|
1410
1593
|
|
|
1411
|
-
_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)_
|
|
1412
1595
|
|
|
1413
1596
|
## `knock workflow run WORKFLOWKEY`
|
|
1414
1597
|
|
|
@@ -1430,7 +1613,7 @@ FLAGS
|
|
|
1430
1613
|
--tenant=<value> A tenant id for the workflow run.
|
|
1431
1614
|
```
|
|
1432
1615
|
|
|
1433
|
-
_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)_
|
|
1434
1617
|
|
|
1435
1618
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1436
1619
|
|
|
@@ -1449,5 +1632,5 @@ FLAGS
|
|
|
1449
1632
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1450
1633
|
```
|
|
1451
1634
|
|
|
1452
|
-
_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)_
|
|
1453
1636
|
<!-- commandsstop -->
|