@knocklabs/cli 0.1.22 → 0.2.0
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 +191 -106
- package/bin/dev.js +4 -4
- package/dist/commands/commit/list.js +21 -1
- package/dist/commands/guide/activate.js +121 -0
- package/dist/commands/guide/generate-types.js +148 -0
- package/dist/commands/guide/get.js +139 -0
- package/dist/commands/guide/list.js +112 -0
- package/dist/commands/guide/pull.js +209 -0
- package/dist/commands/guide/push.js +171 -0
- package/dist/commands/guide/validate.js +148 -0
- package/dist/commands/knock.js +3 -0
- package/dist/commands/login.js +50 -0
- package/dist/commands/logout.js +48 -0
- package/dist/commands/whoami.js +6 -2
- package/dist/commands/workflow/generate-types.js +6 -5
- package/dist/lib/api-v1.js +74 -4
- package/dist/lib/auth.js +256 -0
- package/dist/lib/base-command.js +85 -12
- package/dist/lib/helpers/browser.js +25 -0
- package/dist/lib/helpers/const.js +4 -4
- package/dist/lib/helpers/date.js +3 -3
- package/dist/lib/helpers/error.js +8 -8
- package/dist/lib/helpers/flag.js +7 -7
- package/dist/lib/helpers/json.js +5 -5
- package/dist/lib/helpers/object.isomorphic.js +8 -8
- package/dist/lib/helpers/page.js +9 -9
- package/dist/lib/helpers/request.js +4 -4
- package/dist/lib/helpers/string.js +3 -3
- package/dist/lib/helpers/typegen.js +59 -0
- package/dist/lib/helpers/ux.js +3 -3
- package/dist/lib/marshal/email-layout/helpers.js +5 -5
- package/dist/lib/marshal/email-layout/processor.isomorphic.js +3 -3
- package/dist/lib/marshal/email-layout/reader.js +5 -5
- package/dist/lib/marshal/email-layout/writer.js +4 -4
- package/dist/lib/marshal/guide/helpers.js +283 -0
- package/dist/lib/marshal/guide/index.js +3 -0
- package/dist/lib/marshal/guide/processor.isomorphic.js +3 -3
- package/dist/lib/marshal/guide/reader.js +193 -0
- package/dist/lib/marshal/guide/writer.js +175 -0
- package/dist/lib/marshal/index.isomorphic.js +7 -7
- package/dist/lib/marshal/message-type/helpers.js +5 -5
- package/dist/lib/marshal/message-type/processor.isomorphic.js +3 -3
- package/dist/lib/marshal/message-type/reader.js +5 -5
- package/dist/lib/marshal/message-type/writer.js +4 -4
- package/dist/lib/marshal/partial/helpers.js +5 -5
- package/dist/lib/marshal/partial/processor.isomorphic.js +3 -3
- package/dist/lib/marshal/partial/reader.js +5 -5
- package/dist/lib/marshal/partial/writer.js +4 -4
- package/dist/lib/marshal/shared/const.isomorphic.js +3 -3
- package/dist/lib/marshal/shared/helpers.isomorphic.js +9 -2
- package/dist/lib/marshal/shared/helpers.js +4 -4
- package/dist/lib/marshal/translation/helpers.js +10 -10
- package/dist/lib/marshal/translation/processor.isomorphic.js +6 -6
- package/dist/lib/marshal/translation/writer.js +3 -3
- package/dist/lib/marshal/workflow/generator.js +4 -4
- package/dist/lib/marshal/workflow/helpers.js +53 -10
- package/dist/lib/marshal/workflow/processor.isomorphic.js +5 -5
- package/dist/lib/marshal/workflow/reader.js +5 -5
- package/dist/lib/marshal/workflow/writer.js +5 -5
- package/dist/lib/resources.js +3 -3
- package/dist/lib/types.js +4 -0
- package/dist/lib/urls.js +32 -0
- package/dist/lib/user-config.js +69 -31
- package/oclif.manifest.json +749 -114
- package/package.json +12 -11
- package/dist/lib/type-generator.js +0 -100
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.
|
|
19
|
+
@knocklabs/cli/0.2.0 linux-x64 node-v18.20.8
|
|
20
20
|
$ knock --help [COMMAND]
|
|
21
21
|
USAGE
|
|
22
22
|
$ knock COMMAND
|
|
@@ -31,12 +31,16 @@ USAGE
|
|
|
31
31
|
* [`knock commit get ID`](#knock-commit-get-id)
|
|
32
32
|
* [`knock commit list`](#knock-commit-list)
|
|
33
33
|
* [`knock commit promote`](#knock-commit-promote)
|
|
34
|
+
* [`knock guide activate GUIDEKEY`](#knock-guide-activate-guidekey)
|
|
35
|
+
* [`knock guide generate-types`](#knock-guide-generate-types)
|
|
34
36
|
* [`knock help [COMMAND]`](#knock-help-command)
|
|
35
37
|
* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
|
|
36
38
|
* [`knock layout list`](#knock-layout-list)
|
|
37
39
|
* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
|
|
38
40
|
* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
|
|
39
41
|
* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
|
|
42
|
+
* [`knock login`](#knock-login)
|
|
43
|
+
* [`knock logout`](#knock-logout)
|
|
40
44
|
* [`knock partial get PARTIALKEY`](#knock-partial-get-partialkey)
|
|
41
45
|
* [`knock partial list`](#knock-partial-list)
|
|
42
46
|
* [`knock partial pull [PARTIALKEY]`](#knock-partial-pull-partialkey)
|
|
@@ -65,7 +69,7 @@ Commit all changes in development environment.
|
|
|
65
69
|
|
|
66
70
|
```
|
|
67
71
|
USAGE
|
|
68
|
-
$ knock commit --service-token <value> [--environment development] [-m <value>] [--force]
|
|
72
|
+
$ knock commit [--service-token <value>] [--environment development] [-m <value>] [--force]
|
|
69
73
|
|
|
70
74
|
FLAGS
|
|
71
75
|
-m, --commit-message=<value> Use the given value as the commit message.
|
|
@@ -73,10 +77,10 @@ FLAGS
|
|
|
73
77
|
use `commit promote` to promote changes to a subsequent environment.
|
|
74
78
|
<options: development>
|
|
75
79
|
--force Remove the confirmation prompt.
|
|
76
|
-
--service-token=<value>
|
|
80
|
+
--service-token=<value> The service token to authenticate with.
|
|
77
81
|
```
|
|
78
82
|
|
|
79
|
-
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
83
|
+
_See code: [src/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/index.ts)_
|
|
80
84
|
|
|
81
85
|
## `knock commit get ID`
|
|
82
86
|
|
|
@@ -84,16 +88,16 @@ Display a single commit
|
|
|
84
88
|
|
|
85
89
|
```
|
|
86
90
|
USAGE
|
|
87
|
-
$ knock commit get ID --service-token <value>
|
|
91
|
+
$ knock commit get ID [--json] [--service-token <value>]
|
|
88
92
|
|
|
89
93
|
FLAGS
|
|
90
|
-
--service-token=<value>
|
|
94
|
+
--service-token=<value> The service token to authenticate with.
|
|
91
95
|
|
|
92
96
|
GLOBAL FLAGS
|
|
93
97
|
--json Format output as json.
|
|
94
98
|
```
|
|
95
99
|
|
|
96
|
-
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
100
|
+
_See code: [src/commands/commit/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/get.ts)_
|
|
97
101
|
|
|
98
102
|
## `knock commit list`
|
|
99
103
|
|
|
@@ -101,23 +105,29 @@ Display all commits in an environment
|
|
|
101
105
|
|
|
102
106
|
```
|
|
103
107
|
USAGE
|
|
104
|
-
$ knock commit list --service-token <value>
|
|
105
|
-
[--
|
|
108
|
+
$ knock commit list [--json] [--service-token <value>] [--environment <value>] [--promoted] [--resource-type
|
|
109
|
+
email_layout|guide|message_type|partial|translation|workflow] [--resource-id <value>] [--after <value>] [--before
|
|
110
|
+
<value>] [--limit <value>]
|
|
106
111
|
|
|
107
112
|
FLAGS
|
|
108
|
-
--after=<value>
|
|
109
|
-
--before=<value>
|
|
110
|
-
--environment=<value>
|
|
111
|
-
--limit=<value>
|
|
112
|
-
--[no-]promoted
|
|
113
|
-
|
|
114
|
-
--
|
|
113
|
+
--after=<value> The cursor after which to fetch the next page.
|
|
114
|
+
--before=<value> The cursor before which to fetch the previous page.
|
|
115
|
+
--environment=<value> [default: development] The environment to use.
|
|
116
|
+
--limit=<value> The total number of entries to fetch per page.
|
|
117
|
+
--[no-]promoted Show only promoted or unpromoted changes between the given environment and the subsequent
|
|
118
|
+
environment.
|
|
119
|
+
--resource-id=<value> Filter commits by resource identifier. Must be used together with resource-type. For most
|
|
120
|
+
resources, this will be the resource key. In the case of translations, this will be the
|
|
121
|
+
locale code and namespace, separated by a /. For example, en/courses or en.
|
|
122
|
+
--resource-type=<option> Filter commits by resource type. Must be used together with resource-id.
|
|
123
|
+
<options: email_layout|guide|message_type|partial|translation|workflow>
|
|
124
|
+
--service-token=<value> The service token to authenticate with.
|
|
115
125
|
|
|
116
126
|
GLOBAL FLAGS
|
|
117
127
|
--json Format output as json.
|
|
118
128
|
```
|
|
119
129
|
|
|
120
|
-
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
130
|
+
_See code: [src/commands/commit/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/list.ts)_
|
|
121
131
|
|
|
122
132
|
## `knock commit promote`
|
|
123
133
|
|
|
@@ -125,16 +135,67 @@ Promote one or all commits to the subsequent environment.
|
|
|
125
135
|
|
|
126
136
|
```
|
|
127
137
|
USAGE
|
|
128
|
-
$ knock commit promote --service-token <value> [--to <value>] [--force] [--only <value>]
|
|
138
|
+
$ knock commit promote [--service-token <value>] [--to <value>] [--force] [--only <value>]
|
|
129
139
|
|
|
130
140
|
FLAGS
|
|
131
141
|
--force Remove the confirmation prompt.
|
|
132
142
|
--only=<value> The target commit id to promote to the subsequent environment
|
|
133
|
-
--service-token=<value>
|
|
143
|
+
--service-token=<value> The service token to authenticate with.
|
|
134
144
|
--to=<value> The destination environment to promote all changes from the preceding environment.
|
|
135
145
|
```
|
|
136
146
|
|
|
137
|
-
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
147
|
+
_See code: [src/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/commit/promote.ts)_
|
|
148
|
+
|
|
149
|
+
## `knock guide activate GUIDEKEY`
|
|
150
|
+
|
|
151
|
+
Activate or deactivate a guide in a given environment.
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
USAGE
|
|
155
|
+
$ knock guide activate GUIDEKEY --environment <value> [--service-token <value>] [--status true|false | --from
|
|
156
|
+
<value> | --until <value>] [--force]
|
|
157
|
+
|
|
158
|
+
FLAGS
|
|
159
|
+
--environment=<value> (required) The environment to use.
|
|
160
|
+
--force Remove the confirmation prompt.
|
|
161
|
+
--from=<value> Activate the guide from this ISO8601 UTC datetime (e.g., '2024-01-15T10:30:00Z').
|
|
162
|
+
--service-token=<value> The service token to authenticate with.
|
|
163
|
+
--status=<option> The guide active status to set. Cannot be used with --from/--until.
|
|
164
|
+
<options: true|false>
|
|
165
|
+
--until=<value> Deactivate the guide at this ISO8601 UTC datetime (e.g., '2024-01-15T18:30:00Z').
|
|
166
|
+
|
|
167
|
+
DESCRIPTION
|
|
168
|
+
Activate or deactivate a guide in a given environment.
|
|
169
|
+
|
|
170
|
+
This enables or disables a guide in a given environment without
|
|
171
|
+
needing to go through environment promotion.
|
|
172
|
+
|
|
173
|
+
You can activate or deactivate a guide immediately or schedule it to be activated
|
|
174
|
+
or deactivated at a later time using the --from and --until flags.
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
_See code: [src/commands/guide/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/guide/activate.ts)_
|
|
178
|
+
|
|
179
|
+
## `knock guide generate-types`
|
|
180
|
+
|
|
181
|
+
Generate types for all guides in an environment and write them to a file.
|
|
182
|
+
|
|
183
|
+
```
|
|
184
|
+
USAGE
|
|
185
|
+
$ knock guide generate-types --output-file <value> [--service-token <value>] [--environment <value>]
|
|
186
|
+
|
|
187
|
+
FLAGS
|
|
188
|
+
--environment=<value> [default: development] Select the environment to generate types for.
|
|
189
|
+
--output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .py,
|
|
190
|
+
.go, .rb files only. Your file extension will determine the target language for the generated
|
|
191
|
+
types.
|
|
192
|
+
--service-token=<value> The service token to authenticate with.
|
|
193
|
+
|
|
194
|
+
DESCRIPTION
|
|
195
|
+
Generate types for all guides in an environment and write them to a file.
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
_See code: [src/commands/guide/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/guide/generate-types.ts)_
|
|
138
199
|
|
|
139
200
|
## `knock help [COMMAND]`
|
|
140
201
|
|
|
@@ -154,7 +215,7 @@ DESCRIPTION
|
|
|
154
215
|
Display help for knock.
|
|
155
216
|
```
|
|
156
217
|
|
|
157
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
218
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
|
|
158
219
|
|
|
159
220
|
## `knock layout get EMAILLAYOUTKEY`
|
|
160
221
|
|
|
@@ -162,19 +223,19 @@ Display a single email layout from an environment.
|
|
|
162
223
|
|
|
163
224
|
```
|
|
164
225
|
USAGE
|
|
165
|
-
$ knock layout get EMAILLAYOUTKEY --service-token <value>
|
|
226
|
+
$ knock layout get EMAILLAYOUTKEY [--json] [--service-token <value>] [--environment <value>]
|
|
166
227
|
[--hide-uncommitted-changes]
|
|
167
228
|
|
|
168
229
|
FLAGS
|
|
169
230
|
--environment=<value> [default: development] The environment to use.
|
|
170
231
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
171
|
-
--service-token=<value>
|
|
232
|
+
--service-token=<value> The service token to authenticate with.
|
|
172
233
|
|
|
173
234
|
GLOBAL FLAGS
|
|
174
235
|
--json Format output as json.
|
|
175
236
|
```
|
|
176
237
|
|
|
177
|
-
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
238
|
+
_See code: [src/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/get.ts)_
|
|
178
239
|
|
|
179
240
|
## `knock layout list`
|
|
180
241
|
|
|
@@ -182,7 +243,7 @@ Display all email layouts for an environment.
|
|
|
182
243
|
|
|
183
244
|
```
|
|
184
245
|
USAGE
|
|
185
|
-
$ knock layout list --service-token <value>
|
|
246
|
+
$ knock layout list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
|
|
186
247
|
[--after <value>] [--before <value>] [--limit <value>]
|
|
187
248
|
|
|
188
249
|
FLAGS
|
|
@@ -191,13 +252,13 @@ FLAGS
|
|
|
191
252
|
--environment=<value> [default: development] The environment to use.
|
|
192
253
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
193
254
|
--limit=<value> The total number of entries to fetch per page.
|
|
194
|
-
--service-token=<value>
|
|
255
|
+
--service-token=<value> The service token to authenticate with.
|
|
195
256
|
|
|
196
257
|
GLOBAL FLAGS
|
|
197
258
|
--json Format output as json.
|
|
198
259
|
```
|
|
199
260
|
|
|
200
|
-
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
261
|
+
_See code: [src/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/list.ts)_
|
|
201
262
|
|
|
202
263
|
## `knock layout pull [EMAILLAYOUTKEY]`
|
|
203
264
|
|
|
@@ -205,7 +266,7 @@ Pull one or more email layouts from an environment into a local file system.
|
|
|
205
266
|
|
|
206
267
|
```
|
|
207
268
|
USAGE
|
|
208
|
-
$ knock layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
|
|
269
|
+
$ knock layout pull [EMAILLAYOUTKEY] [--service-token <value>] [--environment <value>] [--layouts-dir <value>
|
|
209
270
|
--all] [--hide-uncommitted-changes] [--force]
|
|
210
271
|
|
|
211
272
|
FLAGS
|
|
@@ -214,10 +275,10 @@ FLAGS
|
|
|
214
275
|
--force Remove the confirmation prompt.
|
|
215
276
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
216
277
|
--layouts-dir=<value> The target directory path to pull all email layouts into.
|
|
217
|
-
--service-token=<value>
|
|
278
|
+
--service-token=<value> The service token to authenticate with.
|
|
218
279
|
```
|
|
219
280
|
|
|
220
|
-
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
281
|
+
_See code: [src/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/pull.ts)_
|
|
221
282
|
|
|
222
283
|
## `knock layout push [EMAILLAYOUTKEY]`
|
|
223
284
|
|
|
@@ -225,8 +286,8 @@ Push one or more email layouts from a local file system to Knock.
|
|
|
225
286
|
|
|
226
287
|
```
|
|
227
288
|
USAGE
|
|
228
|
-
$ knock layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir
|
|
229
|
-
--all] [-m <value> --commit]
|
|
289
|
+
$ knock layout push [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--layouts-dir
|
|
290
|
+
<value> --all] [-m <value> --commit]
|
|
230
291
|
|
|
231
292
|
FLAGS
|
|
232
293
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -236,10 +297,10 @@ FLAGS
|
|
|
236
297
|
environment
|
|
237
298
|
<options: development>
|
|
238
299
|
--layouts-dir=<value> The target directory path to find all layouts to push.
|
|
239
|
-
--service-token=<value>
|
|
300
|
+
--service-token=<value> The service token to authenticate with.
|
|
240
301
|
```
|
|
241
302
|
|
|
242
|
-
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
303
|
+
_See code: [src/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/push.ts)_
|
|
243
304
|
|
|
244
305
|
## `knock layout validate [EMAILLAYOUTKEY]`
|
|
245
306
|
|
|
@@ -247,18 +308,42 @@ Validate one or more layouts from a local file system.
|
|
|
247
308
|
|
|
248
309
|
```
|
|
249
310
|
USAGE
|
|
250
|
-
$ knock layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir
|
|
251
|
-
--all]
|
|
311
|
+
$ knock layout validate [EMAILLAYOUTKEY] [--service-token <value>] [--environment development] [--layouts-dir
|
|
312
|
+
<value> --all]
|
|
252
313
|
|
|
253
314
|
FLAGS
|
|
254
315
|
--all Whether to validate all layouts from the target directory.
|
|
255
316
|
--environment=<option> [default: development] Validating a layout is only done in the development environment
|
|
256
317
|
<options: development>
|
|
257
318
|
--layouts-dir=<value> The target directory path to find all layouts to validate.
|
|
258
|
-
--service-token=<value>
|
|
319
|
+
--service-token=<value> The service token to authenticate with.
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
_See code: [src/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/layout/validate.ts)_
|
|
323
|
+
|
|
324
|
+
## `knock login`
|
|
325
|
+
|
|
326
|
+
```
|
|
327
|
+
USAGE
|
|
328
|
+
$ knock login [--service-token <value>]
|
|
329
|
+
|
|
330
|
+
FLAGS
|
|
331
|
+
--service-token=<value> The service token to authenticate with.
|
|
259
332
|
```
|
|
260
333
|
|
|
261
|
-
_See code: [src/commands/
|
|
334
|
+
_See code: [src/commands/login.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/login.ts)_
|
|
335
|
+
|
|
336
|
+
## `knock logout`
|
|
337
|
+
|
|
338
|
+
```
|
|
339
|
+
USAGE
|
|
340
|
+
$ knock logout [--service-token <value>]
|
|
341
|
+
|
|
342
|
+
FLAGS
|
|
343
|
+
--service-token=<value> The service token to authenticate with.
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
_See code: [src/commands/logout.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/logout.ts)_
|
|
262
347
|
|
|
263
348
|
## `knock partial get PARTIALKEY`
|
|
264
349
|
|
|
@@ -266,19 +351,19 @@ Display a single partial from an environment.
|
|
|
266
351
|
|
|
267
352
|
```
|
|
268
353
|
USAGE
|
|
269
|
-
$ knock partial get PARTIALKEY --service-token <value>
|
|
354
|
+
$ knock partial get PARTIALKEY [--json] [--service-token <value>] [--environment <value>]
|
|
270
355
|
[--hide-uncommitted-changes]
|
|
271
356
|
|
|
272
357
|
FLAGS
|
|
273
358
|
--environment=<value> [default: development] The environment to use.
|
|
274
359
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
275
|
-
--service-token=<value>
|
|
360
|
+
--service-token=<value> The service token to authenticate with.
|
|
276
361
|
|
|
277
362
|
GLOBAL FLAGS
|
|
278
363
|
--json Format output as json.
|
|
279
364
|
```
|
|
280
365
|
|
|
281
|
-
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
366
|
+
_See code: [src/commands/partial/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/get.ts)_
|
|
282
367
|
|
|
283
368
|
## `knock partial list`
|
|
284
369
|
|
|
@@ -286,7 +371,7 @@ Display all partials for an environment.
|
|
|
286
371
|
|
|
287
372
|
```
|
|
288
373
|
USAGE
|
|
289
|
-
$ knock partial list --service-token <value>
|
|
374
|
+
$ knock partial list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
|
|
290
375
|
[--after <value>] [--before <value>] [--limit <value>]
|
|
291
376
|
|
|
292
377
|
FLAGS
|
|
@@ -295,13 +380,13 @@ FLAGS
|
|
|
295
380
|
--environment=<value> [default: development] The environment to use.
|
|
296
381
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
297
382
|
--limit=<value> The total number of entries to fetch per page.
|
|
298
|
-
--service-token=<value>
|
|
383
|
+
--service-token=<value> The service token to authenticate with.
|
|
299
384
|
|
|
300
385
|
GLOBAL FLAGS
|
|
301
386
|
--json Format output as json.
|
|
302
387
|
```
|
|
303
388
|
|
|
304
|
-
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
389
|
+
_See code: [src/commands/partial/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/list.ts)_
|
|
305
390
|
|
|
306
391
|
## `knock partial pull [PARTIALKEY]`
|
|
307
392
|
|
|
@@ -309,8 +394,8 @@ Pull one or more partial from an environment into a local file system.
|
|
|
309
394
|
|
|
310
395
|
```
|
|
311
396
|
USAGE
|
|
312
|
-
$ knock partial pull [PARTIALKEY] --service-token <value> [--environment <value>] [--partials-dir <value>
|
|
313
|
-
[--hide-uncommitted-changes] [--force]
|
|
397
|
+
$ knock partial pull [PARTIALKEY] [--service-token <value>] [--environment <value>] [--partials-dir <value>
|
|
398
|
+
--all] [--hide-uncommitted-changes] [--force]
|
|
314
399
|
|
|
315
400
|
FLAGS
|
|
316
401
|
--all Whether to pull all partials from the specified environment.
|
|
@@ -318,10 +403,10 @@ FLAGS
|
|
|
318
403
|
--force Remove the confirmation prompt.
|
|
319
404
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
320
405
|
--partials-dir=<value> The target directory path to pull all partials into.
|
|
321
|
-
--service-token=<value>
|
|
406
|
+
--service-token=<value> The service token to authenticate with.
|
|
322
407
|
```
|
|
323
408
|
|
|
324
|
-
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
409
|
+
_See code: [src/commands/partial/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/pull.ts)_
|
|
325
410
|
|
|
326
411
|
## `knock partial push [PARTIALKEY]`
|
|
327
412
|
|
|
@@ -329,7 +414,7 @@ Push one or more partials from a local file system to Knock.
|
|
|
329
414
|
|
|
330
415
|
```
|
|
331
416
|
USAGE
|
|
332
|
-
$ knock partial push [PARTIALKEY] --service-token <value> [--environment development] [--partials-dir <value>
|
|
417
|
+
$ knock partial push [PARTIALKEY] [--service-token <value>] [--environment development] [--partials-dir <value>
|
|
333
418
|
--all] [-m <value> --commit]
|
|
334
419
|
|
|
335
420
|
FLAGS
|
|
@@ -339,10 +424,10 @@ FLAGS
|
|
|
339
424
|
--environment=<option> [default: development] Pushing a partial is only allowed in the development environment
|
|
340
425
|
<options: development>
|
|
341
426
|
--partials-dir=<value> The target directory path to find all partials to push.
|
|
342
|
-
--service-token=<value>
|
|
427
|
+
--service-token=<value> The service token to authenticate with.
|
|
343
428
|
```
|
|
344
429
|
|
|
345
|
-
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
430
|
+
_See code: [src/commands/partial/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/push.ts)_
|
|
346
431
|
|
|
347
432
|
## `knock partial validate [PARTIALKEY]`
|
|
348
433
|
|
|
@@ -350,7 +435,7 @@ Validate one or more partials from a local file system.
|
|
|
350
435
|
|
|
351
436
|
```
|
|
352
437
|
USAGE
|
|
353
|
-
$ knock partial validate [PARTIALKEY] --service-token <value> [--environment development] [--partials-dir <value>
|
|
438
|
+
$ knock partial validate [PARTIALKEY] [--service-token <value>] [--environment development] [--partials-dir <value>
|
|
354
439
|
--all]
|
|
355
440
|
|
|
356
441
|
FLAGS
|
|
@@ -358,10 +443,10 @@ FLAGS
|
|
|
358
443
|
--environment=<option> [default: development] Validating a partial is only done in the development environment
|
|
359
444
|
<options: development>
|
|
360
445
|
--partials-dir=<value> The target directory path to find all partials to validate.
|
|
361
|
-
--service-token=<value>
|
|
446
|
+
--service-token=<value> The service token to authenticate with.
|
|
362
447
|
```
|
|
363
448
|
|
|
364
|
-
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
449
|
+
_See code: [src/commands/partial/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/partial/validate.ts)_
|
|
365
450
|
|
|
366
451
|
## `knock pull`
|
|
367
452
|
|
|
@@ -369,7 +454,7 @@ Pull all resources from an environment into a local file system.
|
|
|
369
454
|
|
|
370
455
|
```
|
|
371
456
|
USAGE
|
|
372
|
-
$ knock pull --
|
|
457
|
+
$ knock pull --knock-dir <value> [--service-token <value>] [--environment <value>]
|
|
373
458
|
[--hide-uncommitted-changes] [--force]
|
|
374
459
|
|
|
375
460
|
FLAGS
|
|
@@ -377,10 +462,10 @@ FLAGS
|
|
|
377
462
|
--force Remove the confirmation prompt.
|
|
378
463
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
379
464
|
--knock-dir=<value> (required) The target directory path to pull all resources into.
|
|
380
|
-
--service-token=<value>
|
|
465
|
+
--service-token=<value> The service token to authenticate with.
|
|
381
466
|
```
|
|
382
467
|
|
|
383
|
-
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
468
|
+
_See code: [src/commands/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/pull.ts)_
|
|
384
469
|
|
|
385
470
|
## `knock push`
|
|
386
471
|
|
|
@@ -388,7 +473,7 @@ Push all resources from a local file system to Knock.
|
|
|
388
473
|
|
|
389
474
|
```
|
|
390
475
|
USAGE
|
|
391
|
-
$ knock push --
|
|
476
|
+
$ knock push --knock-dir <value> [--service-token <value>] [--environment development] [-m <value>
|
|
392
477
|
--commit]
|
|
393
478
|
|
|
394
479
|
FLAGS
|
|
@@ -397,10 +482,10 @@ FLAGS
|
|
|
397
482
|
--environment=<option> [default: development] Pushing resources is only allowed in the development environment
|
|
398
483
|
<options: development>
|
|
399
484
|
--knock-dir=<value> (required) The target directory path to find all resources to push.
|
|
400
|
-
--service-token=<value>
|
|
485
|
+
--service-token=<value> The service token to authenticate with.
|
|
401
486
|
```
|
|
402
487
|
|
|
403
|
-
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
488
|
+
_See code: [src/commands/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/push.ts)_
|
|
404
489
|
|
|
405
490
|
## `knock translation get TRANSLATIONREF`
|
|
406
491
|
|
|
@@ -408,7 +493,7 @@ Display a single translation from an environment.
|
|
|
408
493
|
|
|
409
494
|
```
|
|
410
495
|
USAGE
|
|
411
|
-
$ knock translation get TRANSLATIONREF --service-token <value>
|
|
496
|
+
$ knock translation get TRANSLATIONREF [--json] [--service-token <value>] [--environment <value>]
|
|
412
497
|
[--hide-uncommitted-changes] [--format json|po]
|
|
413
498
|
|
|
414
499
|
ARGUMENTS
|
|
@@ -421,13 +506,13 @@ FLAGS
|
|
|
421
506
|
--format=<option> [default: json] Specify the output format of the returned translations.
|
|
422
507
|
<options: json|po>
|
|
423
508
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
424
|
-
--service-token=<value>
|
|
509
|
+
--service-token=<value> The service token to authenticate with.
|
|
425
510
|
|
|
426
511
|
GLOBAL FLAGS
|
|
427
512
|
--json Format output as json.
|
|
428
513
|
```
|
|
429
514
|
|
|
430
|
-
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
515
|
+
_See code: [src/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/get.ts)_
|
|
431
516
|
|
|
432
517
|
## `knock translation list`
|
|
433
518
|
|
|
@@ -435,7 +520,7 @@ Display all translations for an environment.
|
|
|
435
520
|
|
|
436
521
|
```
|
|
437
522
|
USAGE
|
|
438
|
-
$ knock translation list --service-token <value>
|
|
523
|
+
$ knock translation list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
|
|
439
524
|
[--after <value>] [--before <value>] [--limit <value>]
|
|
440
525
|
|
|
441
526
|
FLAGS
|
|
@@ -444,13 +529,13 @@ FLAGS
|
|
|
444
529
|
--environment=<value> [default: development] The environment to use.
|
|
445
530
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
446
531
|
--limit=<value> The total number of entries to fetch per page.
|
|
447
|
-
--service-token=<value>
|
|
532
|
+
--service-token=<value> The service token to authenticate with.
|
|
448
533
|
|
|
449
534
|
GLOBAL FLAGS
|
|
450
535
|
--json Format output as json.
|
|
451
536
|
```
|
|
452
537
|
|
|
453
|
-
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
538
|
+
_See code: [src/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/list.ts)_
|
|
454
539
|
|
|
455
540
|
## `knock translation pull [TRANSLATIONREF]`
|
|
456
541
|
|
|
@@ -458,7 +543,7 @@ Pull one or more translations from an environment into a local file system.
|
|
|
458
543
|
|
|
459
544
|
```
|
|
460
545
|
USAGE
|
|
461
|
-
$ knock translation pull [TRANSLATIONREF] --service-token <value> [--environment <value>] [--translations-dir
|
|
546
|
+
$ knock translation pull [TRANSLATIONREF] [--service-token <value>] [--environment <value>] [--translations-dir
|
|
462
547
|
<value> --all] [--hide-uncommitted-changes] [--force] [--format json|po]
|
|
463
548
|
|
|
464
549
|
ARGUMENTS
|
|
@@ -473,11 +558,11 @@ FLAGS
|
|
|
473
558
|
--format=<option> [default: json] Specify the output format of the returned translations.
|
|
474
559
|
<options: json|po>
|
|
475
560
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
476
|
-
--service-token=<value>
|
|
561
|
+
--service-token=<value> The service token to authenticate with.
|
|
477
562
|
--translations-dir=<value> The target directory path to pull all translations into.
|
|
478
563
|
```
|
|
479
564
|
|
|
480
|
-
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
565
|
+
_See code: [src/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/pull.ts)_
|
|
481
566
|
|
|
482
567
|
## `knock translation push [TRANSLATIONREF]`
|
|
483
568
|
|
|
@@ -485,7 +570,7 @@ Push one or more translations from a local file system to Knock.
|
|
|
485
570
|
|
|
486
571
|
```
|
|
487
572
|
USAGE
|
|
488
|
-
$ knock translation push [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
|
|
573
|
+
$ knock translation push [TRANSLATIONREF] [--service-token <value>] [--environment development] [--translations-dir
|
|
489
574
|
<value> --all] [-m <value> --commit]
|
|
490
575
|
|
|
491
576
|
ARGUMENTS
|
|
@@ -500,11 +585,11 @@ FLAGS
|
|
|
500
585
|
--environment=<option> [default: development] Pushing a translation is only allowed in the development
|
|
501
586
|
environment
|
|
502
587
|
<options: development>
|
|
503
|
-
--service-token=<value>
|
|
588
|
+
--service-token=<value> The service token to authenticate with.
|
|
504
589
|
--translations-dir=<value> The target directory path to find all translations to push.
|
|
505
590
|
```
|
|
506
591
|
|
|
507
|
-
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
592
|
+
_See code: [src/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/push.ts)_
|
|
508
593
|
|
|
509
594
|
## `knock translation validate [TRANSLATIONREF]`
|
|
510
595
|
|
|
@@ -512,7 +597,7 @@ Validate one or more translations from a local file system.
|
|
|
512
597
|
|
|
513
598
|
```
|
|
514
599
|
USAGE
|
|
515
|
-
$ knock translation validate [TRANSLATIONREF] --service-token <value> [--environment development] [--translations-dir
|
|
600
|
+
$ knock translation validate [TRANSLATIONREF] [--service-token <value>] [--environment development] [--translations-dir
|
|
516
601
|
<value> --all]
|
|
517
602
|
|
|
518
603
|
ARGUMENTS
|
|
@@ -525,11 +610,11 @@ FLAGS
|
|
|
525
610
|
--environment=<option> [default: development] Validating a translation is only done in the development
|
|
526
611
|
environment
|
|
527
612
|
<options: development>
|
|
528
|
-
--service-token=<value>
|
|
613
|
+
--service-token=<value> The service token to authenticate with.
|
|
529
614
|
--translations-dir=<value> The target directory path to find all translations to validate.
|
|
530
615
|
```
|
|
531
616
|
|
|
532
|
-
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
617
|
+
_See code: [src/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/translation/validate.ts)_
|
|
533
618
|
|
|
534
619
|
## `knock whoami`
|
|
535
620
|
|
|
@@ -537,16 +622,16 @@ Verify the provided service token.
|
|
|
537
622
|
|
|
538
623
|
```
|
|
539
624
|
USAGE
|
|
540
|
-
$ knock whoami --service-token <value>
|
|
625
|
+
$ knock whoami [--json] [--service-token <value>]
|
|
541
626
|
|
|
542
627
|
FLAGS
|
|
543
|
-
--service-token=<value>
|
|
628
|
+
--service-token=<value> The service token to authenticate with.
|
|
544
629
|
|
|
545
630
|
GLOBAL FLAGS
|
|
546
631
|
--json Format output as json.
|
|
547
632
|
```
|
|
548
633
|
|
|
549
|
-
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
634
|
+
_See code: [src/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/whoami.ts)_
|
|
550
635
|
|
|
551
636
|
## `knock workflow activate WORKFLOWKEY`
|
|
552
637
|
|
|
@@ -554,12 +639,12 @@ Activate or deactivate a workflow in a given environment.
|
|
|
554
639
|
|
|
555
640
|
```
|
|
556
641
|
USAGE
|
|
557
|
-
$ knock workflow activate WORKFLOWKEY --
|
|
642
|
+
$ knock workflow activate WORKFLOWKEY --environment <value> [--service-token <value>] [--status true|false] [--force]
|
|
558
643
|
|
|
559
644
|
FLAGS
|
|
560
645
|
--environment=<value> (required) The environment to use.
|
|
561
646
|
--force Remove the confirmation prompt.
|
|
562
|
-
--service-token=<value>
|
|
647
|
+
--service-token=<value> The service token to authenticate with.
|
|
563
648
|
--status=<option> [default: true] The workflow active status to set.
|
|
564
649
|
<options: true|false>
|
|
565
650
|
|
|
@@ -573,28 +658,28 @@ DESCRIPTION
|
|
|
573
658
|
with `false` in order to deactivate it.
|
|
574
659
|
```
|
|
575
660
|
|
|
576
|
-
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
661
|
+
_See code: [src/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/activate.ts)_
|
|
577
662
|
|
|
578
663
|
## `knock workflow generate-types`
|
|
579
664
|
|
|
580
|
-
Generate types for all workflows in
|
|
665
|
+
Generate types for all workflows in an environment and write them to a file.
|
|
581
666
|
|
|
582
667
|
```
|
|
583
668
|
USAGE
|
|
584
|
-
$ knock workflow generate-types --
|
|
669
|
+
$ knock workflow generate-types --output-file <value> [--service-token <value>] [--environment <value>]
|
|
585
670
|
|
|
586
671
|
FLAGS
|
|
587
672
|
--environment=<value> [default: development] Select the environment to generate types for.
|
|
588
673
|
--output-file=<value> (required) The output file to write the generated types to. We currently support .ts, .rb,
|
|
589
674
|
.go, .py files only. Your file extension will determine the target language for the generated
|
|
590
675
|
types.
|
|
591
|
-
--service-token=<value>
|
|
676
|
+
--service-token=<value> The service token to authenticate with.
|
|
592
677
|
|
|
593
678
|
DESCRIPTION
|
|
594
|
-
Generate types for all workflows in
|
|
679
|
+
Generate types for all workflows in an environment and write them to a file.
|
|
595
680
|
```
|
|
596
681
|
|
|
597
|
-
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
682
|
+
_See code: [src/commands/workflow/generate-types.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/generate-types.ts)_
|
|
598
683
|
|
|
599
684
|
## `knock workflow get WORKFLOWKEY`
|
|
600
685
|
|
|
@@ -602,19 +687,19 @@ Display a single workflow from an environment.
|
|
|
602
687
|
|
|
603
688
|
```
|
|
604
689
|
USAGE
|
|
605
|
-
$ knock workflow get WORKFLOWKEY --service-token <value>
|
|
690
|
+
$ knock workflow get WORKFLOWKEY [--json] [--service-token <value>] [--environment <value>]
|
|
606
691
|
[--hide-uncommitted-changes]
|
|
607
692
|
|
|
608
693
|
FLAGS
|
|
609
694
|
--environment=<value> [default: development] The environment to use.
|
|
610
695
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
611
|
-
--service-token=<value>
|
|
696
|
+
--service-token=<value> The service token to authenticate with.
|
|
612
697
|
|
|
613
698
|
GLOBAL FLAGS
|
|
614
699
|
--json Format output as json.
|
|
615
700
|
```
|
|
616
701
|
|
|
617
|
-
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
702
|
+
_See code: [src/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/get.ts)_
|
|
618
703
|
|
|
619
704
|
## `knock workflow list`
|
|
620
705
|
|
|
@@ -622,7 +707,7 @@ Display all workflows for an environment.
|
|
|
622
707
|
|
|
623
708
|
```
|
|
624
709
|
USAGE
|
|
625
|
-
$ knock workflow list --service-token <value>
|
|
710
|
+
$ knock workflow list [--json] [--service-token <value>] [--environment <value>] [--hide-uncommitted-changes]
|
|
626
711
|
[--after <value>] [--before <value>] [--limit <value>]
|
|
627
712
|
|
|
628
713
|
FLAGS
|
|
@@ -631,13 +716,13 @@ FLAGS
|
|
|
631
716
|
--environment=<value> [default: development] The environment to use.
|
|
632
717
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
633
718
|
--limit=<value> The total number of entries to fetch per page.
|
|
634
|
-
--service-token=<value>
|
|
719
|
+
--service-token=<value> The service token to authenticate with.
|
|
635
720
|
|
|
636
721
|
GLOBAL FLAGS
|
|
637
722
|
--json Format output as json.
|
|
638
723
|
```
|
|
639
724
|
|
|
640
|
-
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
725
|
+
_See code: [src/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/list.ts)_
|
|
641
726
|
|
|
642
727
|
## `knock workflow pull [WORKFLOWKEY]`
|
|
643
728
|
|
|
@@ -645,7 +730,7 @@ Pull one or more workflows from an environment into a local file system.
|
|
|
645
730
|
|
|
646
731
|
```
|
|
647
732
|
USAGE
|
|
648
|
-
$ knock workflow pull [WORKFLOWKEY] --service-token <value> [--environment <value>] [--workflows-dir <value>
|
|
733
|
+
$ knock workflow pull [WORKFLOWKEY] [--service-token <value>] [--environment <value>] [--workflows-dir <value>
|
|
649
734
|
--all] [--hide-uncommitted-changes] [--force]
|
|
650
735
|
|
|
651
736
|
FLAGS
|
|
@@ -653,11 +738,11 @@ FLAGS
|
|
|
653
738
|
--environment=<value> [default: development] The environment to use.
|
|
654
739
|
--force Remove the confirmation prompt.
|
|
655
740
|
--hide-uncommitted-changes Hide any uncommitted changes.
|
|
656
|
-
--service-token=<value>
|
|
741
|
+
--service-token=<value> The service token to authenticate with.
|
|
657
742
|
--workflows-dir=<value> The target directory path to pull all workflows into.
|
|
658
743
|
```
|
|
659
744
|
|
|
660
|
-
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
745
|
+
_See code: [src/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/pull.ts)_
|
|
661
746
|
|
|
662
747
|
## `knock workflow push [WORKFLOWKEY]`
|
|
663
748
|
|
|
@@ -665,8 +750,8 @@ Push one or more workflows from a local file system to Knock.
|
|
|
665
750
|
|
|
666
751
|
```
|
|
667
752
|
USAGE
|
|
668
|
-
$ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir
|
|
669
|
-
--all] [-m <value> --commit]
|
|
753
|
+
$ knock workflow push [WORKFLOWKEY] [--service-token <value>] [--environment development] [--workflows-dir
|
|
754
|
+
<value> --all] [-m <value> --commit]
|
|
670
755
|
|
|
671
756
|
FLAGS
|
|
672
757
|
-m, --commit-message=<value> Use the given value as the commit message
|
|
@@ -674,11 +759,11 @@ FLAGS
|
|
|
674
759
|
--commit Push and commit the workflow(s) at the same time
|
|
675
760
|
--environment=<option> [default: development] Pushing a workflow is only allowed in the development environment
|
|
676
761
|
<options: development>
|
|
677
|
-
--service-token=<value>
|
|
762
|
+
--service-token=<value> The service token to authenticate with.
|
|
678
763
|
--workflows-dir=<value> The target directory path to find all workflows to push.
|
|
679
764
|
```
|
|
680
765
|
|
|
681
|
-
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
766
|
+
_See code: [src/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/push.ts)_
|
|
682
767
|
|
|
683
768
|
## `knock workflow run WORKFLOWKEY`
|
|
684
769
|
|
|
@@ -686,7 +771,7 @@ Test run a workflow using the latest version from Knock.
|
|
|
686
771
|
|
|
687
772
|
```
|
|
688
773
|
USAGE
|
|
689
|
-
$ knock workflow run WORKFLOWKEY --
|
|
774
|
+
$ knock workflow run WORKFLOWKEY --recipients <value> [--service-token <value>] [--environment <value>] [--actor
|
|
690
775
|
<value>] [--tenant <value>] [--data <value>]
|
|
691
776
|
|
|
692
777
|
FLAGS
|
|
@@ -695,11 +780,11 @@ FLAGS
|
|
|
695
780
|
--environment=<value> [default: development] The environment in which to run the workflow
|
|
696
781
|
--recipients=<value> (required) One or more recipient user ids separated by comma, or a JSON string containing one
|
|
697
782
|
or more recipient object references for this workflow run.
|
|
698
|
-
--service-token=<value>
|
|
783
|
+
--service-token=<value> The service token to authenticate with.
|
|
699
784
|
--tenant=<value> A tenant id for the workflow run.
|
|
700
785
|
```
|
|
701
786
|
|
|
702
|
-
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
787
|
+
_See code: [src/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/run.ts)_
|
|
703
788
|
|
|
704
789
|
## `knock workflow validate [WORKFLOWKEY]`
|
|
705
790
|
|
|
@@ -707,16 +792,16 @@ Validate one or more workflows from a local file system.
|
|
|
707
792
|
|
|
708
793
|
```
|
|
709
794
|
USAGE
|
|
710
|
-
$ knock workflow validate [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir
|
|
711
|
-
--all]
|
|
795
|
+
$ knock workflow validate [WORKFLOWKEY] [--service-token <value>] [--environment development] [--workflows-dir
|
|
796
|
+
<value> --all]
|
|
712
797
|
|
|
713
798
|
FLAGS
|
|
714
799
|
--all Whether to validate all workflows from the target directory.
|
|
715
800
|
--environment=<option> [default: development] Validating a workflow is only done in the development environment
|
|
716
801
|
<options: development>
|
|
717
|
-
--service-token=<value>
|
|
802
|
+
--service-token=<value> The service token to authenticate with.
|
|
718
803
|
--workflows-dir=<value> The target directory path to find all workflows to validate.
|
|
719
804
|
```
|
|
720
805
|
|
|
721
|
-
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.
|
|
806
|
+
_See code: [src/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.2.0/src/commands/workflow/validate.ts)_
|
|
722
807
|
<!-- commandsstop -->
|