@knocklabs/cli 1.1.2 → 1.2.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 +297 -170
- package/dist/commands/audience/new.js +2 -2
- package/dist/commands/branch/rebase.js +65 -0
- package/dist/commands/commit/index.js +15 -11
- package/dist/commands/commit/list.js +2 -8
- package/dist/commands/guide/get.js +6 -0
- package/dist/commands/guide/list.js +6 -0
- package/dist/commands/guide/push.js +1 -0
- package/dist/commands/layout/push.js +1 -0
- package/dist/commands/message-type/push.js +1 -0
- package/dist/commands/partial/push.js +1 -0
- package/dist/commands/push.js +4 -0
- package/dist/commands/schema/pull.js +197 -0
- package/dist/commands/schema/push.js +203 -0
- package/dist/commands/source/get.js +180 -0
- package/dist/commands/source/list.js +96 -0
- package/dist/commands/translation/push.js +1 -0
- package/dist/commands/whoami.js +8 -2
- package/dist/commands/workflow/get.js +6 -0
- package/dist/commands/workflow/list.js +6 -0
- package/dist/commands/workflow/push.js +1 -0
- package/dist/commands/workflow/run.js +6 -0
- package/dist/help.js +74 -0
- package/dist/lib/api-v1.js +78 -1
- package/dist/lib/auth.js +3 -2
- package/dist/lib/helpers/flag.js +15 -0
- package/dist/lib/marshal/guide/helpers.js +11 -0
- package/dist/lib/marshal/schema/helpers.js +142 -0
- package/dist/lib/marshal/schema/index.js +21 -0
- package/dist/lib/marshal/schema/reader.js +177 -0
- package/dist/lib/marshal/schema/types.js +15 -0
- package/dist/lib/marshal/schema/writer.js +154 -0
- package/dist/lib/marshal/source/helpers.js +28 -0
- package/dist/lib/marshal/source/index.js +19 -0
- package/dist/lib/marshal/source/types.js +4 -0
- package/dist/lib/marshal/workflow/generator.js +11 -8
- package/dist/lib/marshal/workflow/helpers.js +10 -6
- package/dist/lib/resources.js +11 -0
- package/npm-shrinkwrap.json +10698 -0
- package/oclif.manifest.json +448 -11
- package/package.json +22 -15
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.
|
|
19
|
+
@knocklabs/cli/1.2.2 linux-x64 node-v22.23.1
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -40,6 +40,7 @@ USAGE
|
|
|
40
40
|
* [`knock branch exit`](#knock-branch-exit)
|
|
41
41
|
* [`knock branch list`](#knock-branch-list)
|
|
42
42
|
* [`knock branch merge SLUG`](#knock-branch-merge-slug)
|
|
43
|
+
* [`knock branch rebase SLUG`](#knock-branch-rebase-slug)
|
|
43
44
|
* [`knock branch switch SLUG`](#knock-branch-switch-slug)
|
|
44
45
|
* [`knock channel list`](#knock-channel-list)
|
|
45
46
|
* [`knock commit`](#knock-commit)
|
|
@@ -83,6 +84,10 @@ USAGE
|
|
|
83
84
|
* [`knock partial validate [PARTIALKEY]`](#knock-partial-validate-partialkey)
|
|
84
85
|
* [`knock pull`](#knock-pull)
|
|
85
86
|
* [`knock push`](#knock-push)
|
|
87
|
+
* [`knock schema pull [ITEMTYPE]`](#knock-schema-pull-itemtype)
|
|
88
|
+
* [`knock schema push [ITEMTYPE]`](#knock-schema-push-itemtype)
|
|
89
|
+
* [`knock source get SOURCEKEY`](#knock-source-get-sourcekey)
|
|
90
|
+
* [`knock source list`](#knock-source-list)
|
|
86
91
|
* [`knock translation get TRANSLATIONREF`](#knock-translation-get-translationref)
|
|
87
92
|
* [`knock translation list`](#knock-translation-list)
|
|
88
93
|
* [`knock translation pull [TRANSLATIONREF]`](#knock-translation-pull-translationref)
|
|
@@ -115,7 +120,7 @@ FLAGS
|
|
|
115
120
|
--branch=<value> The slug of the branch to use.
|
|
116
121
|
--environment=<value> (required) The environment to use.
|
|
117
122
|
--force Skip confirmation prompt.
|
|
118
|
-
--service-token=<value>
|
|
123
|
+
--service-token=<value> The service token to authenticate with.
|
|
119
124
|
|
|
120
125
|
DESCRIPTION
|
|
121
126
|
Archive an audience (affects ALL environments).
|
|
@@ -125,7 +130,7 @@ DESCRIPTION
|
|
|
125
130
|
Use this command with caution.
|
|
126
131
|
```
|
|
127
132
|
|
|
128
|
-
_See code: [src/commands/audience/archive.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
133
|
+
_See code: [src/commands/audience/archive.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/archive.ts)_
|
|
129
134
|
|
|
130
135
|
## `knock audience get AUDIENCEKEY`
|
|
131
136
|
|
|
@@ -140,13 +145,13 @@ FLAGS
|
|
|
140
145
|
--branch=<value> The slug of the branch to use.
|
|
141
146
|
--environment=<value> [default: development] The environment to use.
|
|
142
147
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
143
|
-
--service-token=<value>
|
|
148
|
+
--service-token=<value> The service token to authenticate with.
|
|
144
149
|
|
|
145
150
|
GLOBAL FLAGS
|
|
146
151
|
--json Format output as json.
|
|
147
152
|
```
|
|
148
153
|
|
|
149
|
-
_See code: [src/commands/audience/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
154
|
+
_See code: [src/commands/audience/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/get.ts)_
|
|
150
155
|
|
|
151
156
|
## `knock audience list`
|
|
152
157
|
|
|
@@ -164,13 +169,13 @@ FLAGS
|
|
|
164
169
|
--environment=<value> [default: development] The environment to use.
|
|
165
170
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
166
171
|
--limit=<value> The total number of entries to fetch per page.
|
|
167
|
-
--service-token=<value>
|
|
172
|
+
--service-token=<value> The service token to authenticate with.
|
|
168
173
|
|
|
169
174
|
GLOBAL FLAGS
|
|
170
175
|
--json Format output as json.
|
|
171
176
|
```
|
|
172
177
|
|
|
173
|
-
_See code: [src/commands/audience/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
178
|
+
_See code: [src/commands/audience/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/list.ts)_
|
|
174
179
|
|
|
175
180
|
## `knock audience new`
|
|
176
181
|
|
|
@@ -186,16 +191,16 @@ FLAGS
|
|
|
186
191
|
-k, --key=<value> The key of the audience
|
|
187
192
|
-n, --name=<value> The name of the audience
|
|
188
193
|
-p, --push Whether or not to push the audience to Knock after creation.
|
|
189
|
-
-t, --type=<option> The type of the audience (static, dynamic).
|
|
194
|
+
-t, --type=<option> The type of the audience (static, dynamic).
|
|
190
195
|
<options: static|dynamic>
|
|
191
196
|
--branch=<value> The slug of the branch to use.
|
|
192
197
|
--environment=<value> [default: development] The environment to create the audience in. Defaults to
|
|
193
198
|
development.
|
|
194
199
|
--force Force the creation of the audience directory without confirmation.
|
|
195
|
-
--service-token=<value>
|
|
200
|
+
--service-token=<value> The service token to authenticate with.
|
|
196
201
|
```
|
|
197
202
|
|
|
198
|
-
_See code: [src/commands/audience/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
203
|
+
_See code: [src/commands/audience/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/new.ts)_
|
|
199
204
|
|
|
200
205
|
## `knock audience open AUDIENCEKEY`
|
|
201
206
|
|
|
@@ -208,10 +213,10 @@ USAGE
|
|
|
208
213
|
FLAGS
|
|
209
214
|
--branch=<value> The slug of the branch to use.
|
|
210
215
|
--environment=<value> [default: development] The environment to use.
|
|
211
|
-
--service-token=<value>
|
|
216
|
+
--service-token=<value> The service token to authenticate with.
|
|
212
217
|
```
|
|
213
218
|
|
|
214
|
-
_See code: [src/commands/audience/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
219
|
+
_See code: [src/commands/audience/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/open.ts)_
|
|
215
220
|
|
|
216
221
|
## `knock audience pull [AUDIENCEKEY]`
|
|
217
222
|
|
|
@@ -229,10 +234,10 @@ FLAGS
|
|
|
229
234
|
--environment=<value> [default: development] The environment to use.
|
|
230
235
|
--force Remove the confirmation prompt.
|
|
231
236
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
232
|
-
--service-token=<value>
|
|
237
|
+
--service-token=<value> The service token to authenticate with.
|
|
233
238
|
```
|
|
234
239
|
|
|
235
|
-
_See code: [src/commands/audience/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
240
|
+
_See code: [src/commands/audience/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/pull.ts)_
|
|
236
241
|
|
|
237
242
|
## `knock audience push [AUDIENCEKEY]`
|
|
238
243
|
|
|
@@ -253,10 +258,10 @@ FLAGS
|
|
|
253
258
|
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
254
259
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
255
260
|
you `commit` the changes.
|
|
256
|
-
--service-token=<value>
|
|
261
|
+
--service-token=<value> The service token to authenticate with.
|
|
257
262
|
```
|
|
258
263
|
|
|
259
|
-
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
264
|
+
_See code: [src/commands/audience/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/push.ts)_
|
|
260
265
|
|
|
261
266
|
## `knock audience validate [AUDIENCEKEY]`
|
|
262
267
|
|
|
@@ -273,10 +278,10 @@ FLAGS
|
|
|
273
278
|
--branch=<value> The slug of the branch to use.
|
|
274
279
|
--environment=<value> [default: development] The environment to validate the audience against. Defaults to
|
|
275
280
|
development.
|
|
276
|
-
--service-token=<value>
|
|
281
|
+
--service-token=<value> The service token to authenticate with.
|
|
277
282
|
```
|
|
278
283
|
|
|
279
|
-
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
284
|
+
_See code: [src/commands/audience/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/audience/validate.ts)_
|
|
280
285
|
|
|
281
286
|
## `knock branch create [SLUG]`
|
|
282
287
|
|
|
@@ -287,16 +292,16 @@ USAGE
|
|
|
287
292
|
$ knock branch create [SLUG] [--json] [--service-token <value>]
|
|
288
293
|
|
|
289
294
|
ARGUMENTS
|
|
290
|
-
|
|
295
|
+
SLUG The slug for the new branch
|
|
291
296
|
|
|
292
297
|
FLAGS
|
|
293
|
-
--service-token=<value>
|
|
298
|
+
--service-token=<value> The service token to authenticate with.
|
|
294
299
|
|
|
295
300
|
GLOBAL FLAGS
|
|
296
301
|
--json Format output as json.
|
|
297
302
|
```
|
|
298
303
|
|
|
299
|
-
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
304
|
+
_See code: [src/commands/branch/create.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/create.ts)_
|
|
300
305
|
|
|
301
306
|
## `knock branch delete SLUG`
|
|
302
307
|
|
|
@@ -311,10 +316,10 @@ ARGUMENTS
|
|
|
311
316
|
|
|
312
317
|
FLAGS
|
|
313
318
|
--force Remove the confirmation prompt.
|
|
314
|
-
--service-token=<value>
|
|
319
|
+
--service-token=<value> The service token to authenticate with.
|
|
315
320
|
```
|
|
316
321
|
|
|
317
|
-
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
322
|
+
_See code: [src/commands/branch/delete.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/delete.ts)_
|
|
318
323
|
|
|
319
324
|
## `knock branch exit`
|
|
320
325
|
|
|
@@ -325,10 +330,10 @@ USAGE
|
|
|
325
330
|
$ knock branch exit [--service-token <value>]
|
|
326
331
|
|
|
327
332
|
FLAGS
|
|
328
|
-
--service-token=<value>
|
|
333
|
+
--service-token=<value> The service token to authenticate with.
|
|
329
334
|
```
|
|
330
335
|
|
|
331
|
-
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
336
|
+
_See code: [src/commands/branch/exit.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/exit.ts)_
|
|
332
337
|
|
|
333
338
|
## `knock branch list`
|
|
334
339
|
|
|
@@ -342,13 +347,13 @@ FLAGS
|
|
|
342
347
|
--after=<value> The cursor after which to fetch the next page.
|
|
343
348
|
--before=<value> The cursor before which to fetch the previous page.
|
|
344
349
|
--limit=<value> The total number of entries to fetch per page.
|
|
345
|
-
--service-token=<value>
|
|
350
|
+
--service-token=<value> The service token to authenticate with.
|
|
346
351
|
|
|
347
352
|
GLOBAL FLAGS
|
|
348
353
|
--json Format output as json.
|
|
349
354
|
```
|
|
350
355
|
|
|
351
|
-
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
356
|
+
_See code: [src/commands/branch/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/list.ts)_
|
|
352
357
|
|
|
353
358
|
## `knock branch merge SLUG`
|
|
354
359
|
|
|
@@ -364,10 +369,31 @@ ARGUMENTS
|
|
|
364
369
|
FLAGS
|
|
365
370
|
--[no-]delete Delete the branch after merging.
|
|
366
371
|
--force Remove the confirmation prompt.
|
|
367
|
-
--service-token=<value>
|
|
372
|
+
--service-token=<value> The service token to authenticate with.
|
|
368
373
|
```
|
|
369
374
|
|
|
370
|
-
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
375
|
+
_See code: [src/commands/branch/merge.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/merge.ts)_
|
|
376
|
+
|
|
377
|
+
## `knock branch rebase SLUG`
|
|
378
|
+
|
|
379
|
+
Rebases a branch onto the development environment, bringing in changes from main while preserving branch commits.
|
|
380
|
+
|
|
381
|
+
```
|
|
382
|
+
USAGE
|
|
383
|
+
$ knock branch rebase SLUG [--json] [--service-token <value>] [--force]
|
|
384
|
+
|
|
385
|
+
ARGUMENTS
|
|
386
|
+
SLUG The slug of the branch to rebase
|
|
387
|
+
|
|
388
|
+
FLAGS
|
|
389
|
+
--force Remove the confirmation prompt.
|
|
390
|
+
--service-token=<value> The service token to authenticate with.
|
|
391
|
+
|
|
392
|
+
GLOBAL FLAGS
|
|
393
|
+
--json Format output as json.
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
_See code: [src/commands/branch/rebase.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/rebase.ts)_
|
|
371
397
|
|
|
372
398
|
## `knock branch switch SLUG`
|
|
373
399
|
|
|
@@ -383,10 +409,10 @@ ARGUMENTS
|
|
|
383
409
|
FLAGS
|
|
384
410
|
--create Create the branch if it doesn't yet exist.
|
|
385
411
|
--force Remove the confirmation prompt.
|
|
386
|
-
--service-token=<value>
|
|
412
|
+
--service-token=<value> The service token to authenticate with.
|
|
387
413
|
```
|
|
388
414
|
|
|
389
|
-
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
415
|
+
_See code: [src/commands/branch/switch.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/branch/switch.ts)_
|
|
390
416
|
|
|
391
417
|
## `knock channel list`
|
|
392
418
|
|
|
@@ -397,13 +423,13 @@ USAGE
|
|
|
397
423
|
$ knock channel list [--json] [--service-token <value>]
|
|
398
424
|
|
|
399
425
|
FLAGS
|
|
400
|
-
--service-token=<value>
|
|
426
|
+
--service-token=<value> The service token to authenticate with.
|
|
401
427
|
|
|
402
428
|
GLOBAL FLAGS
|
|
403
429
|
--json Format output as json.
|
|
404
430
|
```
|
|
405
431
|
|
|
406
|
-
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
432
|
+
_See code: [src/commands/channel/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/channel/list.ts)_
|
|
407
433
|
|
|
408
434
|
## `knock commit`
|
|
409
435
|
|
|
@@ -412,10 +438,13 @@ Commit all changes in development environment, or only changes for a specific re
|
|
|
412
438
|
```
|
|
413
439
|
USAGE
|
|
414
440
|
$ knock commit [--service-token <value>] [--environment development] [--branch <value>] [-m <value>]
|
|
415
|
-
[--force] [--resource-type email_layout|
|
|
441
|
+
[--force] [--allow-empty] [--resource-type audience|partial|email_layout|workflow|message_type|guide|translation]
|
|
442
|
+
[--resource-id <value>]
|
|
416
443
|
|
|
417
444
|
FLAGS
|
|
418
445
|
-m, --commit-message=<value> Use the given value as the commit message.
|
|
446
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
447
|
+
--allow-empty). Requires --resource-type and --resource-id.
|
|
419
448
|
--branch=<value> The slug of the branch to use.
|
|
420
449
|
--environment=<option> [default: development] Committing changes applies to the development environment only,
|
|
421
450
|
use `commit promote` to promote changes to a subsequent environment.
|
|
@@ -425,11 +454,11 @@ FLAGS
|
|
|
425
454
|
--resource-type.
|
|
426
455
|
--resource-type=<option> Commit only changes for the given resource type. Can be used alone or together with
|
|
427
456
|
--resource-id.
|
|
428
|
-
<options: email_layout|
|
|
429
|
-
--service-token=<value>
|
|
457
|
+
<options: audience|partial|email_layout|workflow|message_type|guide|translation>
|
|
458
|
+
--service-token=<value> The service token to authenticate with.
|
|
430
459
|
```
|
|
431
460
|
|
|
432
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
461
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/commit/index.ts)_
|
|
433
462
|
|
|
434
463
|
## `knock commit get ID`
|
|
435
464
|
|
|
@@ -440,13 +469,13 @@ USAGE
|
|
|
440
469
|
$ knock commit get ID [--json] [--service-token <value>]
|
|
441
470
|
|
|
442
471
|
FLAGS
|
|
443
|
-
--service-token=<value>
|
|
472
|
+
--service-token=<value> The service token to authenticate with.
|
|
444
473
|
|
|
445
474
|
GLOBAL FLAGS
|
|
446
475
|
--json Format output as json.
|
|
447
476
|
```
|
|
448
477
|
|
|
449
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
478
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/commit/get.ts)_
|
|
450
479
|
|
|
451
480
|
## `knock commit list`
|
|
452
481
|
|
|
@@ -455,8 +484,8 @@ Display all commits in an environment
|
|
|
455
484
|
```
|
|
456
485
|
USAGE
|
|
457
486
|
$ knock commit list [--json] [--service-token <value>] [--environment <value>] [--branch <value>] [--promoted]
|
|
458
|
-
[--resource-type email_layout|
|
|
459
|
-
<value>] [--before <value>] [--limit <value>]
|
|
487
|
+
[--resource-type audience|partial|email_layout|workflow|message_type|guide|translation...] [--resource-id <value>]
|
|
488
|
+
[--after <value>] [--before <value>] [--limit <value>]
|
|
460
489
|
|
|
461
490
|
FLAGS
|
|
462
491
|
--after=<value> The cursor after which to fetch the next page.
|
|
@@ -471,14 +500,14 @@ FLAGS
|
|
|
471
500
|
locale code and namespace, separated by a /. For example, en/courses or en.
|
|
472
501
|
--resource-type=<option>... Filter commits by resource type. Can be used alone or together with resource-id. Use
|
|
473
502
|
multiple --resource-type flags for multiple values.
|
|
474
|
-
<options: email_layout|
|
|
475
|
-
--service-token=<value>
|
|
503
|
+
<options: audience|partial|email_layout|workflow|message_type|guide|translation>
|
|
504
|
+
--service-token=<value> The service token to authenticate with.
|
|
476
505
|
|
|
477
506
|
GLOBAL FLAGS
|
|
478
507
|
--json Format output as json.
|
|
479
508
|
```
|
|
480
509
|
|
|
481
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
510
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/commit/list.ts)_
|
|
482
511
|
|
|
483
512
|
## `knock commit promote`
|
|
484
513
|
|
|
@@ -491,11 +520,11 @@ USAGE
|
|
|
491
520
|
FLAGS
|
|
492
521
|
--force Remove the confirmation prompt.
|
|
493
522
|
--only=<value> The target commit id to promote to the subsequent environment
|
|
494
|
-
--service-token=<value>
|
|
523
|
+
--service-token=<value> The service token to authenticate with.
|
|
495
524
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
496
525
|
```
|
|
497
526
|
|
|
498
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
527
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/commit/promote.ts)_
|
|
499
528
|
|
|
500
529
|
## `knock environment list`
|
|
501
530
|
|
|
@@ -506,13 +535,13 @@ USAGE
|
|
|
506
535
|
$ knock environment list [--json] [--service-token <value>]
|
|
507
536
|
|
|
508
537
|
FLAGS
|
|
509
|
-
--service-token=<value>
|
|
538
|
+
--service-token=<value> The service token to authenticate with.
|
|
510
539
|
|
|
511
540
|
GLOBAL FLAGS
|
|
512
541
|
--json Format output as json.
|
|
513
542
|
```
|
|
514
543
|
|
|
515
|
-
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
544
|
+
_See code: [src/commands/environment/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/environment/list.ts)_
|
|
516
545
|
|
|
517
546
|
## `knock guide activate GUIDEKEY`
|
|
518
547
|
|
|
@@ -528,7 +557,7 @@ FLAGS
|
|
|
528
557
|
--environment=<value> (required) The environment to use.
|
|
529
558
|
--force Remove the confirmation prompt.
|
|
530
559
|
--from=<value> Activate the guide from this ISO8601 UTC datetime (e.g., '2024-01-15T10:30:00Z').
|
|
531
|
-
--service-token=<value>
|
|
560
|
+
--service-token=<value> The service token to authenticate with.
|
|
532
561
|
--status=<option> The guide active status to set. Cannot be used with --from/--until.
|
|
533
562
|
<options: true|false>
|
|
534
563
|
--until=<value> Deactivate the guide at this ISO8601 UTC datetime (e.g., '2024-01-15T18:30:00Z').
|
|
@@ -543,7 +572,7 @@ DESCRIPTION
|
|
|
543
572
|
or deactivated at a later time using the --from and --until flags.
|
|
544
573
|
```
|
|
545
574
|
|
|
546
|
-
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
575
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/activate.ts)_
|
|
547
576
|
|
|
548
577
|
## `knock guide generate-types`
|
|
549
578
|
|
|
@@ -560,13 +589,13 @@ FLAGS
|
|
|
560
589
|
--output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .py,
|
|
561
590
|
.go, .rb files only. Your file extension will determine the target language for the generated
|
|
562
591
|
types.
|
|
563
|
-
--service-token=<value>
|
|
592
|
+
--service-token=<value> The service token to authenticate with.
|
|
564
593
|
|
|
565
594
|
DESCRIPTION
|
|
566
595
|
Generate types for all guides in an environment and write them to a file.
|
|
567
596
|
```
|
|
568
597
|
|
|
569
|
-
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
598
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/generate-types.ts)_
|
|
570
599
|
|
|
571
600
|
## `knock guide get GUIDEKEY`
|
|
572
601
|
|
|
@@ -581,13 +610,13 @@ FLAGS
|
|
|
581
610
|
--branch=<value> The slug of the branch to use.
|
|
582
611
|
--environment=<value> [default: development] The environment to use.
|
|
583
612
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
584
|
-
--service-token=<value>
|
|
613
|
+
--service-token=<value> The service token to authenticate with.
|
|
585
614
|
|
|
586
615
|
GLOBAL FLAGS
|
|
587
616
|
--json Format output as json.
|
|
588
617
|
```
|
|
589
618
|
|
|
590
|
-
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
619
|
+
_See code: [src/commands/guide/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/get.ts)_
|
|
591
620
|
|
|
592
621
|
## `knock guide list`
|
|
593
622
|
|
|
@@ -605,13 +634,13 @@ FLAGS
|
|
|
605
634
|
--environment=<value> [default: development] The environment to use.
|
|
606
635
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
607
636
|
--limit=<value> The total number of entries to fetch per page.
|
|
608
|
-
--service-token=<value>
|
|
637
|
+
--service-token=<value> The service token to authenticate with.
|
|
609
638
|
|
|
610
639
|
GLOBAL FLAGS
|
|
611
640
|
--json Format output as json.
|
|
612
641
|
```
|
|
613
642
|
|
|
614
|
-
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
643
|
+
_See code: [src/commands/guide/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/list.ts)_
|
|
615
644
|
|
|
616
645
|
## `knock guide new`
|
|
617
646
|
|
|
@@ -632,10 +661,10 @@ FLAGS
|
|
|
632
661
|
--branch=<value> The slug of the branch to use.
|
|
633
662
|
--environment=<value> [default: development] The environment to create the guide in. Defaults to development.
|
|
634
663
|
--force Force the creation of the guide directory without confirmation.
|
|
635
|
-
--service-token=<value>
|
|
664
|
+
--service-token=<value> The service token to authenticate with.
|
|
636
665
|
```
|
|
637
666
|
|
|
638
|
-
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
667
|
+
_See code: [src/commands/guide/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/new.ts)_
|
|
639
668
|
|
|
640
669
|
## `knock guide open GUIDEKEY`
|
|
641
670
|
|
|
@@ -648,10 +677,10 @@ USAGE
|
|
|
648
677
|
FLAGS
|
|
649
678
|
--branch=<value> The slug of the branch to use.
|
|
650
679
|
--environment=<value> [default: development] The environment to use.
|
|
651
|
-
--service-token=<value>
|
|
680
|
+
--service-token=<value> The service token to authenticate with.
|
|
652
681
|
```
|
|
653
682
|
|
|
654
|
-
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
683
|
+
_See code: [src/commands/guide/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/open.ts)_
|
|
655
684
|
|
|
656
685
|
## `knock guide pull [GUIDEKEY]`
|
|
657
686
|
|
|
@@ -669,10 +698,10 @@ FLAGS
|
|
|
669
698
|
--force Remove the confirmation prompt.
|
|
670
699
|
--guides-dir=<value> The target directory path to pull all guides into.
|
|
671
700
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
672
|
-
--service-token=<value>
|
|
701
|
+
--service-token=<value> The service token to authenticate with.
|
|
673
702
|
```
|
|
674
703
|
|
|
675
|
-
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
704
|
+
_See code: [src/commands/guide/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/pull.ts)_
|
|
676
705
|
|
|
677
706
|
## `knock guide push [GUIDEKEY]`
|
|
678
707
|
|
|
@@ -681,11 +710,13 @@ Push one or more guides from a local file system to Knock.
|
|
|
681
710
|
```
|
|
682
711
|
USAGE
|
|
683
712
|
$ knock guide push [GUIDEKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
684
|
-
[--guides-dir <value> --all] [-m <value> --commit] [--force]
|
|
713
|
+
[--guides-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
685
714
|
|
|
686
715
|
FLAGS
|
|
687
716
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
688
717
|
--all Whether to push all guides from the target directory.
|
|
718
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
719
|
+
--allow-empty).
|
|
689
720
|
--branch=<value> The slug of the branch to use.
|
|
690
721
|
--commit Push and commit the guide(s) at the same time
|
|
691
722
|
--environment=<value> [default: development] The environment to push the guide to. Defaults to development.
|
|
@@ -693,10 +724,10 @@ FLAGS
|
|
|
693
724
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
694
725
|
you `commit` the changes.
|
|
695
726
|
--guides-dir=<value> The target directory path to find all guides to push.
|
|
696
|
-
--service-token=<value>
|
|
727
|
+
--service-token=<value> The service token to authenticate with.
|
|
697
728
|
```
|
|
698
729
|
|
|
699
|
-
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
730
|
+
_See code: [src/commands/guide/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/push.ts)_
|
|
700
731
|
|
|
701
732
|
## `knock guide validate [GUIDEKEY]`
|
|
702
733
|
|
|
@@ -712,10 +743,10 @@ FLAGS
|
|
|
712
743
|
--branch=<value> The slug of the branch to use.
|
|
713
744
|
--environment=<value> [default: development] The environment to validate the guide in. Defaults to development.
|
|
714
745
|
--guides-dir=<value> The target directory path to find all guides to validate.
|
|
715
|
-
--service-token=<value>
|
|
746
|
+
--service-token=<value> The service token to authenticate with.
|
|
716
747
|
```
|
|
717
748
|
|
|
718
|
-
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
749
|
+
_See code: [src/commands/guide/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/guide/validate.ts)_
|
|
719
750
|
|
|
720
751
|
## `knock help [COMMAND]`
|
|
721
752
|
|
|
@@ -726,7 +757,7 @@ USAGE
|
|
|
726
757
|
$ knock help [COMMAND...] [-n]
|
|
727
758
|
|
|
728
759
|
ARGUMENTS
|
|
729
|
-
|
|
760
|
+
COMMAND... Command to show help for.
|
|
730
761
|
|
|
731
762
|
FLAGS
|
|
732
763
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -735,7 +766,7 @@ DESCRIPTION
|
|
|
735
766
|
Display help for knock.
|
|
736
767
|
```
|
|
737
768
|
|
|
738
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.
|
|
769
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.53/src/commands/help.ts)_
|
|
739
770
|
|
|
740
771
|
## `knock init`
|
|
741
772
|
|
|
@@ -746,7 +777,7 @@ USAGE
|
|
|
746
777
|
$ knock init [--service-token <value>]
|
|
747
778
|
|
|
748
779
|
FLAGS
|
|
749
|
-
--service-token=<value>
|
|
780
|
+
--service-token=<value> The service token to authenticate with.
|
|
750
781
|
|
|
751
782
|
DESCRIPTION
|
|
752
783
|
Initialize a new Knock project with a knock.json configuration file.
|
|
@@ -755,7 +786,7 @@ DESCRIPTION
|
|
|
755
786
|
resources directory.
|
|
756
787
|
```
|
|
757
788
|
|
|
758
|
-
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
789
|
+
_See code: [src/commands/init.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/init.ts)_
|
|
759
790
|
|
|
760
791
|
## `knock layout get EMAILLAYOUTKEY`
|
|
761
792
|
|
|
@@ -770,13 +801,13 @@ FLAGS
|
|
|
770
801
|
--branch=<value> The slug of the branch to use.
|
|
771
802
|
--environment=<value> [default: development] The environment to use.
|
|
772
803
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
773
|
-
--service-token=<value>
|
|
804
|
+
--service-token=<value> The service token to authenticate with.
|
|
774
805
|
|
|
775
806
|
GLOBAL FLAGS
|
|
776
807
|
--json Format output as json.
|
|
777
808
|
```
|
|
778
809
|
|
|
779
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
810
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/get.ts)_
|
|
780
811
|
|
|
781
812
|
## `knock layout list`
|
|
782
813
|
|
|
@@ -794,13 +825,13 @@ FLAGS
|
|
|
794
825
|
--environment=<value> [default: development] The environment to use.
|
|
795
826
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
796
827
|
--limit=<value> The total number of entries to fetch per page.
|
|
797
|
-
--service-token=<value>
|
|
828
|
+
--service-token=<value> The service token to authenticate with.
|
|
798
829
|
|
|
799
830
|
GLOBAL FLAGS
|
|
800
831
|
--json Format output as json.
|
|
801
832
|
```
|
|
802
833
|
|
|
803
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
834
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/list.ts)_
|
|
804
835
|
|
|
805
836
|
## `knock layout new`
|
|
806
837
|
|
|
@@ -819,11 +850,11 @@ FLAGS
|
|
|
819
850
|
--environment=<value> [default: development] The environment to create the email layout in. Defaults to
|
|
820
851
|
development.
|
|
821
852
|
--force Force the creation of the email layout directory without confirmation.
|
|
822
|
-
--service-token=<value>
|
|
853
|
+
--service-token=<value> The service token to authenticate with.
|
|
823
854
|
--template=<value> The template to use for the email layout. Should be `email-layouts/{key}`.
|
|
824
855
|
```
|
|
825
856
|
|
|
826
|
-
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
857
|
+
_See code: [src/commands/layout/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/new.ts)_
|
|
827
858
|
|
|
828
859
|
## `knock layout open LAYOUTKEY`
|
|
829
860
|
|
|
@@ -836,10 +867,10 @@ USAGE
|
|
|
836
867
|
FLAGS
|
|
837
868
|
--branch=<value> The slug of the branch to use.
|
|
838
869
|
--environment=<value> [default: development] The environment to use.
|
|
839
|
-
--service-token=<value>
|
|
870
|
+
--service-token=<value> The service token to authenticate with.
|
|
840
871
|
```
|
|
841
872
|
|
|
842
|
-
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
873
|
+
_See code: [src/commands/layout/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/open.ts)_
|
|
843
874
|
|
|
844
875
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
845
876
|
|
|
@@ -857,10 +888,10 @@ FLAGS
|
|
|
857
888
|
--force Remove the confirmation prompt.
|
|
858
889
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
859
890
|
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
860
|
-
--service-token=<value>
|
|
891
|
+
--service-token=<value> The service token to authenticate with.
|
|
861
892
|
```
|
|
862
893
|
|
|
863
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
894
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/pull.ts)_
|
|
864
895
|
|
|
865
896
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
866
897
|
|
|
@@ -869,11 +900,13 @@ Push one or more email layouts from a local file system to Knock.
|
|
|
869
900
|
```
|
|
870
901
|
USAGE
|
|
871
902
|
$ knock layout push [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
872
|
-
[--layouts-dir <value> --all] [-m <value> --commit] [--force]
|
|
903
|
+
[--layouts-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
873
904
|
|
|
874
905
|
FLAGS
|
|
875
906
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
876
907
|
--all Whether to push all layouts from the target directory.
|
|
908
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
909
|
+
--allow-empty).
|
|
877
910
|
--branch=<value> The slug of the branch to use.
|
|
878
911
|
--commit Push and commit the layout(s) at the same time
|
|
879
912
|
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
@@ -883,10 +916,10 @@ FLAGS
|
|
|
883
916
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
884
917
|
you `commit` the changes.
|
|
885
918
|
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
886
|
-
--service-token=<value>
|
|
919
|
+
--service-token=<value> The service token to authenticate with.
|
|
887
920
|
```
|
|
888
921
|
|
|
889
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
922
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/push.ts)_
|
|
890
923
|
|
|
891
924
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
892
925
|
|
|
@@ -903,10 +936,10 @@ FLAGS
|
|
|
903
936
|
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
904
937
|
<options: development>
|
|
905
938
|
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
906
|
-
--service-token=<value>
|
|
939
|
+
--service-token=<value> The service token to authenticate with.
|
|
907
940
|
```
|
|
908
941
|
|
|
909
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
942
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/layout/validate.ts)_
|
|
910
943
|
|
|
911
944
|
## `knock login`
|
|
912
945
|
|
|
@@ -917,10 +950,10 @@ USAGE
|
|
|
917
950
|
$ knock login [--service-token <value>]
|
|
918
951
|
|
|
919
952
|
FLAGS
|
|
920
|
-
--service-token=<value>
|
|
953
|
+
--service-token=<value> The service token to authenticate with.
|
|
921
954
|
```
|
|
922
955
|
|
|
923
|
-
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
956
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/login.ts)_
|
|
924
957
|
|
|
925
958
|
## `knock logout`
|
|
926
959
|
|
|
@@ -931,10 +964,10 @@ USAGE
|
|
|
931
964
|
$ knock logout [--service-token <value>]
|
|
932
965
|
|
|
933
966
|
FLAGS
|
|
934
|
-
--service-token=<value>
|
|
967
|
+
--service-token=<value> The service token to authenticate with.
|
|
935
968
|
```
|
|
936
969
|
|
|
937
|
-
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
970
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/logout.ts)_
|
|
938
971
|
|
|
939
972
|
## `knock message-type get MESSAGETYPEKEY`
|
|
940
973
|
|
|
@@ -949,13 +982,13 @@ FLAGS
|
|
|
949
982
|
--branch=<value> The slug of the branch to use.
|
|
950
983
|
--environment=<value> [default: development] The environment to use.
|
|
951
984
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
952
|
-
--service-token=<value>
|
|
985
|
+
--service-token=<value> The service token to authenticate with.
|
|
953
986
|
|
|
954
987
|
GLOBAL FLAGS
|
|
955
988
|
--json Format output as json.
|
|
956
989
|
```
|
|
957
990
|
|
|
958
|
-
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
991
|
+
_See code: [src/commands/message-type/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/get.ts)_
|
|
959
992
|
|
|
960
993
|
## `knock message-type list`
|
|
961
994
|
|
|
@@ -973,13 +1006,13 @@ FLAGS
|
|
|
973
1006
|
--environment=<value> [default: development] The environment to use.
|
|
974
1007
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
975
1008
|
--limit=<value> The total number of entries to fetch per page.
|
|
976
|
-
--service-token=<value>
|
|
1009
|
+
--service-token=<value> The service token to authenticate with.
|
|
977
1010
|
|
|
978
1011
|
GLOBAL FLAGS
|
|
979
1012
|
--json Format output as json.
|
|
980
1013
|
```
|
|
981
1014
|
|
|
982
|
-
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1015
|
+
_See code: [src/commands/message-type/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/list.ts)_
|
|
983
1016
|
|
|
984
1017
|
## `knock message-type new`
|
|
985
1018
|
|
|
@@ -998,11 +1031,11 @@ FLAGS
|
|
|
998
1031
|
--environment=<value> [default: development] The environment to create the message type in. Defaults to
|
|
999
1032
|
development.
|
|
1000
1033
|
--force Force the creation of the message type directory without confirmation.
|
|
1001
|
-
--service-token=<value>
|
|
1034
|
+
--service-token=<value> The service token to authenticate with.
|
|
1002
1035
|
--template=<value> The template to use for the message type. Should be `message-types/{key}`.
|
|
1003
1036
|
```
|
|
1004
1037
|
|
|
1005
|
-
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1038
|
+
_See code: [src/commands/message-type/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/new.ts)_
|
|
1006
1039
|
|
|
1007
1040
|
## `knock message-type open MESSAGETYPEKEY`
|
|
1008
1041
|
|
|
@@ -1015,10 +1048,10 @@ USAGE
|
|
|
1015
1048
|
FLAGS
|
|
1016
1049
|
--branch=<value> The slug of the branch to use.
|
|
1017
1050
|
--environment=<value> [default: development] The environment to use.
|
|
1018
|
-
--service-token=<value>
|
|
1051
|
+
--service-token=<value> The service token to authenticate with.
|
|
1019
1052
|
```
|
|
1020
1053
|
|
|
1021
|
-
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1054
|
+
_See code: [src/commands/message-type/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/open.ts)_
|
|
1022
1055
|
|
|
1023
1056
|
## `knock message-type pull [MESSAGETYPEKEY]`
|
|
1024
1057
|
|
|
@@ -1036,10 +1069,10 @@ FLAGS
|
|
|
1036
1069
|
--force Remove the confirmation prompt.
|
|
1037
1070
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1038
1071
|
--message-types-dir=<value> The target directory path to pull all in-app message types into.
|
|
1039
|
-
--service-token=<value>
|
|
1072
|
+
--service-token=<value> The service token to authenticate with.
|
|
1040
1073
|
```
|
|
1041
1074
|
|
|
1042
|
-
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1075
|
+
_See code: [src/commands/message-type/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/pull.ts)_
|
|
1043
1076
|
|
|
1044
1077
|
## `knock message-type push [MESSAGETYPEKEY]`
|
|
1045
1078
|
|
|
@@ -1048,11 +1081,13 @@ Push one or more message types from a local file system to Knock.
|
|
|
1048
1081
|
```
|
|
1049
1082
|
USAGE
|
|
1050
1083
|
$ knock message-type push [MESSAGETYPEKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1051
|
-
[--message-types-dir <value> --all] [-m <value> --commit] [--force]
|
|
1084
|
+
[--message-types-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
1052
1085
|
|
|
1053
1086
|
FLAGS
|
|
1054
1087
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
1055
1088
|
--all Whether to push all message types from the target directory.
|
|
1089
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
1090
|
+
--allow-empty).
|
|
1056
1091
|
--branch=<value> The slug of the branch to use.
|
|
1057
1092
|
--commit Push and commit the message type(s) at the same time
|
|
1058
1093
|
--environment=<option> [default: development] Pushing a message type is only allowed in the development
|
|
@@ -1062,10 +1097,10 @@ FLAGS
|
|
|
1062
1097
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
1063
1098
|
you `commit` the changes.
|
|
1064
1099
|
--message-types-dir=<value> The target directory path to find all message types to push.
|
|
1065
|
-
--service-token=<value>
|
|
1100
|
+
--service-token=<value> The service token to authenticate with.
|
|
1066
1101
|
```
|
|
1067
1102
|
|
|
1068
|
-
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1103
|
+
_See code: [src/commands/message-type/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/push.ts)_
|
|
1069
1104
|
|
|
1070
1105
|
## `knock message-type validate [MESSAGETYPEKEY]`
|
|
1071
1106
|
|
|
@@ -1083,10 +1118,10 @@ FLAGS
|
|
|
1083
1118
|
environment
|
|
1084
1119
|
<options: development>
|
|
1085
1120
|
--message-types-dir=<value> The target directory path to find all message types to validate.
|
|
1086
|
-
--service-token=<value>
|
|
1121
|
+
--service-token=<value> The service token to authenticate with.
|
|
1087
1122
|
```
|
|
1088
1123
|
|
|
1089
|
-
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1124
|
+
_See code: [src/commands/message-type/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/message-type/validate.ts)_
|
|
1090
1125
|
|
|
1091
1126
|
## `knock partial get PARTIALKEY`
|
|
1092
1127
|
|
|
@@ -1101,13 +1136,13 @@ FLAGS
|
|
|
1101
1136
|
--branch=<value> The slug of the branch to use.
|
|
1102
1137
|
--environment=<value> [default: development] The environment to use.
|
|
1103
1138
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1104
|
-
--service-token=<value>
|
|
1139
|
+
--service-token=<value> The service token to authenticate with.
|
|
1105
1140
|
|
|
1106
1141
|
GLOBAL FLAGS
|
|
1107
1142
|
--json Format output as json.
|
|
1108
1143
|
```
|
|
1109
1144
|
|
|
1110
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1145
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/get.ts)_
|
|
1111
1146
|
|
|
1112
1147
|
## `knock partial list`
|
|
1113
1148
|
|
|
@@ -1125,13 +1160,13 @@ FLAGS
|
|
|
1125
1160
|
--environment=<value> [default: development] The environment to use.
|
|
1126
1161
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1127
1162
|
--limit=<value> The total number of entries to fetch per page.
|
|
1128
|
-
--service-token=<value>
|
|
1163
|
+
--service-token=<value> The service token to authenticate with.
|
|
1129
1164
|
|
|
1130
1165
|
GLOBAL FLAGS
|
|
1131
1166
|
--json Format output as json.
|
|
1132
1167
|
```
|
|
1133
1168
|
|
|
1134
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1169
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/list.ts)_
|
|
1135
1170
|
|
|
1136
1171
|
## `knock partial new`
|
|
1137
1172
|
|
|
@@ -1152,12 +1187,12 @@ FLAGS
|
|
|
1152
1187
|
--branch=<value> The slug of the branch to use.
|
|
1153
1188
|
--environment=<value> [default: development] The environment to create the partial in. Defaults to development.
|
|
1154
1189
|
--force Force the creation of the partial directory without confirmation.
|
|
1155
|
-
--service-token=<value>
|
|
1190
|
+
--service-token=<value> The service token to authenticate with.
|
|
1156
1191
|
--template=<value> The template to use for the partial. Should be `partials/{key}`. You cannot use this flag
|
|
1157
1192
|
with --type.
|
|
1158
1193
|
```
|
|
1159
1194
|
|
|
1160
|
-
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1195
|
+
_See code: [src/commands/partial/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/new.ts)_
|
|
1161
1196
|
|
|
1162
1197
|
## `knock partial open PARTIALKEY`
|
|
1163
1198
|
|
|
@@ -1170,10 +1205,10 @@ USAGE
|
|
|
1170
1205
|
FLAGS
|
|
1171
1206
|
--branch=<value> The slug of the branch to use.
|
|
1172
1207
|
--environment=<value> [default: development] The environment to use.
|
|
1173
|
-
--service-token=<value>
|
|
1208
|
+
--service-token=<value> The service token to authenticate with.
|
|
1174
1209
|
```
|
|
1175
1210
|
|
|
1176
|
-
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1211
|
+
_See code: [src/commands/partial/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/open.ts)_
|
|
1177
1212
|
|
|
1178
1213
|
## `knock partial pull [PARTIALKEY]`
|
|
1179
1214
|
|
|
@@ -1191,10 +1226,10 @@ FLAGS
|
|
|
1191
1226
|
--force Remove the confirmation prompt.
|
|
1192
1227
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1193
1228
|
--partials-dir=<value> The target directory path to pull all partials into.
|
|
1194
|
-
--service-token=<value>
|
|
1229
|
+
--service-token=<value> The service token to authenticate with.
|
|
1195
1230
|
```
|
|
1196
1231
|
|
|
1197
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1232
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/pull.ts)_
|
|
1198
1233
|
|
|
1199
1234
|
## `knock partial push [PARTIALKEY]`
|
|
1200
1235
|
|
|
@@ -1203,11 +1238,13 @@ Push one or more partials from a local file system to Knock.
|
|
|
1203
1238
|
```
|
|
1204
1239
|
USAGE
|
|
1205
1240
|
$ knock partial push [PARTIALKEY] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1206
|
-
[--partials-dir <value> --all] [-m <value> --commit] [--force]
|
|
1241
|
+
[--partials-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
1207
1242
|
|
|
1208
1243
|
FLAGS
|
|
1209
1244
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
1210
1245
|
--all Whether to push all partials from the target directory.
|
|
1246
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
1247
|
+
--allow-empty).
|
|
1211
1248
|
--branch=<value> The slug of the branch to use.
|
|
1212
1249
|
--commit Push and commit the partial(s) at the same time
|
|
1213
1250
|
--environment=<option> [default: development] Pushing a partial is only allowed in the development environment
|
|
@@ -1216,10 +1253,10 @@ FLAGS
|
|
|
1216
1253
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
1217
1254
|
you `commit` the changes.
|
|
1218
1255
|
--partials-dir=<value> The target directory path to find all partials to push.
|
|
1219
|
-
--service-token=<value>
|
|
1256
|
+
--service-token=<value> The service token to authenticate with.
|
|
1220
1257
|
```
|
|
1221
1258
|
|
|
1222
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1259
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/push.ts)_
|
|
1223
1260
|
|
|
1224
1261
|
## `knock partial validate [PARTIALKEY]`
|
|
1225
1262
|
|
|
@@ -1236,10 +1273,10 @@ FLAGS
|
|
|
1236
1273
|
--environment=<option> [default: development] Validating a partial is only done in the development environment
|
|
1237
1274
|
<options: development>
|
|
1238
1275
|
--partials-dir=<value> The target directory path to find all partials to validate.
|
|
1239
|
-
--service-token=<value>
|
|
1276
|
+
--service-token=<value> The service token to authenticate with.
|
|
1240
1277
|
```
|
|
1241
1278
|
|
|
1242
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1279
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/partial/validate.ts)_
|
|
1243
1280
|
|
|
1244
1281
|
## `knock pull`
|
|
1245
1282
|
|
|
@@ -1256,10 +1293,10 @@ FLAGS
|
|
|
1256
1293
|
--force Remove the confirmation prompt.
|
|
1257
1294
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1258
1295
|
--knock-dir=<value> The target directory path to pull all resources into.
|
|
1259
|
-
--service-token=<value>
|
|
1296
|
+
--service-token=<value> The service token to authenticate with.
|
|
1260
1297
|
```
|
|
1261
1298
|
|
|
1262
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1299
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/pull.ts)_
|
|
1263
1300
|
|
|
1264
1301
|
## `knock push`
|
|
1265
1302
|
|
|
@@ -1268,10 +1305,12 @@ Push all resources from a local file system to Knock.
|
|
|
1268
1305
|
```
|
|
1269
1306
|
USAGE
|
|
1270
1307
|
$ knock push [--service-token <value>] [--environment development] [--branch <value>] [--knock-dir
|
|
1271
|
-
<value>] [-m <value> --commit] [--force]
|
|
1308
|
+
<value>] [-m <value> --commit] [--allow-empty ] [--force]
|
|
1272
1309
|
|
|
1273
1310
|
FLAGS
|
|
1274
1311
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
1312
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
1313
|
+
--allow-empty).
|
|
1275
1314
|
--branch=<value> The slug of the branch to use.
|
|
1276
1315
|
--commit Push and commit the resource(s) at the same time
|
|
1277
1316
|
--environment=<option> [default: development] Pushing resources is only allowed in the development environment
|
|
@@ -1280,10 +1319,91 @@ FLAGS
|
|
|
1280
1319
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
1281
1320
|
you `commit` the changes.
|
|
1282
1321
|
--knock-dir=<value> The target directory path to find all resources to push.
|
|
1283
|
-
--service-token=<value>
|
|
1322
|
+
--service-token=<value> The service token to authenticate with.
|
|
1323
|
+
```
|
|
1324
|
+
|
|
1325
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/push.ts)_
|
|
1326
|
+
|
|
1327
|
+
## `knock schema pull [ITEMTYPE]`
|
|
1328
|
+
|
|
1329
|
+
Pull one or more item schemas from an environment into a local file system.
|
|
1330
|
+
|
|
1331
|
+
```
|
|
1332
|
+
USAGE
|
|
1333
|
+
$ knock schema pull [ITEMTYPE] [--service-token <value>] [--environment <value>] [--branch <value>] [--all]
|
|
1334
|
+
[--collection <value>] [--schemas-dir <value>] [--force]
|
|
1335
|
+
|
|
1336
|
+
FLAGS
|
|
1337
|
+
--all Whether to pull all item schemas from the specified environment.
|
|
1338
|
+
--branch=<value> The slug of the branch to use.
|
|
1339
|
+
--collection=<value> The object collection key for object schemas.
|
|
1340
|
+
--environment=<value> [default: development] The environment to use.
|
|
1341
|
+
--force Remove the confirmation prompt.
|
|
1342
|
+
--schemas-dir=<value> The target schemas directory path.
|
|
1343
|
+
--service-token=<value> The service token to authenticate with.
|
|
1344
|
+
```
|
|
1345
|
+
|
|
1346
|
+
_See code: [src/commands/schema/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/schema/pull.ts)_
|
|
1347
|
+
|
|
1348
|
+
## `knock schema push [ITEMTYPE]`
|
|
1349
|
+
|
|
1350
|
+
Push one or more local item schemas to a Knock environment.
|
|
1351
|
+
|
|
1352
|
+
```
|
|
1353
|
+
USAGE
|
|
1354
|
+
$ knock schema push [ITEMTYPE] [--service-token <value>] [--environment <value>] [--branch <value>] [--all]
|
|
1355
|
+
[--collection <value>] [--schemas-dir <value>]
|
|
1356
|
+
|
|
1357
|
+
FLAGS
|
|
1358
|
+
--all Whether to push all schemas from the target schemas directory.
|
|
1359
|
+
--branch=<value> The slug of the branch to use.
|
|
1360
|
+
--collection=<value> The object collection key for object schemas.
|
|
1361
|
+
--environment=<value> [default: development] The environment to use.
|
|
1362
|
+
--schemas-dir=<value> The target schemas directory path.
|
|
1363
|
+
--service-token=<value> The service token to authenticate with.
|
|
1364
|
+
```
|
|
1365
|
+
|
|
1366
|
+
_See code: [src/commands/schema/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/schema/push.ts)_
|
|
1367
|
+
|
|
1368
|
+
## `knock source get SOURCEKEY`
|
|
1369
|
+
|
|
1370
|
+
Display a single source from an environment.
|
|
1371
|
+
|
|
1284
1372
|
```
|
|
1373
|
+
USAGE
|
|
1374
|
+
$ knock source get SOURCEKEY [--json] [--service-token <value>] [--environment <value>]
|
|
1285
1375
|
|
|
1286
|
-
|
|
1376
|
+
FLAGS
|
|
1377
|
+
--environment=<value> The environment to use.
|
|
1378
|
+
--service-token=<value> The service token to authenticate with.
|
|
1379
|
+
|
|
1380
|
+
GLOBAL FLAGS
|
|
1381
|
+
--json Format output as json.
|
|
1382
|
+
```
|
|
1383
|
+
|
|
1384
|
+
_See code: [src/commands/source/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/source/get.ts)_
|
|
1385
|
+
|
|
1386
|
+
## `knock source list`
|
|
1387
|
+
|
|
1388
|
+
Display all sources for an environment.
|
|
1389
|
+
|
|
1390
|
+
```
|
|
1391
|
+
USAGE
|
|
1392
|
+
$ knock source list [--json] [--service-token <value>] [--environment <value>] [--after <value>] [--before
|
|
1393
|
+
<value>] [--limit <value>]
|
|
1394
|
+
|
|
1395
|
+
FLAGS
|
|
1396
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
1397
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
1398
|
+
--environment=<value> The environment to use.
|
|
1399
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
1400
|
+
--service-token=<value> The service token to authenticate with.
|
|
1401
|
+
|
|
1402
|
+
GLOBAL FLAGS
|
|
1403
|
+
--json Format output as json.
|
|
1404
|
+
```
|
|
1405
|
+
|
|
1406
|
+
_See code: [src/commands/source/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/source/list.ts)_
|
|
1287
1407
|
|
|
1288
1408
|
## `knock translation get TRANSLATIONREF`
|
|
1289
1409
|
|
|
@@ -1305,13 +1425,13 @@ FLAGS
|
|
|
1305
1425
|
--format=<option> [default: json] Specify the output format of the returned translations.
|
|
1306
1426
|
<options: json|po>
|
|
1307
1427
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1308
|
-
--service-token=<value>
|
|
1428
|
+
--service-token=<value> The service token to authenticate with.
|
|
1309
1429
|
|
|
1310
1430
|
GLOBAL FLAGS
|
|
1311
1431
|
--json Format output as json.
|
|
1312
1432
|
```
|
|
1313
1433
|
|
|
1314
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1434
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/translation/get.ts)_
|
|
1315
1435
|
|
|
1316
1436
|
## `knock translation list`
|
|
1317
1437
|
|
|
@@ -1329,13 +1449,13 @@ FLAGS
|
|
|
1329
1449
|
--environment=<value> [default: development] The environment to use.
|
|
1330
1450
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1331
1451
|
--limit=<value> The total number of entries to fetch per page.
|
|
1332
|
-
--service-token=<value>
|
|
1452
|
+
--service-token=<value> The service token to authenticate with.
|
|
1333
1453
|
|
|
1334
1454
|
GLOBAL FLAGS
|
|
1335
1455
|
--json Format output as json.
|
|
1336
1456
|
```
|
|
1337
1457
|
|
|
1338
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1458
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/translation/list.ts)_
|
|
1339
1459
|
|
|
1340
1460
|
## `knock translation pull [TRANSLATIONREF]`
|
|
1341
1461
|
|
|
@@ -1347,9 +1467,9 @@ USAGE
|
|
|
1347
1467
|
[--translations-dir <value> --all] [--hide-uncommitted-changes] [--force] [--format json|po]
|
|
1348
1468
|
|
|
1349
1469
|
ARGUMENTS
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1470
|
+
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
1471
|
+
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
1472
|
+
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
1353
1473
|
|
|
1354
1474
|
FLAGS
|
|
1355
1475
|
--all Whether to pull all translations from the specified environment.
|
|
@@ -1359,11 +1479,11 @@ FLAGS
|
|
|
1359
1479
|
--format=<option> [default: json] Specify the output format of the returned translations.
|
|
1360
1480
|
<options: json|po>
|
|
1361
1481
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1362
|
-
--service-token=<value>
|
|
1482
|
+
--service-token=<value> The service token to authenticate with.
|
|
1363
1483
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
1364
1484
|
```
|
|
1365
1485
|
|
|
1366
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1486
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/translation/pull.ts)_
|
|
1367
1487
|
|
|
1368
1488
|
## `knock translation push [TRANSLATIONREF]`
|
|
1369
1489
|
|
|
@@ -1372,16 +1492,18 @@ Push one or more translations from a local file system to Knock.
|
|
|
1372
1492
|
```
|
|
1373
1493
|
USAGE
|
|
1374
1494
|
$ knock translation push [TRANSLATIONREF] [--service-token <value>] [--environment development] [--branch <value>]
|
|
1375
|
-
[--translations-dir <value> --all] [-m <value> --commit] [--force]
|
|
1495
|
+
[--translations-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
1376
1496
|
|
|
1377
1497
|
ARGUMENTS
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1498
|
+
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
1499
|
+
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
1500
|
+
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
1381
1501
|
|
|
1382
1502
|
FLAGS
|
|
1383
1503
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
1384
1504
|
--all Whether to push all translations from the target directory.
|
|
1505
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
1506
|
+
--allow-empty).
|
|
1385
1507
|
--branch=<value> The slug of the branch to use.
|
|
1386
1508
|
--commit Push and commit the translation(s) at the same time
|
|
1387
1509
|
--environment=<option> [default: development] Pushing a translation is only allowed in the development
|
|
@@ -1390,11 +1512,11 @@ FLAGS
|
|
|
1390
1512
|
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1391
1513
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
1392
1514
|
you `commit` the changes.
|
|
1393
|
-
--service-token=<value>
|
|
1515
|
+
--service-token=<value> The service token to authenticate with.
|
|
1394
1516
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
1395
1517
|
```
|
|
1396
1518
|
|
|
1397
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1519
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/translation/push.ts)_
|
|
1398
1520
|
|
|
1399
1521
|
## `knock translation validate [TRANSLATIONREF]`
|
|
1400
1522
|
|
|
@@ -1406,9 +1528,9 @@ USAGE
|
|
|
1406
1528
|
[--translations-dir <value> --all]
|
|
1407
1529
|
|
|
1408
1530
|
ARGUMENTS
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1531
|
+
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
1532
|
+
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
1533
|
+
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
1412
1534
|
|
|
1413
1535
|
FLAGS
|
|
1414
1536
|
--all Whether to validate all translations from the target directory.
|
|
@@ -1416,28 +1538,28 @@ FLAGS
|
|
|
1416
1538
|
--environment=<option> [default: development] Validating a translation is only done in the development
|
|
1417
1539
|
environment
|
|
1418
1540
|
<options: development>
|
|
1419
|
-
--service-token=<value>
|
|
1541
|
+
--service-token=<value> The service token to authenticate with.
|
|
1420
1542
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
1421
1543
|
```
|
|
1422
1544
|
|
|
1423
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1545
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/translation/validate.ts)_
|
|
1424
1546
|
|
|
1425
1547
|
## `knock whoami`
|
|
1426
1548
|
|
|
1427
|
-
Verify the
|
|
1549
|
+
Verify authentication and show the current account and user.
|
|
1428
1550
|
|
|
1429
1551
|
```
|
|
1430
1552
|
USAGE
|
|
1431
1553
|
$ knock whoami [--json] [--service-token <value>]
|
|
1432
1554
|
|
|
1433
1555
|
FLAGS
|
|
1434
|
-
--service-token=<value>
|
|
1556
|
+
--service-token=<value> The service token to authenticate with.
|
|
1435
1557
|
|
|
1436
1558
|
GLOBAL FLAGS
|
|
1437
1559
|
--json Format output as json.
|
|
1438
1560
|
```
|
|
1439
1561
|
|
|
1440
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1562
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/whoami.ts)_
|
|
1441
1563
|
|
|
1442
1564
|
## `knock workflow activate WORKFLOWKEY`
|
|
1443
1565
|
|
|
@@ -1452,7 +1574,7 @@ FLAGS
|
|
|
1452
1574
|
--branch=<value> The slug of the branch to use.
|
|
1453
1575
|
--environment=<value> (required) The environment to use.
|
|
1454
1576
|
--force Remove the confirmation prompt.
|
|
1455
|
-
--service-token=<value>
|
|
1577
|
+
--service-token=<value> The service token to authenticate with.
|
|
1456
1578
|
--status=<option> [default: true] The workflow active status to set.
|
|
1457
1579
|
<options: true|false>
|
|
1458
1580
|
|
|
@@ -1466,7 +1588,7 @@ DESCRIPTION
|
|
|
1466
1588
|
with `false` in order to deactivate it.
|
|
1467
1589
|
```
|
|
1468
1590
|
|
|
1469
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1591
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/activate.ts)_
|
|
1470
1592
|
|
|
1471
1593
|
## `knock workflow generate-types`
|
|
1472
1594
|
|
|
@@ -1483,13 +1605,13 @@ FLAGS
|
|
|
1483
1605
|
--output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .rb,
|
|
1484
1606
|
.go, .py files only. Your file extension will determine the target language for the generated
|
|
1485
1607
|
types.
|
|
1486
|
-
--service-token=<value>
|
|
1608
|
+
--service-token=<value> The service token to authenticate with.
|
|
1487
1609
|
|
|
1488
1610
|
DESCRIPTION
|
|
1489
1611
|
Generate types for all workflows in an environment and write them to a file.
|
|
1490
1612
|
```
|
|
1491
1613
|
|
|
1492
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1614
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/generate-types.ts)_
|
|
1493
1615
|
|
|
1494
1616
|
## `knock workflow get WORKFLOWKEY`
|
|
1495
1617
|
|
|
@@ -1504,13 +1626,13 @@ FLAGS
|
|
|
1504
1626
|
--branch=<value> The slug of the branch to use.
|
|
1505
1627
|
--environment=<value> [default: development] The environment to use.
|
|
1506
1628
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1507
|
-
--service-token=<value>
|
|
1629
|
+
--service-token=<value> The service token to authenticate with.
|
|
1508
1630
|
|
|
1509
1631
|
GLOBAL FLAGS
|
|
1510
1632
|
--json Format output as json.
|
|
1511
1633
|
```
|
|
1512
1634
|
|
|
1513
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1635
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/get.ts)_
|
|
1514
1636
|
|
|
1515
1637
|
## `knock workflow list`
|
|
1516
1638
|
|
|
@@ -1528,13 +1650,13 @@ FLAGS
|
|
|
1528
1650
|
--environment=<value> [default: development] The environment to use.
|
|
1529
1651
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1530
1652
|
--limit=<value> The total number of entries to fetch per page.
|
|
1531
|
-
--service-token=<value>
|
|
1653
|
+
--service-token=<value> The service token to authenticate with.
|
|
1532
1654
|
|
|
1533
1655
|
GLOBAL FLAGS
|
|
1534
1656
|
--json Format output as json.
|
|
1535
1657
|
```
|
|
1536
1658
|
|
|
1537
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1659
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/list.ts)_
|
|
1538
1660
|
|
|
1539
1661
|
## `knock workflow new`
|
|
1540
1662
|
|
|
@@ -1556,10 +1678,10 @@ FLAGS
|
|
|
1556
1678
|
--environment=<value> [default: development] The environment to create the workflow in. Defaults to
|
|
1557
1679
|
development.
|
|
1558
1680
|
--force Force the creation of the workflow directory without confirmation.
|
|
1559
|
-
--service-token=<value>
|
|
1681
|
+
--service-token=<value> The service token to authenticate with.
|
|
1560
1682
|
```
|
|
1561
1683
|
|
|
1562
|
-
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1684
|
+
_See code: [src/commands/workflow/new.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/new.ts)_
|
|
1563
1685
|
|
|
1564
1686
|
## `knock workflow open WORKFLOWKEY`
|
|
1565
1687
|
|
|
@@ -1572,10 +1694,10 @@ USAGE
|
|
|
1572
1694
|
FLAGS
|
|
1573
1695
|
--branch=<value> The slug of the branch to use.
|
|
1574
1696
|
--environment=<value> [default: development] The environment to use.
|
|
1575
|
-
--service-token=<value>
|
|
1697
|
+
--service-token=<value> The service token to authenticate with.
|
|
1576
1698
|
```
|
|
1577
1699
|
|
|
1578
|
-
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1700
|
+
_See code: [src/commands/workflow/open.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/open.ts)_
|
|
1579
1701
|
|
|
1580
1702
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
1581
1703
|
|
|
@@ -1592,11 +1714,11 @@ FLAGS
|
|
|
1592
1714
|
--environment=<value> [default: development] The environment to use.
|
|
1593
1715
|
--force Remove the confirmation prompt.
|
|
1594
1716
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
1595
|
-
--service-token=<value>
|
|
1717
|
+
--service-token=<value> The service token to authenticate with.
|
|
1596
1718
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
1597
1719
|
```
|
|
1598
1720
|
|
|
1599
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1721
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/pull.ts)_
|
|
1600
1722
|
|
|
1601
1723
|
## `knock workflow push [WORKFLOWKEY]`
|
|
1602
1724
|
|
|
@@ -1605,22 +1727,24 @@ Push one or more workflows from a local file system to Knock.
|
|
|
1605
1727
|
```
|
|
1606
1728
|
USAGE
|
|
1607
1729
|
$ knock workflow push [WORKFLOWKEY] [--service-token <value>] [--environment <value>] [--branch <value>]
|
|
1608
|
-
[--workflows-dir <value> --all] [-m <value> --commit] [--force]
|
|
1730
|
+
[--workflows-dir <value> --all] [-m <value> --commit] [--allow-empty ] [--force]
|
|
1609
1731
|
|
|
1610
1732
|
FLAGS
|
|
1611
1733
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
1612
1734
|
--all Whether to push all workflows from the target directory.
|
|
1735
|
+
--allow-empty Create an empty commit for an already-published resource (analogous to git commit
|
|
1736
|
+
--allow-empty).
|
|
1613
1737
|
--branch=<value> The slug of the branch to use.
|
|
1614
1738
|
--commit Push and commit the workflow(s) at the same time
|
|
1615
1739
|
--environment=<value> [default: development] The environment to push the workflow to. Defaults to development.
|
|
1616
1740
|
--force Force pushes the resource or resources to Knock, overwriting whatever is currently
|
|
1617
1741
|
stored. If you're using this on a non-development environment, you should also ensure
|
|
1618
1742
|
you `commit` the changes.
|
|
1619
|
-
--service-token=<value>
|
|
1743
|
+
--service-token=<value> The service token to authenticate with.
|
|
1620
1744
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
1621
1745
|
```
|
|
1622
1746
|
|
|
1623
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1747
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/push.ts)_
|
|
1624
1748
|
|
|
1625
1749
|
## `knock workflow run WORKFLOWKEY`
|
|
1626
1750
|
|
|
@@ -1629,7 +1753,7 @@ Test run a workflow using the latest version from Knock.
|
|
|
1629
1753
|
```
|
|
1630
1754
|
USAGE
|
|
1631
1755
|
$ knock workflow run WORKFLOWKEY --recipients <value> [--service-token <value>] [--environment <value>]
|
|
1632
|
-
[--branch <value>] [--actor <value>] [--tenant <value>] [--data <value>]
|
|
1756
|
+
[--branch <value>] [--actor <value>] [--tenant <value>] [--data <value>] [--sandbox-mode] [--skip-delay]
|
|
1633
1757
|
|
|
1634
1758
|
FLAGS
|
|
1635
1759
|
--actor=<value> An actor id, or a JSON string of an actor object reference for the workflow run.
|
|
@@ -1638,11 +1762,14 @@ FLAGS
|
|
|
1638
1762
|
--environment=<value> [default: development] The environment in which to run the workflow
|
|
1639
1763
|
--recipients=<value> (required) One or more recipient user ids separated by comma, or a JSON string containing one
|
|
1640
1764
|
or more recipient object references for this workflow run.
|
|
1641
|
-
--
|
|
1765
|
+
--sandbox-mode When enabled, channels in this workflow generate messages but don't send them to the
|
|
1766
|
+
downstream provider.
|
|
1767
|
+
--service-token=<value> The service token to authenticate with.
|
|
1768
|
+
--skip-delay When enabled, delay steps in this workflow will be skipped
|
|
1642
1769
|
--tenant=<value> A tenant id for the workflow run.
|
|
1643
1770
|
```
|
|
1644
1771
|
|
|
1645
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1772
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/run.ts)_
|
|
1646
1773
|
|
|
1647
1774
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
1648
1775
|
|
|
@@ -1657,9 +1784,9 @@ FLAGS
|
|
|
1657
1784
|
--all Whether to validate all workflows from the target directory.
|
|
1658
1785
|
--branch=<value> The slug of the branch to use.
|
|
1659
1786
|
--environment=<value> [default: development] The environment to validate the workflow in. Defaults to development.
|
|
1660
|
-
--service-token=<value>
|
|
1787
|
+
--service-token=<value> The service token to authenticate with.
|
|
1661
1788
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
1662
1789
|
```
|
|
1663
1790
|
|
|
1664
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.
|
|
1791
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v1.2.2/src/commands/workflow/validate.ts)_
|
|
1665
1792
|
<!-- commandsstop -->
|