@knocklabs/cli 0.1.10 → 0.1.12
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 +68 -531
- package/bin/dev.js +6 -0
- package/bin/run.js +7 -0
- package/dist/{commands → src/commands}/commit/get.js +24 -9
- package/dist/{commands → src/commands}/commit/index.js +23 -8
- package/dist/{commands → src/commands}/commit/list.js +29 -14
- package/dist/{commands → src/commands}/commit/promote.js +26 -11
- package/dist/{commands → src/commands}/knock.js +21 -6
- package/dist/{commands → src/commands}/layout/get.js +28 -13
- package/dist/{commands → src/commands}/layout/list.js +29 -14
- package/dist/{commands → src/commands}/layout/pull.js +47 -30
- package/dist/{commands → src/commands}/layout/push.js +38 -21
- package/dist/{commands → src/commands}/layout/validate.js +33 -16
- package/dist/src/commands/ping.js +37 -0
- package/dist/{commands → src/commands}/translation/get.js +33 -16
- package/dist/{commands → src/commands}/translation/list.js +34 -17
- package/dist/{commands → src/commands}/translation/pull.js +36 -19
- package/dist/{commands → src/commands}/translation/push.js +33 -15
- package/dist/{commands → src/commands}/translation/validate.js +30 -13
- package/dist/{commands → src/commands}/whoami.js +22 -7
- package/dist/{commands → src/commands}/workflow/activate.js +27 -12
- package/dist/{commands → src/commands}/workflow/get.js +35 -18
- package/dist/{commands → src/commands}/workflow/list.js +34 -17
- package/dist/{commands → src/commands}/workflow/new.js +37 -20
- package/dist/{commands → src/commands}/workflow/pull.js +44 -27
- package/dist/{commands → src/commands}/workflow/push.js +34 -17
- package/dist/{commands → src/commands}/workflow/run.js +25 -10
- package/dist/{commands → src/commands}/workflow/validate.js +30 -13
- package/dist/{index.js → src/index.js} +3 -1
- package/dist/{isomorphic.js → src/isomorphic.js} +8 -4
- package/dist/{lib → src/lib}/api-v1.js +57 -41
- package/dist/{lib → src/lib}/base-command.js +38 -15
- package/dist/{lib → src/lib}/helpers/const.js +18 -10
- package/dist/{lib → src/lib}/helpers/date.js +9 -5
- package/dist/{lib → src/lib}/helpers/error.js +42 -8
- package/dist/{lib → src/lib}/helpers/flag.js +24 -12
- package/dist/{lib → src/lib}/helpers/fs.js +10 -6
- package/dist/{lib → src/lib}/helpers/json.js +19 -9
- package/dist/{lib → src/lib}/helpers/liquid.js +3 -1
- package/dist/{lib → src/lib}/helpers/object.isomorphic.js +35 -7
- package/dist/{lib → src/lib}/helpers/page.js +34 -18
- package/dist/{lib → src/lib}/helpers/request.js +12 -6
- package/dist/{lib → src/lib}/helpers/string.js +8 -4
- package/dist/{lib → src/lib}/helpers/ux.js +9 -5
- package/dist/{lib → src/lib}/marshal/commit/helpers.js +3 -1
- package/dist/src/lib/marshal/commit/index.js +19 -0
- package/dist/{lib → src/lib}/marshal/conditions/helpers.js +5 -3
- package/dist/src/lib/marshal/conditions/index.js +19 -0
- package/dist/{lib → src/lib}/marshal/email-layout/helpers.js +25 -15
- package/dist/src/lib/marshal/email-layout/index.js +22 -0
- package/dist/{lib → src/lib}/marshal/email-layout/processor.isomorphic.js +17 -11
- package/dist/{lib → src/lib}/marshal/email-layout/reader.js +29 -23
- package/dist/{lib → src/lib}/marshal/email-layout/writer.js +38 -30
- package/dist/src/lib/marshal/index.isomorphic.js +26 -0
- package/dist/{lib → src/lib}/marshal/shared/const.isomorphic.js +6 -2
- package/dist/{lib → src/lib}/marshal/shared/helpers.js +22 -14
- package/dist/{lib → src/lib}/marshal/translation/helpers.js +52 -30
- package/dist/src/lib/marshal/translation/index.js +22 -0
- package/dist/{lib → src/lib}/marshal/translation/processor.isomorphic.js +9 -3
- package/dist/{lib → src/lib}/marshal/translation/reader.js +14 -10
- package/dist/{lib → src/lib}/marshal/translation/writer.js +21 -15
- package/dist/{lib → src/lib}/marshal/workflow/generator.js +23 -15
- package/dist/{lib → src/lib}/marshal/workflow/helpers.js +47 -27
- package/dist/src/lib/marshal/workflow/index.js +23 -0
- package/dist/{lib → src/lib}/marshal/workflow/processor.isomorphic.js +35 -23
- package/dist/{lib → src/lib}/marshal/workflow/reader.js +30 -24
- package/dist/{lib → src/lib}/marshal/workflow/types.js +3 -1
- package/dist/{lib → src/lib}/marshal/workflow/writer.js +40 -30
- package/dist/{lib → src/lib}/run-context/helpers.js +3 -1
- package/dist/src/lib/run-context/index.js +26 -0
- package/dist/{lib → src/lib}/run-context/loader.js +17 -13
- package/dist/{lib → src/lib}/user-config.js +13 -9
- package/oclif.manifest.json +2 -1386
- package/package.json +16 -16
- package/bin/dev +0 -17
- package/bin/run +0 -5
- package/dist/commands/ping.js +0 -22
- package/dist/lib/marshal/commit/index.js +0 -17
- package/dist/lib/marshal/conditions/index.js +0 -17
- package/dist/lib/marshal/email-layout/index.js +0 -20
- package/dist/lib/marshal/index.isomorphic.js +0 -20
- package/dist/lib/marshal/translation/index.js +0 -20
- package/dist/lib/marshal/workflow/index.js +0 -21
- package/dist/lib/run-context/index.js +0 -22
- /package/dist/{lib → src/lib}/marshal/commit/types.js +0 -0
- /package/dist/{lib → src/lib}/marshal/conditions/types.js +0 -0
- /package/dist/{lib → src/lib}/marshal/email-layout/types.js +0 -0
- /package/dist/{lib → src/lib}/marshal/shared/types.js +0 -0
- /package/dist/{lib → src/lib}/marshal/translation/types.js +0 -0
- /package/dist/{lib → src/lib}/run-context/types.js +0 -0
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.12 linux-x64 node-v18.20.2
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -27,115 +27,17 @@ USAGE
|
|
|
27
27
|
# Commands
|
|
28
28
|
|
|
29
29
|
<!-- commands -->
|
|
30
|
-
* [`knock commit`](#knock-commit)
|
|
31
|
-
* [`knock commit get ID`](#knock-commit-get-id)
|
|
32
|
-
* [`knock commit list`](#knock-commit-list)
|
|
33
|
-
* [`knock commit promote`](#knock-commit-promote)
|
|
34
30
|
* [`knock help [COMMANDS]`](#knock-help-commands)
|
|
35
|
-
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
36
|
-
* [`knock layout list`](#knock-layout-list)
|
|
37
|
-
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
38
|
-
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
39
|
-
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
40
31
|
* [`knock plugins`](#knock-plugins)
|
|
41
32
|
* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin)
|
|
42
33
|
* [`knock plugins:inspect PLUGIN...`](#knock-pluginsinspect-plugin)
|
|
43
34
|
* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin-1)
|
|
44
35
|
* [`knock plugins:link PLUGIN`](#knock-pluginslink-plugin)
|
|
45
36
|
* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin)
|
|
37
|
+
* [`knock plugins reset`](#knock-plugins-reset)
|
|
46
38
|
* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-1)
|
|
47
39
|
* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-2)
|
|
48
40
|
* [`knock plugins update`](#knock-plugins-update)
|
|
49
|
-
* [`knock translation get TRANSLATIONREF`](#knock-translation-get-translationref)
|
|
50
|
-
* [`knock translation list`](#knock-translation-list)
|
|
51
|
-
* [`knock translation pull [TRANSLATIONREF]`](#knock-translation-pull-translationref)
|
|
52
|
-
* [`knock translation push [TRANSLATIONREF]`](#knock-translation-push-translationref)
|
|
53
|
-
* [`knock translation validate [TRANSLATIONREF]`](#knock-translation-validate-translationref)
|
|
54
|
-
* [`knock whoami`](#knock-whoami)
|
|
55
|
-
* [`knock workflow activate WORKFLOWKEY`](#knock-workflow-activate-workflowkey)
|
|
56
|
-
* [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
|
|
57
|
-
* [`knock workflow list`](#knock-workflow-list)
|
|
58
|
-
* [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
|
|
59
|
-
* [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
|
|
60
|
-
* [`knock workflow run WORKFLOWKEY`](#knock-workflow-run-workflowkey)
|
|
61
|
-
* [`knock workflow validate [WORKFLOWKEY]`](#knock-workflow-validate-workflowkey)
|
|
62
|
-
|
|
63
|
-
## `knock commit`
|
|
64
|
-
|
|
65
|
-
Commit all changes in development environment.
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
USAGE
|
|
69
|
-
$ knock commit --service-token <value> [--environment development] [-m <value>] [--force]
|
|
70
|
-
|
|
71
|
-
FLAGS
|
|
72
|
-
-m, --commit-message=<value> Use the given value as the commit message.
|
|
73
|
-
--environment=<option> [default: development] Committing changes applies to the development environment only,
|
|
74
|
-
use `commit promote` to promote changes to a subsequent environment.
|
|
75
|
-
<options: development>
|
|
76
|
-
--force Remove the confirmation prompt.
|
|
77
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/index.ts)_
|
|
81
|
-
|
|
82
|
-
## `knock commit get ID`
|
|
83
|
-
|
|
84
|
-
Display a single commit
|
|
85
|
-
|
|
86
|
-
```
|
|
87
|
-
USAGE
|
|
88
|
-
$ knock commit get ID --service-token <value> [--json]
|
|
89
|
-
|
|
90
|
-
FLAGS
|
|
91
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
92
|
-
|
|
93
|
-
GLOBAL FLAGS
|
|
94
|
-
--json Format output as json.
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/get.ts)_
|
|
98
|
-
|
|
99
|
-
## `knock commit list`
|
|
100
|
-
|
|
101
|
-
Display all commits in an environment
|
|
102
|
-
|
|
103
|
-
```
|
|
104
|
-
USAGE
|
|
105
|
-
$ knock commit list --service-token <value> [--environment <value>] [--promoted] [--after <value>] [--before
|
|
106
|
-
<value>] [--limit <value>] [--json]
|
|
107
|
-
|
|
108
|
-
FLAGS
|
|
109
|
-
--after=<value> The cursor after which to fetch the next page.
|
|
110
|
-
--before=<value> The cursor before which to fetch the previous page.
|
|
111
|
-
--environment=<value> [default: development] The environment to use.
|
|
112
|
-
--limit=<value> The total number of entries to fetch per page.
|
|
113
|
-
--[no-]promoted Show only promoted or unpromoted changes between the given environment and the subsequent
|
|
114
|
-
environment.
|
|
115
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
116
|
-
|
|
117
|
-
GLOBAL FLAGS
|
|
118
|
-
--json Format output as json.
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/list.ts)_
|
|
122
|
-
|
|
123
|
-
## `knock commit promote`
|
|
124
|
-
|
|
125
|
-
Promote one or all commits to the subsequent environment.
|
|
126
|
-
|
|
127
|
-
```
|
|
128
|
-
USAGE
|
|
129
|
-
$ knock commit promote --service-token <value> [--to <value>] [--force] [--only <value>]
|
|
130
|
-
|
|
131
|
-
FLAGS
|
|
132
|
-
--force Remove the confirmation prompt.
|
|
133
|
-
--only=<value> The target commit id to promote to the subsequent environment
|
|
134
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
135
|
-
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/commit/promote.ts)_
|
|
139
41
|
|
|
140
42
|
## `knock help [COMMANDS]`
|
|
141
43
|
|
|
@@ -143,10 +45,10 @@ Display help for knock.
|
|
|
143
45
|
|
|
144
46
|
```
|
|
145
47
|
USAGE
|
|
146
|
-
$ knock help [COMMANDS] [-n]
|
|
48
|
+
$ knock help [COMMANDS...] [-n]
|
|
147
49
|
|
|
148
50
|
ARGUMENTS
|
|
149
|
-
COMMANDS Command to show help for.
|
|
51
|
+
COMMANDS... Command to show help for.
|
|
150
52
|
|
|
151
53
|
FLAGS
|
|
152
54
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -155,111 +57,7 @@ DESCRIPTION
|
|
|
155
57
|
Display help for knock.
|
|
156
58
|
```
|
|
157
59
|
|
|
158
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
159
|
-
|
|
160
|
-
## `knock layout get EMAILLAYOUTKEY`
|
|
161
|
-
|
|
162
|
-
Display a single email layout from an environment.
|
|
163
|
-
|
|
164
|
-
```
|
|
165
|
-
USAGE
|
|
166
|
-
$ knock layout get EMAILLAYOUTKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
167
|
-
[--json]
|
|
168
|
-
|
|
169
|
-
FLAGS
|
|
170
|
-
--environment=<value> [default: development] The environment to use.
|
|
171
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
172
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
173
|
-
|
|
174
|
-
GLOBAL FLAGS
|
|
175
|
-
--json Format output as json.
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/get.ts)_
|
|
179
|
-
|
|
180
|
-
## `knock layout list`
|
|
181
|
-
|
|
182
|
-
Display all email layouts for an environment.
|
|
183
|
-
|
|
184
|
-
```
|
|
185
|
-
USAGE
|
|
186
|
-
$ knock layout list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
187
|
-
<value>] [--before <value>] [--limit <value>] [--json]
|
|
188
|
-
|
|
189
|
-
FLAGS
|
|
190
|
-
--after=<value> The cursor after which to fetch the next page.
|
|
191
|
-
--before=<value> The cursor before which to fetch the previous page.
|
|
192
|
-
--environment=<value> [default: development] The environment to use.
|
|
193
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
194
|
-
--limit=<value> The total number of entries to fetch per page.
|
|
195
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
196
|
-
|
|
197
|
-
GLOBAL FLAGS
|
|
198
|
-
--json Format output as json.
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/list.ts)_
|
|
202
|
-
|
|
203
|
-
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
204
|
-
|
|
205
|
-
Pull one or more email layouts from an environment into a local file system.
|
|
206
|
-
|
|
207
|
-
```
|
|
208
|
-
USAGE
|
|
209
|
-
$ knock layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
|
|
210
|
-
--all] [--hide-uncommitted-changes] [--force]
|
|
211
|
-
|
|
212
|
-
FLAGS
|
|
213
|
-
--all Whether to pull all email layouts from the specified environment.
|
|
214
|
-
--environment=<value> [default: development] The environment to use.
|
|
215
|
-
--force Remove the confirmation prompt.
|
|
216
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
217
|
-
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
218
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/pull.ts)_
|
|
222
|
-
|
|
223
|
-
## `knock layout push [EMAILLAYOUTKEY]`
|
|
224
|
-
|
|
225
|
-
Push one or more email layouts from a local file system to Knock.
|
|
226
|
-
|
|
227
|
-
```
|
|
228
|
-
USAGE
|
|
229
|
-
$ knock layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
230
|
-
--all] [-m <value> --commit]
|
|
231
|
-
|
|
232
|
-
FLAGS
|
|
233
|
-
-m, --commit-message=<value> Use the given value as the commit message
|
|
234
|
-
--all Whether to push all layouts from the target directory.
|
|
235
|
-
--commit Push and commit the layout(s) at the same time
|
|
236
|
-
--environment=<option> [default: development] Pushing an email layout is only allowed in the development
|
|
237
|
-
environment
|
|
238
|
-
<options: development>
|
|
239
|
-
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
240
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/push.ts)_
|
|
244
|
-
|
|
245
|
-
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
246
|
-
|
|
247
|
-
Validate one or more layouts from a local file system.
|
|
248
|
-
|
|
249
|
-
```
|
|
250
|
-
USAGE
|
|
251
|
-
$ knock layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
|
|
252
|
-
--all]
|
|
253
|
-
|
|
254
|
-
FLAGS
|
|
255
|
-
--all Whether to validate all layouts from the target directory.
|
|
256
|
-
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
257
|
-
<options: development>
|
|
258
|
-
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
259
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/layout/validate.ts)_
|
|
60
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.14/src/commands/help.ts)_
|
|
263
61
|
|
|
264
62
|
## `knock plugins`
|
|
265
63
|
|
|
@@ -282,7 +80,7 @@ EXAMPLES
|
|
|
282
80
|
$ knock plugins
|
|
283
81
|
```
|
|
284
82
|
|
|
285
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
83
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/index.ts)_
|
|
286
84
|
|
|
287
85
|
## `knock plugins:install PLUGIN...`
|
|
288
86
|
|
|
@@ -290,15 +88,19 @@ Installs a plugin into the CLI.
|
|
|
290
88
|
|
|
291
89
|
```
|
|
292
90
|
USAGE
|
|
293
|
-
$ knock plugins:install PLUGIN...
|
|
91
|
+
$ knock plugins add plugins:install PLUGIN...
|
|
294
92
|
|
|
295
93
|
ARGUMENTS
|
|
296
|
-
PLUGIN Plugin to install.
|
|
94
|
+
PLUGIN... Plugin to install.
|
|
297
95
|
|
|
298
96
|
FLAGS
|
|
299
97
|
-f, --force Run yarn install with force flag.
|
|
300
98
|
-h, --help Show CLI help.
|
|
301
|
-
-
|
|
99
|
+
-s, --silent Silences yarn output.
|
|
100
|
+
-v, --verbose Show verbose yarn output.
|
|
101
|
+
|
|
102
|
+
GLOBAL FLAGS
|
|
103
|
+
--json Format output as json.
|
|
302
104
|
|
|
303
105
|
DESCRIPTION
|
|
304
106
|
Installs a plugin into the CLI.
|
|
@@ -315,11 +117,11 @@ ALIASES
|
|
|
315
117
|
$ knock plugins add
|
|
316
118
|
|
|
317
119
|
EXAMPLES
|
|
318
|
-
$ knock plugins
|
|
120
|
+
$ knock plugins add myplugin
|
|
319
121
|
|
|
320
|
-
$ knock plugins
|
|
122
|
+
$ knock plugins add https://github.com/someuser/someplugin
|
|
321
123
|
|
|
322
|
-
$ knock plugins
|
|
124
|
+
$ knock plugins add someuser/someplugin
|
|
323
125
|
```
|
|
324
126
|
|
|
325
127
|
## `knock plugins:inspect PLUGIN...`
|
|
@@ -328,10 +130,10 @@ Displays installation properties of a plugin.
|
|
|
328
130
|
|
|
329
131
|
```
|
|
330
132
|
USAGE
|
|
331
|
-
$ knock plugins
|
|
133
|
+
$ knock plugins inspect PLUGIN...
|
|
332
134
|
|
|
333
135
|
ARGUMENTS
|
|
334
|
-
PLUGIN [default: .] Plugin to inspect.
|
|
136
|
+
PLUGIN... [default: .] Plugin to inspect.
|
|
335
137
|
|
|
336
138
|
FLAGS
|
|
337
139
|
-h, --help Show CLI help.
|
|
@@ -344,10 +146,10 @@ DESCRIPTION
|
|
|
344
146
|
Displays installation properties of a plugin.
|
|
345
147
|
|
|
346
148
|
EXAMPLES
|
|
347
|
-
$ knock plugins
|
|
149
|
+
$ knock plugins inspect myplugin
|
|
348
150
|
```
|
|
349
151
|
|
|
350
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
152
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/inspect.ts)_
|
|
351
153
|
|
|
352
154
|
## `knock plugins:install PLUGIN...`
|
|
353
155
|
|
|
@@ -355,15 +157,19 @@ Installs a plugin into the CLI.
|
|
|
355
157
|
|
|
356
158
|
```
|
|
357
159
|
USAGE
|
|
358
|
-
$ knock plugins
|
|
160
|
+
$ knock plugins install PLUGIN...
|
|
359
161
|
|
|
360
162
|
ARGUMENTS
|
|
361
|
-
PLUGIN Plugin to install.
|
|
163
|
+
PLUGIN... Plugin to install.
|
|
362
164
|
|
|
363
165
|
FLAGS
|
|
364
166
|
-f, --force Run yarn install with force flag.
|
|
365
167
|
-h, --help Show CLI help.
|
|
366
|
-
-
|
|
168
|
+
-s, --silent Silences yarn output.
|
|
169
|
+
-v, --verbose Show verbose yarn output.
|
|
170
|
+
|
|
171
|
+
GLOBAL FLAGS
|
|
172
|
+
--json Format output as json.
|
|
367
173
|
|
|
368
174
|
DESCRIPTION
|
|
369
175
|
Installs a plugin into the CLI.
|
|
@@ -380,14 +186,14 @@ ALIASES
|
|
|
380
186
|
$ knock plugins add
|
|
381
187
|
|
|
382
188
|
EXAMPLES
|
|
383
|
-
$ knock plugins
|
|
189
|
+
$ knock plugins install myplugin
|
|
384
190
|
|
|
385
|
-
$ knock plugins
|
|
191
|
+
$ knock plugins install https://github.com/someuser/someplugin
|
|
386
192
|
|
|
387
|
-
$ knock plugins
|
|
193
|
+
$ knock plugins install someuser/someplugin
|
|
388
194
|
```
|
|
389
195
|
|
|
390
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
196
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/install.ts)_
|
|
391
197
|
|
|
392
198
|
## `knock plugins:link PLUGIN`
|
|
393
199
|
|
|
@@ -395,15 +201,15 @@ Links a plugin into the CLI for development.
|
|
|
395
201
|
|
|
396
202
|
```
|
|
397
203
|
USAGE
|
|
398
|
-
$ knock plugins
|
|
204
|
+
$ knock plugins link PLUGIN
|
|
399
205
|
|
|
400
206
|
ARGUMENTS
|
|
401
207
|
PATH [default: .] path to plugin
|
|
402
208
|
|
|
403
209
|
FLAGS
|
|
404
|
-
-h, --help
|
|
210
|
+
-h, --help Show CLI help.
|
|
405
211
|
-v, --verbose
|
|
406
|
-
|
|
212
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
407
213
|
|
|
408
214
|
DESCRIPTION
|
|
409
215
|
Links a plugin into the CLI for development.
|
|
@@ -414,10 +220,10 @@ DESCRIPTION
|
|
|
414
220
|
|
|
415
221
|
|
|
416
222
|
EXAMPLES
|
|
417
|
-
$ knock plugins
|
|
223
|
+
$ knock plugins link myplugin
|
|
418
224
|
```
|
|
419
225
|
|
|
420
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
226
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/link.ts)_
|
|
421
227
|
|
|
422
228
|
## `knock plugins:uninstall PLUGIN...`
|
|
423
229
|
|
|
@@ -425,10 +231,10 @@ Removes a plugin from the CLI.
|
|
|
425
231
|
|
|
426
232
|
```
|
|
427
233
|
USAGE
|
|
428
|
-
$ knock plugins:uninstall PLUGIN...
|
|
234
|
+
$ knock plugins remove plugins:uninstall PLUGIN...
|
|
429
235
|
|
|
430
236
|
ARGUMENTS
|
|
431
|
-
PLUGIN plugin to uninstall
|
|
237
|
+
PLUGIN... plugin to uninstall
|
|
432
238
|
|
|
433
239
|
FLAGS
|
|
434
240
|
-h, --help Show CLI help.
|
|
@@ -440,18 +246,36 @@ DESCRIPTION
|
|
|
440
246
|
ALIASES
|
|
441
247
|
$ knock plugins unlink
|
|
442
248
|
$ knock plugins remove
|
|
249
|
+
|
|
250
|
+
EXAMPLES
|
|
251
|
+
$ knock plugins remove myplugin
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## `knock plugins reset`
|
|
255
|
+
|
|
256
|
+
Remove all user-installed and linked plugins.
|
|
257
|
+
|
|
258
|
+
```
|
|
259
|
+
USAGE
|
|
260
|
+
$ knock plugins reset [--hard] [--reinstall]
|
|
261
|
+
|
|
262
|
+
FLAGS
|
|
263
|
+
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
264
|
+
--reinstall Reinstall all plugins after uninstalling.
|
|
443
265
|
```
|
|
444
266
|
|
|
267
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/reset.ts)_
|
|
268
|
+
|
|
445
269
|
## `knock plugins:uninstall PLUGIN...`
|
|
446
270
|
|
|
447
271
|
Removes a plugin from the CLI.
|
|
448
272
|
|
|
449
273
|
```
|
|
450
274
|
USAGE
|
|
451
|
-
$ knock plugins
|
|
275
|
+
$ knock plugins uninstall PLUGIN...
|
|
452
276
|
|
|
453
277
|
ARGUMENTS
|
|
454
|
-
PLUGIN plugin to uninstall
|
|
278
|
+
PLUGIN... plugin to uninstall
|
|
455
279
|
|
|
456
280
|
FLAGS
|
|
457
281
|
-h, --help Show CLI help.
|
|
@@ -463,9 +287,12 @@ DESCRIPTION
|
|
|
463
287
|
ALIASES
|
|
464
288
|
$ knock plugins unlink
|
|
465
289
|
$ knock plugins remove
|
|
290
|
+
|
|
291
|
+
EXAMPLES
|
|
292
|
+
$ knock plugins uninstall myplugin
|
|
466
293
|
```
|
|
467
294
|
|
|
468
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
295
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/uninstall.ts)_
|
|
469
296
|
|
|
470
297
|
## `knock plugins:uninstall PLUGIN...`
|
|
471
298
|
|
|
@@ -473,10 +300,10 @@ Removes a plugin from the CLI.
|
|
|
473
300
|
|
|
474
301
|
```
|
|
475
302
|
USAGE
|
|
476
|
-
$ knock plugins:uninstall PLUGIN...
|
|
303
|
+
$ knock plugins unlink plugins:uninstall PLUGIN...
|
|
477
304
|
|
|
478
305
|
ARGUMENTS
|
|
479
|
-
PLUGIN plugin to uninstall
|
|
306
|
+
PLUGIN... plugin to uninstall
|
|
480
307
|
|
|
481
308
|
FLAGS
|
|
482
309
|
-h, --help Show CLI help.
|
|
@@ -488,6 +315,9 @@ DESCRIPTION
|
|
|
488
315
|
ALIASES
|
|
489
316
|
$ knock plugins unlink
|
|
490
317
|
$ knock plugins remove
|
|
318
|
+
|
|
319
|
+
EXAMPLES
|
|
320
|
+
$ knock plugins unlink myplugin
|
|
491
321
|
```
|
|
492
322
|
|
|
493
323
|
## `knock plugins update`
|
|
@@ -506,298 +336,5 @@ DESCRIPTION
|
|
|
506
336
|
Update installed plugins.
|
|
507
337
|
```
|
|
508
338
|
|
|
509
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
510
|
-
|
|
511
|
-
## `knock translation get TRANSLATIONREF`
|
|
512
|
-
|
|
513
|
-
Display a single translation from an environment.
|
|
514
|
-
|
|
515
|
-
```
|
|
516
|
-
USAGE
|
|
517
|
-
$ knock translation get TRANSLATIONREF --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
518
|
-
[--json]
|
|
519
|
-
|
|
520
|
-
ARGUMENTS
|
|
521
|
-
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
522
|
-
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
523
|
-
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
524
|
-
|
|
525
|
-
FLAGS
|
|
526
|
-
--environment=<value> [default: development] The environment to use.
|
|
527
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
528
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
529
|
-
|
|
530
|
-
GLOBAL FLAGS
|
|
531
|
-
--json Format output as json.
|
|
532
|
-
```
|
|
533
|
-
|
|
534
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/get.ts)_
|
|
535
|
-
|
|
536
|
-
## `knock translation list`
|
|
537
|
-
|
|
538
|
-
Display all translations for an environment.
|
|
539
|
-
|
|
540
|
-
```
|
|
541
|
-
USAGE
|
|
542
|
-
$ knock translation list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
543
|
-
<value>] [--before <value>] [--limit <value>] [--json]
|
|
544
|
-
|
|
545
|
-
FLAGS
|
|
546
|
-
--after=<value> The cursor after which to fetch the next page.
|
|
547
|
-
--before=<value> The cursor before which to fetch the previous page.
|
|
548
|
-
--environment=<value> [default: development] The environment to use.
|
|
549
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
550
|
-
--limit=<value> The total number of entries to fetch per page.
|
|
551
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
552
|
-
|
|
553
|
-
GLOBAL FLAGS
|
|
554
|
-
--json Format output as json.
|
|
555
|
-
```
|
|
556
|
-
|
|
557
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/list.ts)_
|
|
558
|
-
|
|
559
|
-
## `knock translation pull [TRANSLATIONREF]`
|
|
560
|
-
|
|
561
|
-
Pull one or more translations from an environment into a local file system.
|
|
562
|
-
|
|
563
|
-
```
|
|
564
|
-
USAGE
|
|
565
|
-
$ knock translation pull [TRANSLATIONREF] --service-token <value> [--environment <value>] [--translations-dir
|
|
566
|
-
<value> --all] [--hide-uncommitted-changes] [--force]
|
|
567
|
-
|
|
568
|
-
ARGUMENTS
|
|
569
|
-
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
570
|
-
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
571
|
-
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
572
|
-
|
|
573
|
-
FLAGS
|
|
574
|
-
--all Whether to pull all translations from the specified environment.
|
|
575
|
-
--environment=<value> [default: development] The environment to use.
|
|
576
|
-
--force Remove the confirmation prompt.
|
|
577
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
578
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
579
|
-
--translations-dir=<value> The target directory path to pull all translations into.
|
|
580
|
-
```
|
|
581
|
-
|
|
582
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/pull.ts)_
|
|
583
|
-
|
|
584
|
-
## `knock translation push [TRANSLATIONREF]`
|
|
585
|
-
|
|
586
|
-
Push one or more translations from a local file system to Knock.
|
|
587
|
-
|
|
588
|
-
```
|
|
589
|
-
USAGE
|
|
590
|
-
$ knock translation push [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
|
|
591
|
-
<value> --all] [-m <value> --commit]
|
|
592
|
-
|
|
593
|
-
ARGUMENTS
|
|
594
|
-
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
595
|
-
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
596
|
-
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
597
|
-
|
|
598
|
-
FLAGS
|
|
599
|
-
-m, --commit-message=<value> Use the given value as the commit message
|
|
600
|
-
--all Whether to push all translations from the target directory.
|
|
601
|
-
--commit Push and commit the translation(s) at the same time
|
|
602
|
-
--environment=<option> [default: development] Pushing a translation is only allowed in the development
|
|
603
|
-
environment
|
|
604
|
-
<options: development>
|
|
605
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
606
|
-
--translations-dir=<value> The target directory path to find all translations to push.
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/push.ts)_
|
|
610
|
-
|
|
611
|
-
## `knock translation validate [TRANSLATIONREF]`
|
|
612
|
-
|
|
613
|
-
Validate one or more translations from a local file system.
|
|
614
|
-
|
|
615
|
-
```
|
|
616
|
-
USAGE
|
|
617
|
-
$ knock translation validate [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
|
|
618
|
-
<value> --all]
|
|
619
|
-
|
|
620
|
-
ARGUMENTS
|
|
621
|
-
TRANSLATIONREF Translation ref is a identifier string that refers to a unique translation.
|
|
622
|
-
If a translation has no namespace, it is the same as the locale, e.g. `en`.
|
|
623
|
-
If namespaced, it is formatted as namespace.locale, e.g. `admin.en`.
|
|
624
|
-
|
|
625
|
-
FLAGS
|
|
626
|
-
--all Whether to validate all translations from the target directory.
|
|
627
|
-
--environment=<option> [default: development] Validating a translation is only done in the development
|
|
628
|
-
environment
|
|
629
|
-
<options: development>
|
|
630
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
631
|
-
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
632
|
-
```
|
|
633
|
-
|
|
634
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/translation/validate.ts)_
|
|
635
|
-
|
|
636
|
-
## `knock whoami`
|
|
637
|
-
|
|
638
|
-
Verify the provided service token.
|
|
639
|
-
|
|
640
|
-
```
|
|
641
|
-
USAGE
|
|
642
|
-
$ knock whoami --service-token <value> [--json]
|
|
643
|
-
|
|
644
|
-
FLAGS
|
|
645
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
646
|
-
|
|
647
|
-
GLOBAL FLAGS
|
|
648
|
-
--json Format output as json.
|
|
649
|
-
```
|
|
650
|
-
|
|
651
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/whoami.ts)_
|
|
652
|
-
|
|
653
|
-
## `knock workflow activate WORKFLOWKEY`
|
|
654
|
-
|
|
655
|
-
Activate or deactivate a workflow in a given environment.
|
|
656
|
-
|
|
657
|
-
```
|
|
658
|
-
USAGE
|
|
659
|
-
$ knock workflow activate WORKFLOWKEY --service-token <value> --environment <value> [--status true|false] [--force]
|
|
660
|
-
|
|
661
|
-
FLAGS
|
|
662
|
-
--environment=<value> (required) The environment to use.
|
|
663
|
-
--force Remove the confirmation prompt.
|
|
664
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
665
|
-
--status=<option> [default: true] The workflow active status to set.
|
|
666
|
-
<options: true|false>
|
|
667
|
-
|
|
668
|
-
DESCRIPTION
|
|
669
|
-
Activate or deactivate a workflow in a given environment.
|
|
670
|
-
|
|
671
|
-
This immediately enables or disables a workflow in a given environment without
|
|
672
|
-
needing to go through environment promotion.
|
|
673
|
-
|
|
674
|
-
By default, this command activates a given workflow. Pass in the --status flag
|
|
675
|
-
with `false` in order to deactivate it.
|
|
676
|
-
```
|
|
677
|
-
|
|
678
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/activate.ts)_
|
|
679
|
-
|
|
680
|
-
## `knock workflow get WORKFLOWKEY`
|
|
681
|
-
|
|
682
|
-
Display a single workflow from an environment.
|
|
683
|
-
|
|
684
|
-
```
|
|
685
|
-
USAGE
|
|
686
|
-
$ knock workflow get WORKFLOWKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
|
|
687
|
-
[--json]
|
|
688
|
-
|
|
689
|
-
FLAGS
|
|
690
|
-
--environment=<value> [default: development] The environment to use.
|
|
691
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
692
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
693
|
-
|
|
694
|
-
GLOBAL FLAGS
|
|
695
|
-
--json Format output as json.
|
|
696
|
-
```
|
|
697
|
-
|
|
698
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/get.ts)_
|
|
699
|
-
|
|
700
|
-
## `knock workflow list`
|
|
701
|
-
|
|
702
|
-
Display all workflows for an environment.
|
|
703
|
-
|
|
704
|
-
```
|
|
705
|
-
USAGE
|
|
706
|
-
$ knock workflow list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
|
|
707
|
-
<value>] [--before <value>] [--limit <value>] [--json]
|
|
708
|
-
|
|
709
|
-
FLAGS
|
|
710
|
-
--after=<value> The cursor after which to fetch the next page.
|
|
711
|
-
--before=<value> The cursor before which to fetch the previous page.
|
|
712
|
-
--environment=<value> [default: development] The environment to use.
|
|
713
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
714
|
-
--limit=<value> The total number of entries to fetch per page.
|
|
715
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
716
|
-
|
|
717
|
-
GLOBAL FLAGS
|
|
718
|
-
--json Format output as json.
|
|
719
|
-
```
|
|
720
|
-
|
|
721
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/list.ts)_
|
|
722
|
-
|
|
723
|
-
## `knock workflow pull [WORKFLOWKEY]`
|
|
724
|
-
|
|
725
|
-
Pull one or more workflows from an environment into a local file system.
|
|
726
|
-
|
|
727
|
-
```
|
|
728
|
-
USAGE
|
|
729
|
-
$ knock workflow pull [WORKFLOWKEY] --service-token <value> [--environment <value>] [--workflows-dir <value>
|
|
730
|
-
--all] [--hide-uncommitted-changes] [--force]
|
|
731
|
-
|
|
732
|
-
FLAGS
|
|
733
|
-
--all Whether to pull all workflows from the specified environment.
|
|
734
|
-
--environment=<value> [default: development] The environment to use.
|
|
735
|
-
--force Remove the confirmation prompt.
|
|
736
|
-
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
737
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
738
|
-
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
739
|
-
```
|
|
740
|
-
|
|
741
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/pull.ts)_
|
|
742
|
-
|
|
743
|
-
## `knock workflow push [WORKFLOWKEY]`
|
|
744
|
-
|
|
745
|
-
Push one or more workflows from a local file system to Knock.
|
|
746
|
-
|
|
747
|
-
```
|
|
748
|
-
USAGE
|
|
749
|
-
$ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
|
|
750
|
-
--all] [-m <value> --commit]
|
|
751
|
-
|
|
752
|
-
FLAGS
|
|
753
|
-
-m, --commit-message=<value> Use the given value as the commit message
|
|
754
|
-
--all Whether to push all workflows from the target directory.
|
|
755
|
-
--commit Push and commit the workflow(s) at the same time
|
|
756
|
-
--environment=<option> [default: development] Pushing a workflow is only allowed in the development environment
|
|
757
|
-
<options: development>
|
|
758
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
759
|
-
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
760
|
-
```
|
|
761
|
-
|
|
762
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/push.ts)_
|
|
763
|
-
|
|
764
|
-
## `knock workflow run WORKFLOWKEY`
|
|
765
|
-
|
|
766
|
-
Test run a workflow using the latest version from Knock.
|
|
767
|
-
|
|
768
|
-
```
|
|
769
|
-
USAGE
|
|
770
|
-
$ knock workflow run WORKFLOWKEY --service-token <value> --recipients <value> [--environment <value>] [--actor
|
|
771
|
-
<value>] [--tenant <value>] [--data <value>]
|
|
772
|
-
|
|
773
|
-
FLAGS
|
|
774
|
-
--actor=<value> An actor id, or a JSON string of an actor object reference for the workflow run.
|
|
775
|
-
--data=<value> A JSON string of the data for this workflow
|
|
776
|
-
--environment=<value> [default: development] The environment in which to run the workflow
|
|
777
|
-
--recipients=<value> (required) One or more recipient user ids separated by comma, or a JSON string containing one
|
|
778
|
-
or more recipient object references for this workflow run.
|
|
779
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
780
|
-
--tenant=<value> A tenant id for the workflow run.
|
|
781
|
-
```
|
|
782
|
-
|
|
783
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/run.ts)_
|
|
784
|
-
|
|
785
|
-
## `knock workflow validate [WORKFLOWKEY]`
|
|
786
|
-
|
|
787
|
-
Validate one or more workflows from a local file system.
|
|
788
|
-
|
|
789
|
-
```
|
|
790
|
-
USAGE
|
|
791
|
-
$ knock workflow validate [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
|
|
792
|
-
--all]
|
|
793
|
-
|
|
794
|
-
FLAGS
|
|
795
|
-
--all Whether to validate all workflows from the target directory.
|
|
796
|
-
--environment=<option> [default: development] Validating a workflow is only done in the development environment
|
|
797
|
-
<options: development>
|
|
798
|
-
--service-token=<value> (required) The service token to authenticate with.
|
|
799
|
-
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
800
|
-
```
|
|
801
|
-
|
|
802
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.10/src/commands/workflow/validate.ts)_
|
|
339
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.3/src/commands/plugins/update.ts)_
|
|
803
340
|
<!-- commandsstop -->
|