@knocklabs/cli 0.1.4 → 0.1.5
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 +407 -4
- package/dist/commands/layout/get.js +98 -0
- package/dist/commands/layout/list.js +86 -0
- package/dist/commands/layout/pull.js +199 -0
- package/dist/commands/layout/push.js +159 -0
- package/dist/commands/layout/validate.js +134 -0
- package/dist/commands/workflow/get.js +39 -7
- package/dist/commands/workflow/list.js +4 -1
- package/dist/lib/api-v1.js +47 -0
- package/dist/lib/marshal/email-layout/helpers.js +124 -0
- package/dist/lib/marshal/email-layout/index.js +19 -0
- package/dist/lib/marshal/email-layout/reader.js +193 -0
- package/dist/lib/marshal/email-layout/types.js +4 -0
- package/dist/lib/marshal/email-layout/writer.js +240 -0
- package/dist/lib/marshal/shared/helpers.js +135 -0
- package/dist/lib/marshal/workflow/generator.js +3 -2
- package/dist/lib/marshal/workflow/helpers.js +27 -5
- package/dist/lib/marshal/workflow/reader.js +8 -106
- package/dist/lib/marshal/workflow/types.js +1 -0
- package/dist/lib/marshal/workflow/writer.js +76 -40
- package/dist/lib/run-context/loader.js +11 -0
- package/oclif.manifest.json +333 -1
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
|
|
|
16
16
|
$ knock COMMAND
|
|
17
17
|
running command...
|
|
18
18
|
$ knock (--version)
|
|
19
|
-
@knocklabs/cli/0.1.
|
|
19
|
+
@knocklabs/cli/0.1.5 linux-x64 node-v18.18.0
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -29,7 +29,22 @@ USAGE
|
|
|
29
29
|
<!-- commands -->
|
|
30
30
|
* [`knock commit`](#knock-commit)
|
|
31
31
|
* [`knock commit promote`](#knock-commit-promote)
|
|
32
|
+
* [`knock email-layout get EMAILLAYOUTKEY`](#knock-email-layout-get-emaillayoutkey)
|
|
33
|
+
* [`knock email-layout list`](#knock-email-layout-list)
|
|
34
|
+
* [`knock email-layout pull [EMAILLAYOUTKEY]`](#knock-email-layout-pull-emaillayoutkey)
|
|
35
|
+
* [`knock email-layout push [EMAILLAYOUTKEY]`](#knock-email-layout-push-emaillayoutkey)
|
|
36
|
+
* [`knock email-layout validate [EMAILLAYOUTKEY]`](#knock-email-layout-validate-emaillayoutkey)
|
|
37
|
+
* [`knock email_layout get EMAILLAYOUTKEY`](#knock-email_layout-get-emaillayoutkey)
|
|
38
|
+
* [`knock email_layout list`](#knock-email_layout-list)
|
|
39
|
+
* [`knock email_layout pull [EMAILLAYOUTKEY]`](#knock-email_layout-pull-emaillayoutkey)
|
|
40
|
+
* [`knock email_layout push [EMAILLAYOUTKEY]`](#knock-email_layout-push-emaillayoutkey)
|
|
41
|
+
* [`knock email_layout validate [EMAILLAYOUTKEY]`](#knock-email_layout-validate-emaillayoutkey)
|
|
32
42
|
* [`knock help [COMMANDS]`](#knock-help-commands)
|
|
43
|
+
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
44
|
+
* [`knock layout list`](#knock-layout-list)
|
|
45
|
+
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
46
|
+
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
47
|
+
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
33
48
|
* [`knock plugins`](#knock-plugins)
|
|
34
49
|
* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin)
|
|
35
50
|
* [`knock plugins:inspect PLUGIN...`](#knock-pluginsinspect-plugin)
|
|
@@ -70,7 +85,7 @@ FLAGS
|
|
|
70
85
|
--service-token=<value> (required) The service token to authenticate with.
|
|
71
86
|
```
|
|
72
87
|
|
|
73
|
-
_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.
|
|
88
|
+
_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/commit/index.ts)_
|
|
74
89
|
|
|
75
90
|
## `knock commit promote`
|
|
76
91
|
|
|
@@ -86,6 +101,236 @@ FLAGS
|
|
|
86
101
|
--to=<value> (required) The destination environment to promote changes from the preceding environment.
|
|
87
102
|
```
|
|
88
103
|
|
|
104
|
+
_See code: [dist/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/commit/promote.ts)_
|
|
105
|
+
|
|
106
|
+
## `knock email-layout get EMAILLAYOUTKEY`
|
|
107
|
+
|
|
108
|
+
Display a single email layout from an environment.
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
USAGE
|
|
112
|
+
$ knock email-layout get EMAILLAYOUTKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
113
|
+
[--json]
|
|
114
|
+
|
|
115
|
+
FLAGS
|
|
116
|
+
--environment=<value> [default: development] The environment to use.
|
|
117
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
118
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
119
|
+
|
|
120
|
+
GLOBAL FLAGS
|
|
121
|
+
--json Format output as json.
|
|
122
|
+
|
|
123
|
+
ALIASES
|
|
124
|
+
$ knock email-layout get
|
|
125
|
+
$ knock email_layout get
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## `knock email-layout list`
|
|
129
|
+
|
|
130
|
+
Display all email layouts for an environment.
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
USAGE
|
|
134
|
+
$ knock email-layout list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
135
|
+
<value>] [--before <value>] [--limit <value>] [--json]
|
|
136
|
+
|
|
137
|
+
FLAGS
|
|
138
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
139
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
140
|
+
--environment=<value> [default: development] The environment to use.
|
|
141
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
142
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
143
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
144
|
+
|
|
145
|
+
GLOBAL FLAGS
|
|
146
|
+
--json Format output as json.
|
|
147
|
+
|
|
148
|
+
ALIASES
|
|
149
|
+
$ knock email-layout list
|
|
150
|
+
$ knock email_layout list
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## `knock email-layout pull [EMAILLAYOUTKEY]`
|
|
154
|
+
|
|
155
|
+
Pull one or more email layouts from an environment into a local file system.
|
|
156
|
+
|
|
157
|
+
```
|
|
158
|
+
USAGE
|
|
159
|
+
$ knock email-layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
|
|
160
|
+
--all] [--hide-uncommitted-changes] [--force]
|
|
161
|
+
|
|
162
|
+
FLAGS
|
|
163
|
+
--all Whether to pull all email layouts from the specified environment.
|
|
164
|
+
--environment=<value> [default: development] The environment to use.
|
|
165
|
+
--force Remove the confirmation prompt.
|
|
166
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
167
|
+
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
168
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
169
|
+
|
|
170
|
+
ALIASES
|
|
171
|
+
$ knock email-layout pull
|
|
172
|
+
$ knock email_layout pull
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## `knock email-layout push [EMAILLAYOUTKEY]`
|
|
176
|
+
|
|
177
|
+
Push one or more email layouts from a local file system to Knock.
|
|
178
|
+
|
|
179
|
+
```
|
|
180
|
+
USAGE
|
|
181
|
+
$ knock email-layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
182
|
+
--all] [-m <value> --commit]
|
|
183
|
+
|
|
184
|
+
FLAGS
|
|
185
|
+
-m, --commit-message=<value> Use the given value as the commit message
|
|
186
|
+
--all Whether to push all layouts from the target directory.
|
|
187
|
+
--commit Push and commit the layout(s) at the same time
|
|
188
|
+
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
189
|
+
environment
|
|
190
|
+
<options: development>
|
|
191
|
+
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
192
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
193
|
+
|
|
194
|
+
ALIASES
|
|
195
|
+
$ knock email-layout push
|
|
196
|
+
$ knock email_layout push
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## `knock email-layout validate [EMAILLAYOUTKEY]`
|
|
200
|
+
|
|
201
|
+
Validate one or more layouts from a local file system.
|
|
202
|
+
|
|
203
|
+
```
|
|
204
|
+
USAGE
|
|
205
|
+
$ knock email-layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
206
|
+
--all]
|
|
207
|
+
|
|
208
|
+
FLAGS
|
|
209
|
+
--all Whether to validate all layouts from the target directory.
|
|
210
|
+
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
211
|
+
<options: development>
|
|
212
|
+
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
213
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
214
|
+
|
|
215
|
+
ALIASES
|
|
216
|
+
$ knock email-layout validate
|
|
217
|
+
$ knock email_layout validate
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
## `knock email_layout get EMAILLAYOUTKEY`
|
|
221
|
+
|
|
222
|
+
Display a single email layout from an environment.
|
|
223
|
+
|
|
224
|
+
```
|
|
225
|
+
USAGE
|
|
226
|
+
$ knock email_layout get EMAILLAYOUTKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
227
|
+
[--json]
|
|
228
|
+
|
|
229
|
+
FLAGS
|
|
230
|
+
--environment=<value> [default: development] The environment to use.
|
|
231
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
232
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
233
|
+
|
|
234
|
+
GLOBAL FLAGS
|
|
235
|
+
--json Format output as json.
|
|
236
|
+
|
|
237
|
+
ALIASES
|
|
238
|
+
$ knock email-layout get
|
|
239
|
+
$ knock email_layout get
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
## `knock email_layout list`
|
|
243
|
+
|
|
244
|
+
Display all email layouts for an environment.
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
USAGE
|
|
248
|
+
$ knock email_layout list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
249
|
+
<value>] [--before <value>] [--limit <value>] [--json]
|
|
250
|
+
|
|
251
|
+
FLAGS
|
|
252
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
253
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
254
|
+
--environment=<value> [default: development] The environment to use.
|
|
255
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
256
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
257
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
258
|
+
|
|
259
|
+
GLOBAL FLAGS
|
|
260
|
+
--json Format output as json.
|
|
261
|
+
|
|
262
|
+
ALIASES
|
|
263
|
+
$ knock email-layout list
|
|
264
|
+
$ knock email_layout list
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
## `knock email_layout pull [EMAILLAYOUTKEY]`
|
|
268
|
+
|
|
269
|
+
Pull one or more email layouts from an environment into a local file system.
|
|
270
|
+
|
|
271
|
+
```
|
|
272
|
+
USAGE
|
|
273
|
+
$ knock email_layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
|
|
274
|
+
--all] [--hide-uncommitted-changes] [--force]
|
|
275
|
+
|
|
276
|
+
FLAGS
|
|
277
|
+
--all Whether to pull all email layouts from the specified environment.
|
|
278
|
+
--environment=<value> [default: development] The environment to use.
|
|
279
|
+
--force Remove the confirmation prompt.
|
|
280
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
281
|
+
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
282
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
283
|
+
|
|
284
|
+
ALIASES
|
|
285
|
+
$ knock email-layout pull
|
|
286
|
+
$ knock email_layout pull
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
## `knock email_layout push [EMAILLAYOUTKEY]`
|
|
290
|
+
|
|
291
|
+
Push one or more email layouts from a local file system to Knock.
|
|
292
|
+
|
|
293
|
+
```
|
|
294
|
+
USAGE
|
|
295
|
+
$ knock email_layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
296
|
+
--all] [-m <value> --commit]
|
|
297
|
+
|
|
298
|
+
FLAGS
|
|
299
|
+
-m, --commit-message=<value> Use the given value as the commit message
|
|
300
|
+
--all Whether to push all layouts from the target directory.
|
|
301
|
+
--commit Push and commit the layout(s) at the same time
|
|
302
|
+
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
303
|
+
environment
|
|
304
|
+
<options: development>
|
|
305
|
+
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
306
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
307
|
+
|
|
308
|
+
ALIASES
|
|
309
|
+
$ knock email-layout push
|
|
310
|
+
$ knock email_layout push
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
## `knock email_layout validate [EMAILLAYOUTKEY]`
|
|
314
|
+
|
|
315
|
+
Validate one or more layouts from a local file system.
|
|
316
|
+
|
|
317
|
+
```
|
|
318
|
+
USAGE
|
|
319
|
+
$ knock email_layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
320
|
+
--all]
|
|
321
|
+
|
|
322
|
+
FLAGS
|
|
323
|
+
--all Whether to validate all layouts from the target directory.
|
|
324
|
+
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
325
|
+
<options: development>
|
|
326
|
+
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
327
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
328
|
+
|
|
329
|
+
ALIASES
|
|
330
|
+
$ knock email-layout validate
|
|
331
|
+
$ knock email_layout validate
|
|
332
|
+
```
|
|
333
|
+
|
|
89
334
|
## `knock help [COMMANDS]`
|
|
90
335
|
|
|
91
336
|
Display help for knock.
|
|
@@ -104,7 +349,131 @@ DESCRIPTION
|
|
|
104
349
|
Display help for knock.
|
|
105
350
|
```
|
|
106
351
|
|
|
107
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.
|
|
352
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
|
|
353
|
+
|
|
354
|
+
## `knock layout get EMAILLAYOUTKEY`
|
|
355
|
+
|
|
356
|
+
Display a single email layout from an environment.
|
|
357
|
+
|
|
358
|
+
```
|
|
359
|
+
USAGE
|
|
360
|
+
$ knock layout get EMAILLAYOUTKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
361
|
+
[--json]
|
|
362
|
+
|
|
363
|
+
FLAGS
|
|
364
|
+
--environment=<value> [default: development] The environment to use.
|
|
365
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
366
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
367
|
+
|
|
368
|
+
GLOBAL FLAGS
|
|
369
|
+
--json Format output as json.
|
|
370
|
+
|
|
371
|
+
ALIASES
|
|
372
|
+
$ knock email-layout get
|
|
373
|
+
$ knock email_layout get
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
_See code: [dist/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/layout/get.ts)_
|
|
377
|
+
|
|
378
|
+
## `knock layout list`
|
|
379
|
+
|
|
380
|
+
Display all email layouts for an environment.
|
|
381
|
+
|
|
382
|
+
```
|
|
383
|
+
USAGE
|
|
384
|
+
$ knock layout list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
385
|
+
<value>] [--before <value>] [--limit <value>] [--json]
|
|
386
|
+
|
|
387
|
+
FLAGS
|
|
388
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
389
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
390
|
+
--environment=<value> [default: development] The environment to use.
|
|
391
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
392
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
393
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
394
|
+
|
|
395
|
+
GLOBAL FLAGS
|
|
396
|
+
--json Format output as json.
|
|
397
|
+
|
|
398
|
+
ALIASES
|
|
399
|
+
$ knock email-layout list
|
|
400
|
+
$ knock email_layout list
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
_See code: [dist/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/layout/list.ts)_
|
|
404
|
+
|
|
405
|
+
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
406
|
+
|
|
407
|
+
Pull one or more email layouts from an environment into a local file system.
|
|
408
|
+
|
|
409
|
+
```
|
|
410
|
+
USAGE
|
|
411
|
+
$ knock layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
|
|
412
|
+
--all] [--hide-uncommitted-changes] [--force]
|
|
413
|
+
|
|
414
|
+
FLAGS
|
|
415
|
+
--all Whether to pull all email layouts from the specified environment.
|
|
416
|
+
--environment=<value> [default: development] The environment to use.
|
|
417
|
+
--force Remove the confirmation prompt.
|
|
418
|
+
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
419
|
+
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
420
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
421
|
+
|
|
422
|
+
ALIASES
|
|
423
|
+
$ knock email-layout pull
|
|
424
|
+
$ knock email_layout pull
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
_See code: [dist/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/layout/pull.ts)_
|
|
428
|
+
|
|
429
|
+
## `knock layout push [EMAILLAYOUTKEY]`
|
|
430
|
+
|
|
431
|
+
Push one or more email layouts from a local file system to Knock.
|
|
432
|
+
|
|
433
|
+
```
|
|
434
|
+
USAGE
|
|
435
|
+
$ knock layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
436
|
+
--all] [-m <value> --commit]
|
|
437
|
+
|
|
438
|
+
FLAGS
|
|
439
|
+
-m, --commit-message=<value> Use the given value as the commit message
|
|
440
|
+
--all Whether to push all layouts from the target directory.
|
|
441
|
+
--commit Push and commit the layout(s) at the same time
|
|
442
|
+
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
443
|
+
environment
|
|
444
|
+
<options: development>
|
|
445
|
+
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
446
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
447
|
+
|
|
448
|
+
ALIASES
|
|
449
|
+
$ knock email-layout push
|
|
450
|
+
$ knock email_layout push
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
_See code: [dist/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/layout/push.ts)_
|
|
454
|
+
|
|
455
|
+
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
456
|
+
|
|
457
|
+
Validate one or more layouts from a local file system.
|
|
458
|
+
|
|
459
|
+
```
|
|
460
|
+
USAGE
|
|
461
|
+
$ knock layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
462
|
+
--all]
|
|
463
|
+
|
|
464
|
+
FLAGS
|
|
465
|
+
--all Whether to validate all layouts from the target directory.
|
|
466
|
+
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
467
|
+
<options: development>
|
|
468
|
+
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
469
|
+
--service-token=<value> (required) The service token to authenticate with.
|
|
470
|
+
|
|
471
|
+
ALIASES
|
|
472
|
+
$ knock email-layout validate
|
|
473
|
+
$ knock email_layout validate
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
_See code: [dist/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/layout/validate.ts)_
|
|
108
477
|
|
|
109
478
|
## `knock plugins`
|
|
110
479
|
|
|
@@ -192,6 +561,8 @@ EXAMPLES
|
|
|
192
561
|
$ knock plugins:inspect myplugin
|
|
193
562
|
```
|
|
194
563
|
|
|
564
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/inspect.ts)_
|
|
565
|
+
|
|
195
566
|
## `knock plugins:install PLUGIN...`
|
|
196
567
|
|
|
197
568
|
Installs a plugin into the CLI.
|
|
@@ -230,6 +601,8 @@ EXAMPLES
|
|
|
230
601
|
$ knock plugins:install someuser/someplugin
|
|
231
602
|
```
|
|
232
603
|
|
|
604
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/install.ts)_
|
|
605
|
+
|
|
233
606
|
## `knock plugins:link PLUGIN`
|
|
234
607
|
|
|
235
608
|
Links a plugin into the CLI for development.
|
|
@@ -257,6 +630,8 @@ EXAMPLES
|
|
|
257
630
|
$ knock plugins:link myplugin
|
|
258
631
|
```
|
|
259
632
|
|
|
633
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/link.ts)_
|
|
634
|
+
|
|
260
635
|
## `knock plugins:uninstall PLUGIN...`
|
|
261
636
|
|
|
262
637
|
Removes a plugin from the CLI.
|
|
@@ -303,6 +678,8 @@ ALIASES
|
|
|
303
678
|
$ knock plugins remove
|
|
304
679
|
```
|
|
305
680
|
|
|
681
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/uninstall.ts)_
|
|
682
|
+
|
|
306
683
|
## `knock plugins:uninstall PLUGIN...`
|
|
307
684
|
|
|
308
685
|
Removes a plugin from the CLI.
|
|
@@ -342,6 +719,8 @@ DESCRIPTION
|
|
|
342
719
|
Update installed plugins.
|
|
343
720
|
```
|
|
344
721
|
|
|
722
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/update.ts)_
|
|
723
|
+
|
|
345
724
|
## `knock translation get TRANSLATIONREF`
|
|
346
725
|
|
|
347
726
|
Display a single translation from an environment.
|
|
@@ -365,6 +744,8 @@ GLOBAL FLAGS
|
|
|
365
744
|
--json Format output as json.
|
|
366
745
|
```
|
|
367
746
|
|
|
747
|
+
_See code: [dist/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/translation/get.ts)_
|
|
748
|
+
|
|
368
749
|
## `knock translation list`
|
|
369
750
|
|
|
370
751
|
Display all translations for an environment.
|
|
@@ -386,6 +767,8 @@ GLOBAL FLAGS
|
|
|
386
767
|
--json Format output as json.
|
|
387
768
|
```
|
|
388
769
|
|
|
770
|
+
_See code: [dist/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/translation/list.ts)_
|
|
771
|
+
|
|
389
772
|
## `knock translation pull [TRANSLATIONREF]`
|
|
390
773
|
|
|
391
774
|
Pull one or more translations from an environment into a local file system.
|
|
@@ -409,6 +792,8 @@ FLAGS
|
|
|
409
792
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
410
793
|
```
|
|
411
794
|
|
|
795
|
+
_See code: [dist/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/translation/pull.ts)_
|
|
796
|
+
|
|
412
797
|
## `knock translation push [TRANSLATIONREF]`
|
|
413
798
|
|
|
414
799
|
Push one or more translations from a local file system to Knock.
|
|
@@ -434,6 +819,8 @@ FLAGS
|
|
|
434
819
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
435
820
|
```
|
|
436
821
|
|
|
822
|
+
_See code: [dist/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/translation/push.ts)_
|
|
823
|
+
|
|
437
824
|
## `knock translation validate [TRANSLATIONREF]`
|
|
438
825
|
|
|
439
826
|
Validate one or more translations from a local file system.
|
|
@@ -457,6 +844,8 @@ FLAGS
|
|
|
457
844
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
458
845
|
```
|
|
459
846
|
|
|
847
|
+
_See code: [dist/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/translation/validate.ts)_
|
|
848
|
+
|
|
460
849
|
## `knock whoami`
|
|
461
850
|
|
|
462
851
|
Verify the provided service token.
|
|
@@ -472,7 +861,7 @@ GLOBAL FLAGS
|
|
|
472
861
|
--json Format output as json.
|
|
473
862
|
```
|
|
474
863
|
|
|
475
|
-
_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.
|
|
864
|
+
_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/whoami.ts)_
|
|
476
865
|
|
|
477
866
|
## `knock workflow activate WORKFLOWKEY`
|
|
478
867
|
|
|
@@ -499,6 +888,8 @@ DESCRIPTION
|
|
|
499
888
|
with `false` in order to deactivate it.
|
|
500
889
|
```
|
|
501
890
|
|
|
891
|
+
_See code: [dist/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/activate.ts)_
|
|
892
|
+
|
|
502
893
|
## `knock workflow get WORKFLOWKEY`
|
|
503
894
|
|
|
504
895
|
Display a single workflow from an environment.
|
|
@@ -517,6 +908,8 @@ GLOBAL FLAGS
|
|
|
517
908
|
--json Format output as json.
|
|
518
909
|
```
|
|
519
910
|
|
|
911
|
+
_See code: [dist/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/get.ts)_
|
|
912
|
+
|
|
520
913
|
## `knock workflow list`
|
|
521
914
|
|
|
522
915
|
Display all workflows for an environment.
|
|
@@ -538,6 +931,8 @@ GLOBAL FLAGS
|
|
|
538
931
|
--json Format output as json.
|
|
539
932
|
```
|
|
540
933
|
|
|
934
|
+
_See code: [dist/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/list.ts)_
|
|
935
|
+
|
|
541
936
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
542
937
|
|
|
543
938
|
Pull one or more workflows from an environment into a local file system.
|
|
@@ -556,6 +951,8 @@ FLAGS
|
|
|
556
951
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
557
952
|
```
|
|
558
953
|
|
|
954
|
+
_See code: [dist/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/pull.ts)_
|
|
955
|
+
|
|
559
956
|
## `knock workflow push [WORKFLOWKEY]`
|
|
560
957
|
|
|
561
958
|
Push one or more workflows from a local file system to Knock.
|
|
@@ -575,6 +972,8 @@ FLAGS
|
|
|
575
972
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
576
973
|
```
|
|
577
974
|
|
|
975
|
+
_See code: [dist/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/push.ts)_
|
|
976
|
+
|
|
578
977
|
## `knock workflow run WORKFLOWKEY`
|
|
579
978
|
|
|
580
979
|
Test run a workflow using the latest version from Knock.
|
|
@@ -594,6 +993,8 @@ FLAGS
|
|
|
594
993
|
--tenant=<value> A tenant id for the workflow run.
|
|
595
994
|
```
|
|
596
995
|
|
|
996
|
+
_See code: [dist/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/run.ts)_
|
|
997
|
+
|
|
597
998
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
598
999
|
|
|
599
1000
|
Validate one or more workflows from a local file system.
|
|
@@ -610,4 +1011,6 @@ FLAGS
|
|
|
610
1011
|
--service-token=<value> (required) The service token to authenticate with.
|
|
611
1012
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
612
1013
|
```
|
|
1014
|
+
|
|
1015
|
+
_See code: [dist/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.5/dist/commands/workflow/validate.ts)_
|
|
613
1016
|
<!-- commandsstop -->
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "default", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: ()=>EmailLayoutGet
|
|
8
|
+
});
|
|
9
|
+
const _core = require("@oclif/core");
|
|
10
|
+
const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
|
|
11
|
+
const _date = require("../../lib/helpers/date");
|
|
12
|
+
const _request = require("../../lib/helpers/request");
|
|
13
|
+
function _interopRequireDefault(obj) {
|
|
14
|
+
return obj && obj.__esModule ? obj : {
|
|
15
|
+
default: obj
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
class EmailLayoutGet extends _baseCommand.default {
|
|
19
|
+
async run() {
|
|
20
|
+
const { flags } = this.props;
|
|
21
|
+
const resp = await (0, _request.withSpinner)(()=>this.apiV1.getEmailLayout(this.props));
|
|
22
|
+
if (flags.json) return resp.data;
|
|
23
|
+
this.render(resp.data);
|
|
24
|
+
}
|
|
25
|
+
render(email_layout) {
|
|
26
|
+
const { emailLayoutKey } = this.props.args;
|
|
27
|
+
const { environment: env , "hide-uncommitted-changes": commitedOnly } = this.props.flags;
|
|
28
|
+
const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
|
|
29
|
+
this.log(`‣ Showing email layout \`${emailLayoutKey}\` in \`${env}\` environment ${qualifier}\n`);
|
|
30
|
+
/*
|
|
31
|
+
* Email layout table
|
|
32
|
+
*/ const rows = [
|
|
33
|
+
{
|
|
34
|
+
key: "Key",
|
|
35
|
+
value: email_layout.key
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
key: "Name",
|
|
39
|
+
value: email_layout.name
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
key: "Updated at",
|
|
43
|
+
value: (0, _date.formatDate)(email_layout.updated_at)
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
key: "Created at",
|
|
47
|
+
value: (0, _date.formatDate)(email_layout.created_at)
|
|
48
|
+
}
|
|
49
|
+
];
|
|
50
|
+
_core.ux.table(rows, {
|
|
51
|
+
key: {
|
|
52
|
+
header: "Email layout",
|
|
53
|
+
minWidth: 24
|
|
54
|
+
},
|
|
55
|
+
value: {
|
|
56
|
+
header: "",
|
|
57
|
+
minWidth: 16
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
this.log("");
|
|
61
|
+
if (email_layout.footer_links) {
|
|
62
|
+
const footerLinks = (email_layout.footer_links || []).map((link)=>({
|
|
63
|
+
key: link.text,
|
|
64
|
+
value: link.url
|
|
65
|
+
}));
|
|
66
|
+
_core.ux.table(footerLinks, {
|
|
67
|
+
key: {
|
|
68
|
+
header: "Footer Links",
|
|
69
|
+
minWidth: 24
|
|
70
|
+
},
|
|
71
|
+
value: {
|
|
72
|
+
header: "",
|
|
73
|
+
minWidth: 16
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
EmailLayoutGet.aliases = [
|
|
80
|
+
"email-layout:get",
|
|
81
|
+
"email_layout:get"
|
|
82
|
+
];
|
|
83
|
+
EmailLayoutGet.summary = "Display a single email layout from an environment.";
|
|
84
|
+
EmailLayoutGet.flags = {
|
|
85
|
+
environment: _core.Flags.string({
|
|
86
|
+
default: "development",
|
|
87
|
+
summary: "The environment to use."
|
|
88
|
+
}),
|
|
89
|
+
"hide-uncommitted-changes": _core.Flags.boolean({
|
|
90
|
+
summary: "Hide any uncommitted changes."
|
|
91
|
+
})
|
|
92
|
+
};
|
|
93
|
+
EmailLayoutGet.args = {
|
|
94
|
+
emailLayoutKey: _core.Args.string({
|
|
95
|
+
required: true
|
|
96
|
+
})
|
|
97
|
+
};
|
|
98
|
+
EmailLayoutGet.enableJsonFlag = true;
|