@knocklabs/cli 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +283 -76
- 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 +172 -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/push.js +2 -1
- package/dist/commands/layout/push.js +2 -1
- package/dist/commands/message-type/push.js +2 -1
- package/dist/commands/partial/push.js +2 -1
- package/dist/commands/pull.js +19 -12
- package/dist/commands/push.js +24 -13
- package/dist/commands/translation/push.js +2 -1
- package/dist/commands/workflow/push.js +2 -1
- package/dist/lib/api-v1.js +12 -6
- package/dist/lib/helpers/flag.js +6 -0
- package/dist/lib/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/marshal/translation/helpers.js +2 -1
- package/dist/lib/marshal/translation/reader.js +1 -1
- package/dist/lib/resources.js +3 -0
- package/dist/lib/run-context/loader.js +9 -20
- package/dist/lib/urls.js +4 -0
- package/oclif.manifest.json +879 -188
- 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.3 linux-x64 node-v22.22.1
|
|
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,194 @@ 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.3/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.3/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.3/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.3/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.3/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.3/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] [--force]
|
|
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
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
254
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
255
|
+
you `commit` the changes.
|
|
256
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/push.ts)_
|
|
260
|
+
|
|
261
|
+
## `knock audience validate [AUDIENCEKEY]`
|
|
262
|
+
|
|
263
|
+
Validate one or more audiences from a local file system.
|
|
264
|
+
|
|
265
|
+
```
|
|
266
|
+
USAGE
|
|
267
|
+
$ knock audience validate [AUDIENCEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
268
|
+
[--audiences-dir <value> --all]
|
|
269
|
+
|
|
270
|
+
FLAGS
|
|
271
|
+
--all Whether to validate all audiences from the target directory.
|
|
272
|
+
--audiences-dir=<value> The target directory path to find all audiences to validate.
|
|
273
|
+
--branch=<value> The slug of the branch to use.
|
|
274
|
+
--environment=<value> [default: development] The environment to validate the audience against. Defaults to
|
|
275
|
+
development.
|
|
276
|
+
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/audience/validate.ts)_
|
|
280
|
+
|
|
281
|
+
## `knock branch create [SLUG]`
|
|
96
282
|
|
|
97
283
|
Creates a new branch off of the development environment.
|
|
98
284
|
|
|
99
285
|
```
|
|
100
286
|
USAGE
|
|
101
|
-
$ knock branch create SLUG [--json] [--service-token <value>]
|
|
287
|
+
$ knock branch create [SLUG] [--json] [--service-token <value>]
|
|
102
288
|
|
|
103
289
|
ARGUMENTS
|
|
104
|
-
SLUG The slug for the new branch
|
|
290
|
+
[SLUG] The slug for the new branch
|
|
105
291
|
|
|
106
292
|
FLAGS
|
|
107
293
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
@@ -110,7 +296,7 @@ GLOBAL FLAGS
|
|
|
110
296
|
--json Format output as json.
|
|
111
297
|
```
|
|
112
298
|
|
|
113
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
299
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/create.ts)_
|
|
114
300
|
|
|
115
301
|
## `knock branch delete SLUG`
|
|
116
302
|
|
|
@@ -128,7 +314,7 @@ FLAGS
|
|
|
128
314
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
129
315
|
```
|
|
130
316
|
|
|
131
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
317
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/delete.ts)_
|
|
132
318
|
|
|
133
319
|
## `knock branch exit`
|
|
134
320
|
|
|
@@ -142,7 +328,7 @@ FLAGS
|
|
|
142
328
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
143
329
|
```
|
|
144
330
|
|
|
145
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
331
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/exit.ts)_
|
|
146
332
|
|
|
147
333
|
## `knock branch list`
|
|
148
334
|
|
|
@@ -162,7 +348,7 @@ GLOBAL FLAGS
|
|
|
162
348
|
--json Format output as json.
|
|
163
349
|
```
|
|
164
350
|
|
|
165
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
351
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/list.ts)_
|
|
166
352
|
|
|
167
353
|
## `knock branch merge SLUG`
|
|
168
354
|
|
|
@@ -181,7 +367,7 @@ FLAGS
|
|
|
181
367
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
182
368
|
```
|
|
183
369
|
|
|
184
|
-
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
370
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/merge.ts)_
|
|
185
371
|
|
|
186
372
|
## `knock branch switch SLUG`
|
|
187
373
|
|
|
@@ -200,7 +386,7 @@ FLAGS
|
|
|
200
386
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
201
387
|
```
|
|
202
388
|
|
|
203
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
389
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/branch/switch.ts)_
|
|
204
390
|
|
|
205
391
|
## `knock channel list`
|
|
206
392
|
|
|
@@ -217,7 +403,7 @@ GLOBAL FLAGS
|
|
|
217
403
|
--json Format output as json.
|
|
218
404
|
```
|
|
219
405
|
|
|
220
|
-
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
406
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/channel/list.ts)_
|
|
221
407
|
|
|
222
408
|
## `knock commit`
|
|
223
409
|
|
|
@@ -238,7 +424,7 @@ FLAGS
|
|
|
238
424
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
239
425
|
```
|
|
240
426
|
|
|
241
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
427
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/index.ts)_
|
|
242
428
|
|
|
243
429
|
## `knock commit get ID`
|
|
244
430
|
|
|
@@ -255,7 +441,7 @@ GLOBAL FLAGS
|
|
|
255
441
|
--json Format output as json.
|
|
256
442
|
```
|
|
257
443
|
|
|
258
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
444
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/get.ts)_
|
|
259
445
|
|
|
260
446
|
## `knock commit list`
|
|
261
447
|
|
|
@@ -287,7 +473,7 @@ GLOBAL FLAGS
|
|
|
287
473
|
--json Format output as json.
|
|
288
474
|
```
|
|
289
475
|
|
|
290
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
476
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/list.ts)_
|
|
291
477
|
|
|
292
478
|
## `knock commit promote`
|
|
293
479
|
|
|
@@ -304,7 +490,7 @@ FLAGS
|
|
|
304
490
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
305
491
|
```
|
|
306
492
|
|
|
307
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
493
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/commit/promote.ts)_
|
|
308
494
|
|
|
309
495
|
## `knock environment list`
|
|
310
496
|
|
|
@@ -321,7 +507,7 @@ GLOBAL FLAGS
|
|
|
321
507
|
--json Format output as json.
|
|
322
508
|
```
|
|
323
509
|
|
|
324
|
-
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
510
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/environment/list.ts)_
|
|
325
511
|
|
|
326
512
|
## `knock guide activate GUIDEKEY`
|
|
327
513
|
|
|
@@ -352,7 +538,7 @@ DESCRIPTION
|
|
|
352
538
|
or deactivated at a later time using the --from and --until flags.
|
|
353
539
|
```
|
|
354
540
|
|
|
355
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
541
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/activate.ts)_
|
|
356
542
|
|
|
357
543
|
## `knock guide generate-types`
|
|
358
544
|
|
|
@@ -375,7 +561,7 @@ DESCRIPTION
|
|
|
375
561
|
Generate types for all guides in an environment and write them to a file.
|
|
376
562
|
```
|
|
377
563
|
|
|
378
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
564
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/generate-types.ts)_
|
|
379
565
|
|
|
380
566
|
## `knock guide get GUIDEKEY`
|
|
381
567
|
|
|
@@ -396,7 +582,7 @@ GLOBAL FLAGS
|
|
|
396
582
|
--json Format output as json.
|
|
397
583
|
```
|
|
398
584
|
|
|
399
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
585
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/get.ts)_
|
|
400
586
|
|
|
401
587
|
## `knock guide list`
|
|
402
588
|
|
|
@@ -420,7 +606,7 @@ GLOBAL FLAGS
|
|
|
420
606
|
--json Format output as json.
|
|
421
607
|
```
|
|
422
608
|
|
|
423
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
609
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/list.ts)_
|
|
424
610
|
|
|
425
611
|
## `knock guide new`
|
|
426
612
|
|
|
@@ -444,7 +630,7 @@ FLAGS
|
|
|
444
630
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
445
631
|
```
|
|
446
632
|
|
|
447
|
-
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
633
|
+
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/new.ts)_
|
|
448
634
|
|
|
449
635
|
## `knock guide open GUIDEKEY`
|
|
450
636
|
|
|
@@ -460,7 +646,7 @@ FLAGS
|
|
|
460
646
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
461
647
|
```
|
|
462
648
|
|
|
463
|
-
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
649
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/open.ts)_
|
|
464
650
|
|
|
465
651
|
## `knock guide pull [GUIDEKEY]`
|
|
466
652
|
|
|
@@ -481,7 +667,7 @@ FLAGS
|
|
|
481
667
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
482
668
|
```
|
|
483
669
|
|
|
484
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
670
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/pull.ts)_
|
|
485
671
|
|
|
486
672
|
## `knock guide push [GUIDEKEY]`
|
|
487
673
|
|
|
@@ -490,7 +676,7 @@ Push one or more guides from a local file system to Knock.
|
|
|
490
676
|
```
|
|
491
677
|
USAGE
|
|
492
678
|
$ knock guide push [GUIDEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
493
|
-
[--guides-dir <value> --all] [-m <value> --commit]
|
|
679
|
+
[--guides-dir <value> --all] [-m <value> --commit] [--force]
|
|
494
680
|
|
|
495
681
|
FLAGS
|
|
496
682
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -498,11 +684,14 @@ FLAGS
|
|
|
498
684
|
--branch=<value> The slug of the branch to use.
|
|
499
685
|
--commit Push and commit the guide(s) at the same time
|
|
500
686
|
--environment=<value> [default: development] The environment to push the guide to. Defaults to development.
|
|
687
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
688
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
689
|
+
you `commit` the changes.
|
|
501
690
|
--guides-dir=<value> The target directory path to find all guides to push.
|
|
502
691
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
503
692
|
```
|
|
504
693
|
|
|
505
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
694
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/push.ts)_
|
|
506
695
|
|
|
507
696
|
## `knock guide validate [GUIDEKEY]`
|
|
508
697
|
|
|
@@ -521,7 +710,7 @@ FLAGS
|
|
|
521
710
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
522
711
|
```
|
|
523
712
|
|
|
524
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
713
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/guide/validate.ts)_
|
|
525
714
|
|
|
526
715
|
## `knock help [COMMAND]`
|
|
527
716
|
|
|
@@ -541,7 +730,7 @@ DESCRIPTION
|
|
|
541
730
|
Display help for knock.
|
|
542
731
|
```
|
|
543
732
|
|
|
544
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
733
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
545
734
|
|
|
546
735
|
## `knock init`
|
|
547
736
|
|
|
@@ -561,7 +750,7 @@ DESCRIPTION
|
|
|
561
750
|
resources directory.
|
|
562
751
|
```
|
|
563
752
|
|
|
564
|
-
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
753
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/init.ts)_
|
|
565
754
|
|
|
566
755
|
## `knock layout get EMAILLAYOUTKEY`
|
|
567
756
|
|
|
@@ -582,7 +771,7 @@ GLOBAL FLAGS
|
|
|
582
771
|
--json Format output as json.
|
|
583
772
|
```
|
|
584
773
|
|
|
585
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
774
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/get.ts)_
|
|
586
775
|
|
|
587
776
|
## `knock layout list`
|
|
588
777
|
|
|
@@ -606,7 +795,7 @@ GLOBAL FLAGS
|
|
|
606
795
|
--json Format output as json.
|
|
607
796
|
```
|
|
608
797
|
|
|
609
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
798
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/list.ts)_
|
|
610
799
|
|
|
611
800
|
## `knock layout new`
|
|
612
801
|
|
|
@@ -629,7 +818,7 @@ FLAGS
|
|
|
629
818
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
630
819
|
```
|
|
631
820
|
|
|
632
|
-
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
821
|
+
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/new.ts)_
|
|
633
822
|
|
|
634
823
|
## `knock layout open LAYOUTKEY`
|
|
635
824
|
|
|
@@ -645,7 +834,7 @@ FLAGS
|
|
|
645
834
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
646
835
|
```
|
|
647
836
|
|
|
648
|
-
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
837
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/open.ts)_
|
|
649
838
|
|
|
650
839
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
651
840
|
|
|
@@ -666,7 +855,7 @@ FLAGS
|
|
|
666
855
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
667
856
|
```
|
|
668
857
|
|
|
669
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
858
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/pull.ts)_
|
|
670
859
|
|
|
671
860
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
672
861
|
|
|
@@ -675,7 +864,7 @@ Push one or more email layouts from a local file system to Knock.
|
|
|
675
864
|
```
|
|
676
865
|
USAGE
|
|
677
866
|
$ knock layout push [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
678
|
-
[--layouts-dir <value> --all] [-m <value> --commit]
|
|
867
|
+
[--layouts-dir <value> --all] [-m <value> --commit] [--force]
|
|
679
868
|
|
|
680
869
|
FLAGS
|
|
681
870
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -685,11 +874,14 @@ FLAGS
|
|
|
685
874
|
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
686
875
|
environment
|
|
687
876
|
<options: development>
|
|
877
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
878
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
879
|
+
you `commit` the changes.
|
|
688
880
|
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
689
881
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
690
882
|
```
|
|
691
883
|
|
|
692
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
884
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/push.ts)_
|
|
693
885
|
|
|
694
886
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
695
887
|
|
|
@@ -709,7 +901,7 @@ FLAGS
|
|
|
709
901
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
710
902
|
```
|
|
711
903
|
|
|
712
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
904
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/layout/validate.ts)_
|
|
713
905
|
|
|
714
906
|
## `knock login`
|
|
715
907
|
|
|
@@ -723,7 +915,7 @@ FLAGS
|
|
|
723
915
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
724
916
|
```
|
|
725
917
|
|
|
726
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
918
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/login.ts)_
|
|
727
919
|
|
|
728
920
|
## `knock logout`
|
|
729
921
|
|
|
@@ -737,7 +929,7 @@ FLAGS
|
|
|
737
929
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
738
930
|
```
|
|
739
931
|
|
|
740
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
932
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/logout.ts)_
|
|
741
933
|
|
|
742
934
|
## `knock message-type get MESSAGETYPEKEY`
|
|
743
935
|
|
|
@@ -758,7 +950,7 @@ GLOBAL FLAGS
|
|
|
758
950
|
--json Format output as json.
|
|
759
951
|
```
|
|
760
952
|
|
|
761
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
953
|
+
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/get.ts)_
|
|
762
954
|
|
|
763
955
|
## `knock message-type list`
|
|
764
956
|
|
|
@@ -782,7 +974,7 @@ GLOBAL FLAGS
|
|
|
782
974
|
--json Format output as json.
|
|
783
975
|
```
|
|
784
976
|
|
|
785
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
977
|
+
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/list.ts)_
|
|
786
978
|
|
|
787
979
|
## `knock message-type new`
|
|
788
980
|
|
|
@@ -805,7 +997,7 @@ FLAGS
|
|
|
805
997
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
806
998
|
```
|
|
807
999
|
|
|
808
|
-
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1000
|
+
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/new.ts)_
|
|
809
1001
|
|
|
810
1002
|
## `knock message-type open MESSAGETYPEKEY`
|
|
811
1003
|
|
|
@@ -821,7 +1013,7 @@ FLAGS
|
|
|
821
1013
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
822
1014
|
```
|
|
823
1015
|
|
|
824
|
-
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1016
|
+
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/open.ts)_
|
|
825
1017
|
|
|
826
1018
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
827
1019
|
|
|
@@ -842,7 +1034,7 @@ FLAGS
|
|
|
842
1034
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
843
1035
|
```
|
|
844
1036
|
|
|
845
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1037
|
+
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/pull.ts)_
|
|
846
1038
|
|
|
847
1039
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
848
1040
|
|
|
@@ -851,7 +1043,7 @@ Push one or more message types from a local file system to Knock.
|
|
|
851
1043
|
```
|
|
852
1044
|
USAGE
|
|
853
1045
|
$ knock message-type push [MESSAGETYPEKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
854
|
-
[--message-types-dir <value> --all] [-m <value> --commit]
|
|
1046
|
+
[--message-types-dir <value> --all] [-m <value> --commit] [--force]
|
|
855
1047
|
|
|
856
1048
|
FLAGS
|
|
857
1049
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -861,11 +1053,14 @@ FLAGS
|
|
|
861
1053
|
--environment=<option> [default: development] Pushing a message type is only allowed in the development
|
|
862
1054
|
environment
|
|
863
1055
|
<options: development>
|
|
1056
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1057
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1058
|
+
you `commit` the changes.
|
|
864
1059
|
--message-types-dir=<value> The target directory path to find all message types to push.
|
|
865
1060
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
866
1061
|
```
|
|
867
1062
|
|
|
868
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1063
|
+
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/push.ts)_
|
|
869
1064
|
|
|
870
1065
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
871
1066
|
|
|
@@ -886,7 +1081,7 @@ FLAGS
|
|
|
886
1081
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
887
1082
|
```
|
|
888
1083
|
|
|
889
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1084
|
+
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/message-type/validate.ts)_
|
|
890
1085
|
|
|
891
1086
|
## `knock partial get PARTIALKEY`
|
|
892
1087
|
|
|
@@ -907,7 +1102,7 @@ GLOBAL FLAGS
|
|
|
907
1102
|
--json Format output as json.
|
|
908
1103
|
```
|
|
909
1104
|
|
|
910
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1105
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/get.ts)_
|
|
911
1106
|
|
|
912
1107
|
## `knock partial list`
|
|
913
1108
|
|
|
@@ -931,7 +1126,7 @@ GLOBAL FLAGS
|
|
|
931
1126
|
--json Format output as json.
|
|
932
1127
|
```
|
|
933
1128
|
|
|
934
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1129
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/list.ts)_
|
|
935
1130
|
|
|
936
1131
|
## `knock partial new`
|
|
937
1132
|
|
|
@@ -957,7 +1152,7 @@ FLAGS
|
|
|
957
1152
|
with --type.
|
|
958
1153
|
```
|
|
959
1154
|
|
|
960
|
-
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1155
|
+
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/new.ts)_
|
|
961
1156
|
|
|
962
1157
|
## `knock partial open PARTIALKEY`
|
|
963
1158
|
|
|
@@ -973,7 +1168,7 @@ FLAGS
|
|
|
973
1168
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
974
1169
|
```
|
|
975
1170
|
|
|
976
|
-
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1171
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/open.ts)_
|
|
977
1172
|
|
|
978
1173
|
## `knock partial pull [PARTIALKEY]`
|
|
979
1174
|
|
|
@@ -994,7 +1189,7 @@ FLAGS
|
|
|
994
1189
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
995
1190
|
```
|
|
996
1191
|
|
|
997
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1192
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/pull.ts)_
|
|
998
1193
|
|
|
999
1194
|
## `knock partial push [PARTIALKEY]`
|
|
1000
1195
|
|
|
@@ -1003,7 +1198,7 @@ Push one or more partials from a local file system to Knock.
|
|
|
1003
1198
|
```
|
|
1004
1199
|
USAGE
|
|
1005
1200
|
$ knock partial push [PARTIALKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1006
|
-
[--partials-dir <value> --all] [-m <value> --commit]
|
|
1201
|
+
[--partials-dir <value> --all] [-m <value> --commit] [--force]
|
|
1007
1202
|
|
|
1008
1203
|
FLAGS
|
|
1009
1204
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1012,11 +1207,14 @@ FLAGS
|
|
|
1012
1207
|
--commit Push and commit the partial(s) at the same time
|
|
1013
1208
|
--environment=<option> [default: development] Pushing a partial is only allowed in the development environment
|
|
1014
1209
|
<options: development>
|
|
1210
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1211
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1212
|
+
you `commit` the changes.
|
|
1015
1213
|
--partials-dir=<value> The target directory path to find all partials to push.
|
|
1016
1214
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1017
1215
|
```
|
|
1018
1216
|
|
|
1019
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1217
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/push.ts)_
|
|
1020
1218
|
|
|
1021
1219
|
## `knock partial validate [PARTIALKEY]`
|
|
1022
1220
|
|
|
@@ -1036,7 +1234,7 @@ FLAGS
|
|
|
1036
1234
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1037
1235
|
```
|
|
1038
1236
|
|
|
1039
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1237
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/partial/validate.ts)_
|
|
1040
1238
|
|
|
1041
1239
|
## `knock pull`
|
|
1042
1240
|
|
|
@@ -1056,7 +1254,7 @@ FLAGS
|
|
|
1056
1254
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1057
1255
|
```
|
|
1058
1256
|
|
|
1059
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1257
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/pull.ts)_
|
|
1060
1258
|
|
|
1061
1259
|
## `knock push`
|
|
1062
1260
|
|
|
@@ -1065,7 +1263,7 @@ Push all resources from a local file system to Knock.
|
|
|
1065
1263
|
```
|
|
1066
1264
|
USAGE
|
|
1067
1265
|
$ knock push [--service-token <value>] [--environment development] [--branch <value>] [--knock-dir
|
|
1068
|
-
<value>] [-m <value> --commit]
|
|
1266
|
+
<value>] [-m <value> --commit] [--force]
|
|
1069
1267
|
|
|
1070
1268
|
FLAGS
|
|
1071
1269
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1073,11 +1271,14 @@ FLAGS
|
|
|
1073
1271
|
--commit Push and commit the resource(s) at the same time
|
|
1074
1272
|
--environment=<option> [default: development] Pushing resources is only allowed in the development environment
|
|
1075
1273
|
<options: development>
|
|
1274
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1275
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1276
|
+
you `commit` the changes.
|
|
1076
1277
|
--knock-dir=<value> The target directory path to find all resources to push.
|
|
1077
1278
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1078
1279
|
```
|
|
1079
1280
|
|
|
1080
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1281
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/push.ts)_
|
|
1081
1282
|
|
|
1082
1283
|
## `knock translation get TRANSLATIONREF`
|
|
1083
1284
|
|
|
@@ -1105,7 +1306,7 @@ GLOBAL FLAGS
|
|
|
1105
1306
|
--json Format output as json.
|
|
1106
1307
|
```
|
|
1107
1308
|
|
|
1108
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1309
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/get.ts)_
|
|
1109
1310
|
|
|
1110
1311
|
## `knock translation list`
|
|
1111
1312
|
|
|
@@ -1129,7 +1330,7 @@ GLOBAL FLAGS
|
|
|
1129
1330
|
--json Format output as json.
|
|
1130
1331
|
```
|
|
1131
1332
|
|
|
1132
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1333
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/list.ts)_
|
|
1133
1334
|
|
|
1134
1335
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1135
1336
|
|
|
@@ -1157,7 +1358,7 @@ FLAGS
|
|
|
1157
1358
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1158
1359
|
```
|
|
1159
1360
|
|
|
1160
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1361
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/pull.ts)_
|
|
1161
1362
|
|
|
1162
1363
|
## `knock translation push [TRANSLATIONREF]`
|
|
1163
1364
|
|
|
@@ -1166,7 +1367,7 @@ Push one or more translations from a local file system to Knock.
|
|
|
1166
1367
|
```
|
|
1167
1368
|
USAGE
|
|
1168
1369
|
$ knock translation push [TRANSLATIONREF] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1169
|
-
[--translations-dir <value> --all] [-m <value> --commit]
|
|
1370
|
+
[--translations-dir <value> --all] [-m <value> --commit] [--force]
|
|
1170
1371
|
|
|
1171
1372
|
ARGUMENTS
|
|
1172
1373
|
[TRANSLATIONREF] Translation ref is a identifier string that refers to a unique translation.
|
|
@@ -1181,11 +1382,14 @@ FLAGS
|
|
|
1181
1382
|
--environment=<option> [default: development] Pushing a translation is only allowed in the development
|
|
1182
1383
|
environment
|
|
1183
1384
|
<options: development>
|
|
1385
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1386
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1387
|
+
you `commit` the changes.
|
|
1184
1388
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1185
1389
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1186
1390
|
```
|
|
1187
1391
|
|
|
1188
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1392
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/push.ts)_
|
|
1189
1393
|
|
|
1190
1394
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1191
1395
|
|
|
@@ -1211,7 +1415,7 @@ FLAGS
|
|
|
1211
1415
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1212
1416
|
```
|
|
1213
1417
|
|
|
1214
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1418
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/translation/validate.ts)_
|
|
1215
1419
|
|
|
1216
1420
|
## `knock whoami`
|
|
1217
1421
|
|
|
@@ -1228,7 +1432,7 @@ GLOBAL FLAGS
|
|
|
1228
1432
|
--json Format output as json.
|
|
1229
1433
|
```
|
|
1230
1434
|
|
|
1231
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1435
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/whoami.ts)_
|
|
1232
1436
|
|
|
1233
1437
|
## `knock workflow activate WORKFLOWKEY`
|
|
1234
1438
|
|
|
@@ -1257,7 +1461,7 @@ DESCRIPTION
|
|
|
1257
1461
|
with `false` in order to deactivate it.
|
|
1258
1462
|
```
|
|
1259
1463
|
|
|
1260
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1464
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/activate.ts)_
|
|
1261
1465
|
|
|
1262
1466
|
## `knock workflow generate-types`
|
|
1263
1467
|
|
|
@@ -1280,7 +1484,7 @@ DESCRIPTION
|
|
|
1280
1484
|
Generate types for all workflows in an environment and write them to a file.
|
|
1281
1485
|
```
|
|
1282
1486
|
|
|
1283
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1487
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/generate-types.ts)_
|
|
1284
1488
|
|
|
1285
1489
|
## `knock workflow get WORKFLOWKEY`
|
|
1286
1490
|
|
|
@@ -1301,7 +1505,7 @@ GLOBAL FLAGS
|
|
|
1301
1505
|
--json Format output as json.
|
|
1302
1506
|
```
|
|
1303
1507
|
|
|
1304
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1508
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/get.ts)_
|
|
1305
1509
|
|
|
1306
1510
|
## `knock workflow list`
|
|
1307
1511
|
|
|
@@ -1325,7 +1529,7 @@ GLOBAL FLAGS
|
|
|
1325
1529
|
--json Format output as json.
|
|
1326
1530
|
```
|
|
1327
1531
|
|
|
1328
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1532
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/list.ts)_
|
|
1329
1533
|
|
|
1330
1534
|
## `knock workflow new`
|
|
1331
1535
|
|
|
@@ -1350,7 +1554,7 @@ FLAGS
|
|
|
1350
1554
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1351
1555
|
```
|
|
1352
1556
|
|
|
1353
|
-
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1557
|
+
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/new.ts)_
|
|
1354
1558
|
|
|
1355
1559
|
## `knock workflow open WORKFLOWKEY`
|
|
1356
1560
|
|
|
@@ -1366,7 +1570,7 @@ FLAGS
|
|
|
1366
1570
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1367
1571
|
```
|
|
1368
1572
|
|
|
1369
|
-
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1573
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/open.ts)_
|
|
1370
1574
|
|
|
1371
1575
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1372
1576
|
|
|
@@ -1387,7 +1591,7 @@ FLAGS
|
|
|
1387
1591
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1388
1592
|
```
|
|
1389
1593
|
|
|
1390
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1594
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/pull.ts)_
|
|
1391
1595
|
|
|
1392
1596
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1393
1597
|
|
|
@@ -1396,7 +1600,7 @@ Push one or more workflows from a local file system to Knock.
|
|
|
1396
1600
|
```
|
|
1397
1601
|
USAGE
|
|
1398
1602
|
$ knock workflow push [WORKFLOWKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1399
|
-
[--workflows-dir <value> --all] [-m <value> --commit]
|
|
1603
|
+
[--workflows-dir <value> --all] [-m <value> --commit] [--force]
|
|
1400
1604
|
|
|
1401
1605
|
FLAGS
|
|
1402
1606
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -1404,11 +1608,14 @@ FLAGS
|
|
|
1404
1608
|
--branch=<value> The slug of the branch to use.
|
|
1405
1609
|
--commit Push and commit the workflow(s) at the same time
|
|
1406
1610
|
--environment=<value> [default: development] The environment to push the workflow to. Defaults to development.
|
|
1611
|
+
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1612
|
+
stored. If you're using this on a non-development environment, you should also ensure
|
|
1613
|
+
you `commit` the changes.
|
|
1407
1614
|
--service-token=<value> [env: KNOCK_SERVICE_TOKEN] The service token to authenticate with.
|
|
1408
1615
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1409
1616
|
```
|
|
1410
1617
|
|
|
1411
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1618
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/push.ts)_
|
|
1412
1619
|
|
|
1413
1620
|
## `knock workflow run WORKFLOWKEY`
|
|
1414
1621
|
|
|
@@ -1430,7 +1637,7 @@ FLAGS
|
|
|
1430
1637
|
--tenant=<value> A tenant id for the workflow run.
|
|
1431
1638
|
```
|
|
1432
1639
|
|
|
1433
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1640
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/run.ts)_
|
|
1434
1641
|
|
|
1435
1642
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1436
1643
|
|
|
@@ -1449,5 +1656,5 @@ FLAGS
|
|
|
1449
1656
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1450
1657
|
```
|
|
1451
1658
|
|
|
1452
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.
|
|
1659
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.0.3/src/commands/workflow/validate.ts)_
|
|
1453
1660
|
<!-- commandsstop -->
|