@swimlane/turbine-sdk 0.1.1-next.23
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 +790 -0
- package/bin/dev +17 -0
- package/bin/dev.cmd +3 -0
- package/bin/run +5 -0
- package/bin/run.cmd +3 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +6 -0
- package/lib/index.js.map +1 -0
- package/oclif.manifest.json +1 -0
- package/package.json +113 -0
package/README.md
ADDED
|
@@ -0,0 +1,790 @@
|
|
|
1
|
+
Swimlane Integrations CLI (SDK)
|
|
2
|
+
============
|
|
3
|
+
|
|
4
|
+
[](https://npmjs.org/package/@swimlane/swimlane-sdk)
|
|
5
|
+
[](https://npmjs.org/package/@swimlane/swimlane-sdk)
|
|
6
|
+
[](https://github.com/swimlane/turbine-developer-kit/blob/main/packages/cli/package.json)
|
|
7
|
+
|
|
8
|
+
<!-- toc -->
|
|
9
|
+
* [Requirements](#requirements)
|
|
10
|
+
* [Installation](#installation)
|
|
11
|
+
* [Usage](#usage)
|
|
12
|
+
* [Commands](#commands)
|
|
13
|
+
* [Roles and Works](#roles-and-works)
|
|
14
|
+
* [Release Flow](#release-flow)
|
|
15
|
+
<!-- tocstop -->
|
|
16
|
+
|
|
17
|
+
# Requirements
|
|
18
|
+
|
|
19
|
+
* Docker Desktop
|
|
20
|
+
* nvm - (https://github.com/nvm-sh/nvm#installing-and-updating)
|
|
21
|
+
* Node >= 16.0.0
|
|
22
|
+
* Python >= 3.7
|
|
23
|
+
|
|
24
|
+
# Installation
|
|
25
|
+
|
|
26
|
+
```shell
|
|
27
|
+
npm install -g @swimlane/swimlane-sdk@latest
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
# Usage
|
|
31
|
+
<!-- usage -->
|
|
32
|
+
```sh-session
|
|
33
|
+
$ npm install -g @swimlane/turbine-sdk
|
|
34
|
+
$ tsdk COMMAND
|
|
35
|
+
running command...
|
|
36
|
+
$ tsdk (--version|-v)
|
|
37
|
+
@swimlane/turbine-sdk/0.1.1-next.23+038e7a6 darwin-x64 node-v16.17.0
|
|
38
|
+
$ tsdk --help [COMMAND]
|
|
39
|
+
USAGE
|
|
40
|
+
$ tsdk COMMAND
|
|
41
|
+
...
|
|
42
|
+
```
|
|
43
|
+
<!-- usagestop -->
|
|
44
|
+
# Commands
|
|
45
|
+
<!-- commands -->
|
|
46
|
+
* [`tsdk action add`](#tsdk-action-add)
|
|
47
|
+
* [`tsdk action input`](#tsdk-action-input)
|
|
48
|
+
* [`tsdk action output`](#tsdk-action-output)
|
|
49
|
+
* [`tsdk action run`](#tsdk-action-run)
|
|
50
|
+
* [`tsdk asset add`](#tsdk-asset-add)
|
|
51
|
+
* [`tsdk autocomplete [SHELL]`](#tsdk-autocomplete-shell)
|
|
52
|
+
* [`tsdk commands`](#tsdk-commands)
|
|
53
|
+
* [`tsdk connector build`](#tsdk-connector-build)
|
|
54
|
+
* [`tsdk connector create`](#tsdk-connector-create)
|
|
55
|
+
* [`tsdk connector create-source`](#tsdk-connector-create-source)
|
|
56
|
+
* [`tsdk connector logo`](#tsdk-connector-logo)
|
|
57
|
+
* [`tsdk connector save`](#tsdk-connector-save)
|
|
58
|
+
* [`tsdk connector sign`](#tsdk-connector-sign)
|
|
59
|
+
* [`tsdk connector update`](#tsdk-connector-update)
|
|
60
|
+
* [`tsdk connector validate`](#tsdk-connector-validate)
|
|
61
|
+
* [`tsdk help [COMMAND]`](#tsdk-help-command)
|
|
62
|
+
* [`tsdk plugins`](#tsdk-plugins)
|
|
63
|
+
* [`tsdk plugins:install PLUGIN...`](#tsdk-pluginsinstall-plugin)
|
|
64
|
+
* [`tsdk plugins:inspect PLUGIN...`](#tsdk-pluginsinspect-plugin)
|
|
65
|
+
* [`tsdk plugins:install PLUGIN...`](#tsdk-pluginsinstall-plugin-1)
|
|
66
|
+
* [`tsdk plugins:link PLUGIN`](#tsdk-pluginslink-plugin)
|
|
67
|
+
* [`tsdk plugins:uninstall PLUGIN...`](#tsdk-pluginsuninstall-plugin)
|
|
68
|
+
* [`tsdk plugins:uninstall PLUGIN...`](#tsdk-pluginsuninstall-plugin-1)
|
|
69
|
+
* [`tsdk plugins:uninstall PLUGIN...`](#tsdk-pluginsuninstall-plugin-2)
|
|
70
|
+
* [`tsdk plugins update`](#tsdk-plugins-update)
|
|
71
|
+
* [`tsdk turbine connector keys generate`](#tsdk-turbine-connector-keys-generate)
|
|
72
|
+
* [`tsdk turbine connector keys list`](#tsdk-turbine-connector-keys-list)
|
|
73
|
+
* [`tsdk turbine connector push`](#tsdk-turbine-connector-push)
|
|
74
|
+
* [`tsdk turbine login`](#tsdk-turbine-login)
|
|
75
|
+
* [`tsdk version`](#tsdk-version)
|
|
76
|
+
* [`tsdk which`](#tsdk-which)
|
|
77
|
+
|
|
78
|
+
## `tsdk action add`
|
|
79
|
+
|
|
80
|
+
Update a connector action.
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
USAGE
|
|
84
|
+
$ tsdk action add [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [-h]
|
|
85
|
+
|
|
86
|
+
FLAGS
|
|
87
|
+
-d, --directory=<value> [default: ./] Root directory of the repository.
|
|
88
|
+
-h, --help Show CLI help.
|
|
89
|
+
-t, --template=<option> [default: python_310_definition] action template to scaffold
|
|
90
|
+
<options: node_18|python_310_definition|python_3.7_swimlane>
|
|
91
|
+
|
|
92
|
+
DESCRIPTION
|
|
93
|
+
Update a connector action.
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## `tsdk action input`
|
|
97
|
+
|
|
98
|
+
Update action input schema.
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
USAGE
|
|
102
|
+
$ tsdk action input [-a <value>] [-d <value>] [--amend] [--action-config-path <value>] [--input-path <value> ]
|
|
103
|
+
[-h]
|
|
104
|
+
|
|
105
|
+
FLAGS
|
|
106
|
+
-a, --action=<value> Action name to run
|
|
107
|
+
-d, --directory=<value> [default: ./] Root directory of the repository.
|
|
108
|
+
-h, --help Show CLI help.
|
|
109
|
+
--action-config-path=<value> Override path to action configuration file. Defaults to
|
|
110
|
+
/connector/config/actions/<action>.yaml
|
|
111
|
+
--amend Merge with existing schema.
|
|
112
|
+
--input-path=<value> Relative path to the output data JSON file, defaults to the task name under the data
|
|
113
|
+
folder. ie: /data/<taskName>_output.json
|
|
114
|
+
|
|
115
|
+
DESCRIPTION
|
|
116
|
+
Update action input schema.
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## `tsdk action output`
|
|
120
|
+
|
|
121
|
+
Update a connector action.
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
USAGE
|
|
125
|
+
$ tsdk action output [-a <value>] [-d <value>] [--action-config-path <value>] [--amend] [--output-path <value> ]
|
|
126
|
+
[-h]
|
|
127
|
+
|
|
128
|
+
FLAGS
|
|
129
|
+
-a, --action=<value> Action name to run
|
|
130
|
+
-d, --directory=<value> [default: ./] Root directory of the repository.
|
|
131
|
+
-h, --help Show CLI help.
|
|
132
|
+
--action-config-path=<value> Override path to action configuration file. Defaults to /connector/config/<action>.yaml
|
|
133
|
+
--amend Merge with existing schema.
|
|
134
|
+
--output-path=<value> Relative path to the output data JSON file, defaults to the task name under the data
|
|
135
|
+
folder. ie: /data/<taskName>_output.json
|
|
136
|
+
|
|
137
|
+
DESCRIPTION
|
|
138
|
+
Update a connector action.
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## `tsdk action run`
|
|
142
|
+
|
|
143
|
+
Runs a connector action. (Defaults to current image version in local repository).
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
USAGE
|
|
147
|
+
$ tsdk action run [-a <value>] [-d <value>] [--input-path <value>] [--output-path <value>] [--error-path
|
|
148
|
+
<value>] [--asset-path <value>] [-i <value> | --build | --latest] [--template
|
|
149
|
+
python_3.7|node_18|python_310_definition] [-f ] [-h]
|
|
150
|
+
|
|
151
|
+
FLAGS
|
|
152
|
+
-a, --action=<value> Action name to run
|
|
153
|
+
-d, --directory=<value> [default: ./] Root directory of the repository.
|
|
154
|
+
-f, --force-rebuild forces nocache on the image build
|
|
155
|
+
-h, --help Show CLI help.
|
|
156
|
+
-i, --image=<value> The connector image to run.
|
|
157
|
+
--asset-path=<value> File to asset data JSON file, defaults to /data/asset.json
|
|
158
|
+
--build Builds image and runs it.
|
|
159
|
+
--error-path=<value> File to write the errors to, defaults to /data/<action>_error.json
|
|
160
|
+
--input-path=<value> File to input data JSON file, defaults to /data/<action>.json
|
|
161
|
+
--latest Use the latest release image from quay.
|
|
162
|
+
--output-path=<value> File to write the outputs to, defaults to /data/<action>_output.json
|
|
163
|
+
--template=<option> [default: python_310_definition] connector template
|
|
164
|
+
<options: python_3.7|node_18|python_310_definition>
|
|
165
|
+
|
|
166
|
+
DESCRIPTION
|
|
167
|
+
Runs a connector action. (Defaults to current image version in local repository).
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## `tsdk asset add`
|
|
171
|
+
|
|
172
|
+
Update a connector action.
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
USAGE
|
|
176
|
+
$ tsdk asset add [-d <value>] [-s custom|apikey|client_credentials|basic|bearer] [-h]
|
|
177
|
+
|
|
178
|
+
FLAGS
|
|
179
|
+
-d, --directory=<value> [default: ./] Root directory of the repository.
|
|
180
|
+
-h, --help Show CLI help.
|
|
181
|
+
-s, --scheme=<option> asset template to scaffold
|
|
182
|
+
<options: custom|apikey|client_credentials|basic|bearer>
|
|
183
|
+
|
|
184
|
+
DESCRIPTION
|
|
185
|
+
Update a connector action.
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## `tsdk autocomplete [SHELL]`
|
|
189
|
+
|
|
190
|
+
display autocomplete installation instructions
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
USAGE
|
|
194
|
+
$ tsdk autocomplete [SHELL] [-r]
|
|
195
|
+
|
|
196
|
+
ARGUMENTS
|
|
197
|
+
SHELL shell type
|
|
198
|
+
|
|
199
|
+
FLAGS
|
|
200
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
201
|
+
|
|
202
|
+
DESCRIPTION
|
|
203
|
+
display autocomplete installation instructions
|
|
204
|
+
|
|
205
|
+
EXAMPLES
|
|
206
|
+
$ tsdk autocomplete
|
|
207
|
+
|
|
208
|
+
$ tsdk autocomplete bash
|
|
209
|
+
|
|
210
|
+
$ tsdk autocomplete zsh
|
|
211
|
+
|
|
212
|
+
$ tsdk autocomplete --refresh-cache
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.2.0/src/commands/autocomplete/index.ts)_
|
|
216
|
+
|
|
217
|
+
## `tsdk commands`
|
|
218
|
+
|
|
219
|
+
list all the commands
|
|
220
|
+
|
|
221
|
+
```
|
|
222
|
+
USAGE
|
|
223
|
+
$ tsdk commands [--json] [-h] [--hidden] [--columns <value> | -x] [--sort <value>] [--filter <value>]
|
|
224
|
+
[--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
|
|
225
|
+
|
|
226
|
+
FLAGS
|
|
227
|
+
-h, --help Show CLI help.
|
|
228
|
+
-x, --extended show extra columns
|
|
229
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
230
|
+
--csv output is csv format [alias: --output=csv]
|
|
231
|
+
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
232
|
+
--hidden show hidden commands
|
|
233
|
+
--no-header hide table header from output
|
|
234
|
+
--no-truncate do not truncate output to fit screen
|
|
235
|
+
--output=<option> output in a more machine friendly format
|
|
236
|
+
<options: csv|json|yaml>
|
|
237
|
+
--sort=<value> property to sort by (prepend '-' for descending)
|
|
238
|
+
|
|
239
|
+
GLOBAL FLAGS
|
|
240
|
+
--json Format output as json.
|
|
241
|
+
|
|
242
|
+
DESCRIPTION
|
|
243
|
+
list all the commands
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.1.0/src/commands/commands.ts)_
|
|
247
|
+
|
|
248
|
+
## `tsdk connector build`
|
|
249
|
+
|
|
250
|
+
Builds a local docker image of the connector.
|
|
251
|
+
|
|
252
|
+
```
|
|
253
|
+
USAGE
|
|
254
|
+
$ tsdk connector build --template python_3.7_swimlane|node_18|python_310_definition [-d <value>] [--save] [-f] [-h]
|
|
255
|
+
|
|
256
|
+
FLAGS
|
|
257
|
+
-d, --directory=<value> [default: ./] root directory of the repository.
|
|
258
|
+
-f, --force-rebuild forces nocache on the image build
|
|
259
|
+
-h, --help Show CLI help.
|
|
260
|
+
--save saves docker image as tar in local directory.
|
|
261
|
+
--template=<option> (required) [default: python_310_definition] connector language
|
|
262
|
+
<options: python_3.7_swimlane|node_18|python_310_definition>
|
|
263
|
+
|
|
264
|
+
DESCRIPTION
|
|
265
|
+
Builds a local docker image of the connector.
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
## `tsdk connector create`
|
|
269
|
+
|
|
270
|
+
Scaffold a new connector
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
USAGE
|
|
274
|
+
$ tsdk connector create [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [--skip-repo] [--vendor
|
|
275
|
+
<value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author <value>]
|
|
276
|
+
[--authorEmail <value>] [--homepage <value>] [-h]
|
|
277
|
+
|
|
278
|
+
FLAGS
|
|
279
|
+
-d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
|
|
280
|
+
generated.
|
|
281
|
+
-h, --help Show CLI help.
|
|
282
|
+
-t, --template=<option> [default: python_310_definition] connector template to scaffold
|
|
283
|
+
<options: node_18|python_310_definition|python_3.7_swimlane>
|
|
284
|
+
--author=<value> Connector Author
|
|
285
|
+
--authorEmail=<value> Connector Author Email
|
|
286
|
+
--description=<value> Description (e.g. CrowdStrike Host Query API)
|
|
287
|
+
--homepage=<value> Connector Author Support URL
|
|
288
|
+
--keywords=<value> Please enter keyword (Comma-Separated)
|
|
289
|
+
--logoPath=<value> URL or absolute path to logo file
|
|
290
|
+
--product=<value> Product (e.g. Falcon)
|
|
291
|
+
--skip-repo skips the repository creation process
|
|
292
|
+
--vendor=<value> Vendor (e.g. CrowdStrike)
|
|
293
|
+
|
|
294
|
+
DESCRIPTION
|
|
295
|
+
Scaffold a new connector
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
## `tsdk connector create-source`
|
|
299
|
+
|
|
300
|
+
Generates 11x source from 10x
|
|
301
|
+
|
|
302
|
+
```
|
|
303
|
+
USAGE
|
|
304
|
+
$ tsdk connector create-source [-d <value>] [-h]
|
|
305
|
+
|
|
306
|
+
FLAGS
|
|
307
|
+
-d, --directory=<value> [default: ./] root directory of the repository.
|
|
308
|
+
-h, --help Show CLI help.
|
|
309
|
+
|
|
310
|
+
DESCRIPTION
|
|
311
|
+
Generates 11x source from 10x
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
## `tsdk connector logo`
|
|
315
|
+
|
|
316
|
+
Update a connector.
|
|
317
|
+
|
|
318
|
+
```
|
|
319
|
+
USAGE
|
|
320
|
+
$ tsdk connector logo -p <value> [-d <value>] [-h]
|
|
321
|
+
|
|
322
|
+
FLAGS
|
|
323
|
+
-d, --directory=<value> [default: .] root directory of the connector folder.
|
|
324
|
+
-h, --help Show CLI help.
|
|
325
|
+
-p, --path=<value> (required) path or URL to product logo in PNG format.
|
|
326
|
+
|
|
327
|
+
DESCRIPTION
|
|
328
|
+
Update a connector.
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
## `tsdk connector save`
|
|
332
|
+
|
|
333
|
+
Save a docker image locally as .tar.gz
|
|
334
|
+
|
|
335
|
+
```
|
|
336
|
+
USAGE
|
|
337
|
+
$ tsdk connector save -o <value> -i <value> [-d <value>] [-s] [-h]
|
|
338
|
+
|
|
339
|
+
FLAGS
|
|
340
|
+
-d, --directory=<value> [default: .] Root directory of the repo.
|
|
341
|
+
-h, --help Show CLI help.
|
|
342
|
+
-i, --image=<value> (required) image to save.
|
|
343
|
+
-o, --output=<value> (required) output file to where to store the image.
|
|
344
|
+
-s, --skip-pull skips pulling the image
|
|
345
|
+
|
|
346
|
+
DESCRIPTION
|
|
347
|
+
Save a docker image locally as .tar.gz
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
## `tsdk connector sign`
|
|
351
|
+
|
|
352
|
+
Builds a local docker image of the connector.
|
|
353
|
+
|
|
354
|
+
```
|
|
355
|
+
USAGE
|
|
356
|
+
$ tsdk connector sign --image <value> --key-name <value> [-d <value>] [--signing-password <value>] [--save]
|
|
357
|
+
[--registry <value>] [-h]
|
|
358
|
+
|
|
359
|
+
FLAGS
|
|
360
|
+
-d, --directory=<value> [default: ./] root directory of the repository.
|
|
361
|
+
-h, --help Show CLI help.
|
|
362
|
+
--image=<value> (required) image name to sign
|
|
363
|
+
--key-name=<value> (required) name used for the key (default: username)
|
|
364
|
+
--registry=<value> [default: localhost:50000] registry to use for signing
|
|
365
|
+
--save saves docker image as tar in local directory.
|
|
366
|
+
--signing-password=<value> password used for the private key
|
|
367
|
+
|
|
368
|
+
DESCRIPTION
|
|
369
|
+
Builds a local docker image of the connector.
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
## `tsdk connector update`
|
|
373
|
+
|
|
374
|
+
Update a connector.
|
|
375
|
+
|
|
376
|
+
```
|
|
377
|
+
USAGE
|
|
378
|
+
$ tsdk connector update [-d <value>] [-v <value>] [-f <value>] [-h]
|
|
379
|
+
|
|
380
|
+
FLAGS
|
|
381
|
+
-d, --directory=<value> [default: .] root directory of the connector folder.
|
|
382
|
+
-f, --manifest-path=<value> [default: /connector/connector.yaml] connector manifest path relative to directory.
|
|
383
|
+
-h, --help Show CLI help.
|
|
384
|
+
-v, --version=<value> new version of the connector.
|
|
385
|
+
|
|
386
|
+
DESCRIPTION
|
|
387
|
+
Update a connector.
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
## `tsdk connector validate`
|
|
391
|
+
|
|
392
|
+
Use to validate an integration
|
|
393
|
+
|
|
394
|
+
```
|
|
395
|
+
USAGE
|
|
396
|
+
$ tsdk connector validate -c <value> [-h] [-i <value>] [--key <value> --signed] [-s] [-d <value>]
|
|
397
|
+
|
|
398
|
+
FLAGS
|
|
399
|
+
-c, --connector=<value> (required) connector to validate (relative to directory)
|
|
400
|
+
-d, --directory=<value> [default: ./] current directory to mount
|
|
401
|
+
-h, --help Show CLI help.
|
|
402
|
+
-i, --image=<value> image to use
|
|
403
|
+
-s, --skip-pull skips pulling the image
|
|
404
|
+
--key=<value> public key for verfication
|
|
405
|
+
--signed validates a signed connector
|
|
406
|
+
|
|
407
|
+
DESCRIPTION
|
|
408
|
+
Use to validate an integration
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
## `tsdk help [COMMAND]`
|
|
412
|
+
|
|
413
|
+
Display help for tsdk.
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
USAGE
|
|
417
|
+
$ tsdk help [COMMAND] [-n]
|
|
418
|
+
|
|
419
|
+
ARGUMENTS
|
|
420
|
+
COMMAND Command to show help for.
|
|
421
|
+
|
|
422
|
+
FLAGS
|
|
423
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
424
|
+
|
|
425
|
+
DESCRIPTION
|
|
426
|
+
Display help for tsdk.
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
|
|
430
|
+
|
|
431
|
+
## `tsdk plugins`
|
|
432
|
+
|
|
433
|
+
List installed plugins.
|
|
434
|
+
|
|
435
|
+
```
|
|
436
|
+
USAGE
|
|
437
|
+
$ tsdk plugins [--core]
|
|
438
|
+
|
|
439
|
+
FLAGS
|
|
440
|
+
--core Show core plugins.
|
|
441
|
+
|
|
442
|
+
DESCRIPTION
|
|
443
|
+
List installed plugins.
|
|
444
|
+
|
|
445
|
+
EXAMPLES
|
|
446
|
+
$ tsdk plugins
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
|
|
450
|
+
|
|
451
|
+
## `tsdk plugins:install PLUGIN...`
|
|
452
|
+
|
|
453
|
+
Installs a plugin into the CLI.
|
|
454
|
+
|
|
455
|
+
```
|
|
456
|
+
USAGE
|
|
457
|
+
$ tsdk plugins:install PLUGIN...
|
|
458
|
+
|
|
459
|
+
ARGUMENTS
|
|
460
|
+
PLUGIN Plugin to install.
|
|
461
|
+
|
|
462
|
+
FLAGS
|
|
463
|
+
-f, --force Run yarn install with force flag.
|
|
464
|
+
-h, --help Show CLI help.
|
|
465
|
+
-v, --verbose
|
|
466
|
+
|
|
467
|
+
DESCRIPTION
|
|
468
|
+
Installs a plugin into the CLI.
|
|
469
|
+
|
|
470
|
+
Can be installed from npm or a git url.
|
|
471
|
+
|
|
472
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
473
|
+
|
|
474
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
475
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
476
|
+
the CLI without the need to patch and update the whole CLI.
|
|
477
|
+
|
|
478
|
+
ALIASES
|
|
479
|
+
$ tsdk plugins add
|
|
480
|
+
|
|
481
|
+
EXAMPLES
|
|
482
|
+
$ tsdk plugins:install myplugin
|
|
483
|
+
|
|
484
|
+
$ tsdk plugins:install https://github.com/someuser/someplugin
|
|
485
|
+
|
|
486
|
+
$ tsdk plugins:install someuser/someplugin
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
## `tsdk plugins:inspect PLUGIN...`
|
|
490
|
+
|
|
491
|
+
Displays installation properties of a plugin.
|
|
492
|
+
|
|
493
|
+
```
|
|
494
|
+
USAGE
|
|
495
|
+
$ tsdk plugins:inspect PLUGIN...
|
|
496
|
+
|
|
497
|
+
ARGUMENTS
|
|
498
|
+
PLUGIN [default: .] Plugin to inspect.
|
|
499
|
+
|
|
500
|
+
FLAGS
|
|
501
|
+
-h, --help Show CLI help.
|
|
502
|
+
-v, --verbose
|
|
503
|
+
|
|
504
|
+
DESCRIPTION
|
|
505
|
+
Displays installation properties of a plugin.
|
|
506
|
+
|
|
507
|
+
EXAMPLES
|
|
508
|
+
$ tsdk plugins:inspect myplugin
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
## `tsdk plugins:install PLUGIN...`
|
|
512
|
+
|
|
513
|
+
Installs a plugin into the CLI.
|
|
514
|
+
|
|
515
|
+
```
|
|
516
|
+
USAGE
|
|
517
|
+
$ tsdk plugins:install PLUGIN...
|
|
518
|
+
|
|
519
|
+
ARGUMENTS
|
|
520
|
+
PLUGIN Plugin to install.
|
|
521
|
+
|
|
522
|
+
FLAGS
|
|
523
|
+
-f, --force Run yarn install with force flag.
|
|
524
|
+
-h, --help Show CLI help.
|
|
525
|
+
-v, --verbose
|
|
526
|
+
|
|
527
|
+
DESCRIPTION
|
|
528
|
+
Installs a plugin into the CLI.
|
|
529
|
+
|
|
530
|
+
Can be installed from npm or a git url.
|
|
531
|
+
|
|
532
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
533
|
+
|
|
534
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
535
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
536
|
+
the CLI without the need to patch and update the whole CLI.
|
|
537
|
+
|
|
538
|
+
ALIASES
|
|
539
|
+
$ tsdk plugins add
|
|
540
|
+
|
|
541
|
+
EXAMPLES
|
|
542
|
+
$ tsdk plugins:install myplugin
|
|
543
|
+
|
|
544
|
+
$ tsdk plugins:install https://github.com/someuser/someplugin
|
|
545
|
+
|
|
546
|
+
$ tsdk plugins:install someuser/someplugin
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
## `tsdk plugins:link PLUGIN`
|
|
550
|
+
|
|
551
|
+
Links a plugin into the CLI for development.
|
|
552
|
+
|
|
553
|
+
```
|
|
554
|
+
USAGE
|
|
555
|
+
$ tsdk plugins:link PLUGIN
|
|
556
|
+
|
|
557
|
+
ARGUMENTS
|
|
558
|
+
PATH [default: .] path to plugin
|
|
559
|
+
|
|
560
|
+
FLAGS
|
|
561
|
+
-h, --help Show CLI help.
|
|
562
|
+
-v, --verbose
|
|
563
|
+
|
|
564
|
+
DESCRIPTION
|
|
565
|
+
Links a plugin into the CLI for development.
|
|
566
|
+
|
|
567
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
568
|
+
|
|
569
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
570
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
571
|
+
|
|
572
|
+
EXAMPLES
|
|
573
|
+
$ tsdk plugins:link myplugin
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
## `tsdk plugins:uninstall PLUGIN...`
|
|
577
|
+
|
|
578
|
+
Removes a plugin from the CLI.
|
|
579
|
+
|
|
580
|
+
```
|
|
581
|
+
USAGE
|
|
582
|
+
$ tsdk plugins:uninstall PLUGIN...
|
|
583
|
+
|
|
584
|
+
ARGUMENTS
|
|
585
|
+
PLUGIN plugin to uninstall
|
|
586
|
+
|
|
587
|
+
FLAGS
|
|
588
|
+
-h, --help Show CLI help.
|
|
589
|
+
-v, --verbose
|
|
590
|
+
|
|
591
|
+
DESCRIPTION
|
|
592
|
+
Removes a plugin from the CLI.
|
|
593
|
+
|
|
594
|
+
ALIASES
|
|
595
|
+
$ tsdk plugins unlink
|
|
596
|
+
$ tsdk plugins remove
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
## `tsdk plugins:uninstall PLUGIN...`
|
|
600
|
+
|
|
601
|
+
Removes a plugin from the CLI.
|
|
602
|
+
|
|
603
|
+
```
|
|
604
|
+
USAGE
|
|
605
|
+
$ tsdk plugins:uninstall PLUGIN...
|
|
606
|
+
|
|
607
|
+
ARGUMENTS
|
|
608
|
+
PLUGIN plugin to uninstall
|
|
609
|
+
|
|
610
|
+
FLAGS
|
|
611
|
+
-h, --help Show CLI help.
|
|
612
|
+
-v, --verbose
|
|
613
|
+
|
|
614
|
+
DESCRIPTION
|
|
615
|
+
Removes a plugin from the CLI.
|
|
616
|
+
|
|
617
|
+
ALIASES
|
|
618
|
+
$ tsdk plugins unlink
|
|
619
|
+
$ tsdk plugins remove
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
## `tsdk plugins:uninstall PLUGIN...`
|
|
623
|
+
|
|
624
|
+
Removes a plugin from the CLI.
|
|
625
|
+
|
|
626
|
+
```
|
|
627
|
+
USAGE
|
|
628
|
+
$ tsdk plugins:uninstall PLUGIN...
|
|
629
|
+
|
|
630
|
+
ARGUMENTS
|
|
631
|
+
PLUGIN plugin to uninstall
|
|
632
|
+
|
|
633
|
+
FLAGS
|
|
634
|
+
-h, --help Show CLI help.
|
|
635
|
+
-v, --verbose
|
|
636
|
+
|
|
637
|
+
DESCRIPTION
|
|
638
|
+
Removes a plugin from the CLI.
|
|
639
|
+
|
|
640
|
+
ALIASES
|
|
641
|
+
$ tsdk plugins unlink
|
|
642
|
+
$ tsdk plugins remove
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
## `tsdk plugins update`
|
|
646
|
+
|
|
647
|
+
Update installed plugins.
|
|
648
|
+
|
|
649
|
+
```
|
|
650
|
+
USAGE
|
|
651
|
+
$ tsdk plugins update [-h] [-v]
|
|
652
|
+
|
|
653
|
+
FLAGS
|
|
654
|
+
-h, --help Show CLI help.
|
|
655
|
+
-v, --verbose
|
|
656
|
+
|
|
657
|
+
DESCRIPTION
|
|
658
|
+
Update installed plugins.
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
## `tsdk turbine connector keys generate`
|
|
662
|
+
|
|
663
|
+
Use to push an integration to Turbine
|
|
664
|
+
|
|
665
|
+
```
|
|
666
|
+
USAGE
|
|
667
|
+
$ tsdk turbine connector keys generate --turbine-url <value> [-u <value>] [-p <value>] [--signing-password <value>] [--key-name
|
|
668
|
+
<value>] [-h]
|
|
669
|
+
|
|
670
|
+
FLAGS
|
|
671
|
+
-h, --help Show CLI help.
|
|
672
|
+
-p, --password=<value> Turbine password
|
|
673
|
+
-u, --username=<value> Turbine username
|
|
674
|
+
--key-name=<value> name used for the key (default: username)
|
|
675
|
+
--signing-password=<value> password used for the private key
|
|
676
|
+
--turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
|
|
677
|
+
|
|
678
|
+
DESCRIPTION
|
|
679
|
+
Use to push an integration to Turbine
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
## `tsdk turbine connector keys list`
|
|
683
|
+
|
|
684
|
+
Use to push an integration to Turbine
|
|
685
|
+
|
|
686
|
+
```
|
|
687
|
+
USAGE
|
|
688
|
+
$ tsdk turbine connector keys list [-h]
|
|
689
|
+
|
|
690
|
+
FLAGS
|
|
691
|
+
-h, --help Show CLI help.
|
|
692
|
+
|
|
693
|
+
DESCRIPTION
|
|
694
|
+
Use to push an integration to Turbine
|
|
695
|
+
```
|
|
696
|
+
|
|
697
|
+
## `tsdk turbine connector push`
|
|
698
|
+
|
|
699
|
+
Use to push an integration to Turbine
|
|
700
|
+
|
|
701
|
+
```
|
|
702
|
+
USAGE
|
|
703
|
+
$ tsdk turbine connector push -f <value> --turbine-url <value> [-u <value>] [-p <value>] [-h]
|
|
704
|
+
|
|
705
|
+
FLAGS
|
|
706
|
+
-f, --file=<value> (required) path of the file to be uploaded to Turbine
|
|
707
|
+
-h, --help Show CLI help.
|
|
708
|
+
-p, --password=<value> Turbine password
|
|
709
|
+
-u, --username=<value> Turbine username
|
|
710
|
+
--turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
|
|
711
|
+
|
|
712
|
+
DESCRIPTION
|
|
713
|
+
Use to push an integration to Turbine
|
|
714
|
+
```
|
|
715
|
+
|
|
716
|
+
## `tsdk turbine login`
|
|
717
|
+
|
|
718
|
+
Use to login to Turbine
|
|
719
|
+
|
|
720
|
+
```
|
|
721
|
+
USAGE
|
|
722
|
+
$ tsdk turbine login --turbine-url <value> [-u <value>] [-p <value>] [-h]
|
|
723
|
+
|
|
724
|
+
FLAGS
|
|
725
|
+
-h, --help Show CLI help.
|
|
726
|
+
-p, --password=<value> Turbine password
|
|
727
|
+
-u, --username=<value> Turbine username
|
|
728
|
+
--turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
|
|
729
|
+
|
|
730
|
+
DESCRIPTION
|
|
731
|
+
Use to login to Turbine
|
|
732
|
+
```
|
|
733
|
+
|
|
734
|
+
## `tsdk version`
|
|
735
|
+
|
|
736
|
+
```
|
|
737
|
+
USAGE
|
|
738
|
+
$ tsdk version
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_
|
|
742
|
+
|
|
743
|
+
## `tsdk which`
|
|
744
|
+
|
|
745
|
+
Show which plugin a command is in.
|
|
746
|
+
|
|
747
|
+
```
|
|
748
|
+
USAGE
|
|
749
|
+
$ tsdk which
|
|
750
|
+
|
|
751
|
+
DESCRIPTION
|
|
752
|
+
Show which plugin a command is in.
|
|
753
|
+
```
|
|
754
|
+
|
|
755
|
+
_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/v2.1.0/src/commands/which.ts)_
|
|
756
|
+
<!-- commandsstop -->
|
|
757
|
+
|
|
758
|
+
# Roles and Works
|
|
759
|
+
|
|
760
|
+
1. [Person] Develop and Submit Release Pull Request
|
|
761
|
+
2. [Team] Review Release Pull Request
|
|
762
|
+
3. [CI] Publish
|
|
763
|
+
|
|
764
|
+
# Release Flow
|
|
765
|
+
|
|
766
|
+
0. [Local] Checkout release branch: `git checkout release/<uniq>`
|
|
767
|
+
1. [Local] Run `yarn run versionup`
|
|
768
|
+
- Update CHANGELOG.md and `package.json`'s `version`, and `lerna.json`'s `version`
|
|
769
|
+
- It does not git tag
|
|
770
|
+
2. [Local] Submit to Release Pull Request
|
|
771
|
+
3. [GitHub] Review Release Pull Request
|
|
772
|
+
4. [GitHub] Write Release Note into the Release Pull Request's body
|
|
773
|
+
4. [GitHub] Merge Release Pull Request
|
|
774
|
+
5. [CI] Create git tag && Create GitHub Release && publish to npm(GitHub Package Registry)
|
|
775
|
+
- :memo: The GitHub Release's body is copied from Release Pull Request's body
|
|
776
|
+
|
|
777
|
+
Quickstart
|
|
778
|
+
==========
|
|
779
|
+
|
|
780
|
+
See [Quickstart](./docs/quickstart.md)
|
|
781
|
+
|
|
782
|
+
Contributing
|
|
783
|
+
==========
|
|
784
|
+
|
|
785
|
+
See [Contributing](./docs/contributing.md)
|
|
786
|
+
|
|
787
|
+
Testing
|
|
788
|
+
==========
|
|
789
|
+
|
|
790
|
+
See [Integration Tests](./docs/integration-tests.md)
|
package/bin/dev
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const oclif = require('@oclif/core')
|
|
4
|
+
|
|
5
|
+
const path = require('path')
|
|
6
|
+
const project = path.join(__dirname, '..', 'tsconfig.json')
|
|
7
|
+
|
|
8
|
+
// In dev mode -> use ts-node and dev plugins
|
|
9
|
+
process.env.NODE_ENV = 'development'
|
|
10
|
+
|
|
11
|
+
require('ts-node').register({project})
|
|
12
|
+
|
|
13
|
+
// In dev mode, always show stack traces
|
|
14
|
+
oclif.settings.debug = true;
|
|
15
|
+
|
|
16
|
+
// Start the CLI
|
|
17
|
+
oclif.run().then(oclif.flush).catch(oclif.Errors.handle)
|
package/bin/dev.cmd
ADDED
package/bin/run
ADDED
package/bin/run.cmd
ADDED
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { run } from '@oclif/core';
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.run = void 0;
|
|
4
|
+
var core_1 = require("@oclif/core");
|
|
5
|
+
Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oCAA+B;AAAvB,2FAAA,GAAG,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"0.1.1-next.23+038e7a6","commands":{}}
|
package/package.json
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
{
|
|
2
|
+
"author": "Swimlane",
|
|
3
|
+
"bin": {
|
|
4
|
+
"tsdk": "./bin/run"
|
|
5
|
+
},
|
|
6
|
+
"bugs": "https://github.com/swimlane/turbine-sdk/issues",
|
|
7
|
+
"dependencies": {
|
|
8
|
+
"@oclif/core": "1.16.4",
|
|
9
|
+
"@oclif/plugin-autocomplete": "1.2.0",
|
|
10
|
+
"@oclif/plugin-commands": "2.1.0",
|
|
11
|
+
"@oclif/plugin-help": "5.1.12",
|
|
12
|
+
"@oclif/plugin-legacy": "1.2.7",
|
|
13
|
+
"@oclif/plugin-not-found": "2.3.1",
|
|
14
|
+
"@oclif/plugin-plugins": "2.1.0",
|
|
15
|
+
"@oclif/plugin-update": "3.0.0",
|
|
16
|
+
"@oclif/plugin-version": "1.0.4",
|
|
17
|
+
"@oclif/plugin-warn-if-update-available": "2.0.4",
|
|
18
|
+
"@oclif/plugin-which": "2.1.0",
|
|
19
|
+
"@sw-tsdk/core": "^0.1.1-next.23+038e7a6",
|
|
20
|
+
"@sw-tsdk/plugin-connector": "^0.1.1-next.23+038e7a6",
|
|
21
|
+
"@sw-tsdk/plugin-turbine": "^0.1.1-next.23+038e7a6",
|
|
22
|
+
"fs-extra": "10.0.1",
|
|
23
|
+
"inquirer": "8.2.2",
|
|
24
|
+
"npmlog": "6.0.1",
|
|
25
|
+
"tslib": "2.3.1"
|
|
26
|
+
},
|
|
27
|
+
"description": "Turbine SDK",
|
|
28
|
+
"engines": {
|
|
29
|
+
"node": ">=16.0.0"
|
|
30
|
+
},
|
|
31
|
+
"files": [
|
|
32
|
+
"/bin",
|
|
33
|
+
"/lib",
|
|
34
|
+
"/npm-shrinkwrap.json",
|
|
35
|
+
"/oclif.manifest.json"
|
|
36
|
+
],
|
|
37
|
+
"homepage": "https://github.com/swimlane/turbine-sdk",
|
|
38
|
+
"keywords": [
|
|
39
|
+
"swimlane",
|
|
40
|
+
"turbine-sdk"
|
|
41
|
+
],
|
|
42
|
+
"license": "ISC",
|
|
43
|
+
"main": "lib/index.js",
|
|
44
|
+
"name": "@swimlane/turbine-sdk",
|
|
45
|
+
"oclif": {
|
|
46
|
+
"commands": "./lib/commands",
|
|
47
|
+
"bin": "tsdk",
|
|
48
|
+
"additionalHelpFlags": [
|
|
49
|
+
"-h"
|
|
50
|
+
],
|
|
51
|
+
"additionalVersionFlags": [
|
|
52
|
+
"-v"
|
|
53
|
+
],
|
|
54
|
+
"topicSeparator": " ",
|
|
55
|
+
"devPlugins": [
|
|
56
|
+
"@oclif/plugin-help"
|
|
57
|
+
],
|
|
58
|
+
"scope": "swimlnae",
|
|
59
|
+
"repositoryPrefix": "<%- repo %>/blob/v<%- version %>/packages/ci/<%- commandPath %>",
|
|
60
|
+
"plugins": [
|
|
61
|
+
"@oclif/plugin-autocomplete",
|
|
62
|
+
"@oclif/plugin-commands",
|
|
63
|
+
"@oclif/plugin-help",
|
|
64
|
+
"@oclif/plugin-not-found",
|
|
65
|
+
"@oclif/plugin-warn-if-update-available",
|
|
66
|
+
"@oclif/plugin-plugins",
|
|
67
|
+
"@oclif/plugin-which",
|
|
68
|
+
"@oclif/plugin-warn-if-update-available",
|
|
69
|
+
"@oclif/plugin-version",
|
|
70
|
+
"@sw-tsdk/plugin-connector",
|
|
71
|
+
"@sw-tsdk/plugin-turbine"
|
|
72
|
+
],
|
|
73
|
+
"warn-if-update-available": {
|
|
74
|
+
"timeoutInDays": 1
|
|
75
|
+
},
|
|
76
|
+
"topics": {
|
|
77
|
+
"connector": {
|
|
78
|
+
"description": "Commands for working with a connector"
|
|
79
|
+
},
|
|
80
|
+
"connectors": {
|
|
81
|
+
"description": "Commands for working with a connectors"
|
|
82
|
+
},
|
|
83
|
+
"action": {
|
|
84
|
+
"description": "Commands for working with connector actions"
|
|
85
|
+
},
|
|
86
|
+
"turbine": {
|
|
87
|
+
"description": "Commands for working with a Turbine instance"
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
"publishConfig": {
|
|
92
|
+
"access": "public"
|
|
93
|
+
},
|
|
94
|
+
"repository": {
|
|
95
|
+
"type": "git",
|
|
96
|
+
"url": "git+https://github.com/swimlane/turbine-sdk.git"
|
|
97
|
+
},
|
|
98
|
+
"scripts": {
|
|
99
|
+
"lint": "eslint . --ext .ts --config .eslintrc",
|
|
100
|
+
"build": "rm -rf lib && tsc",
|
|
101
|
+
"pretest": "tsc -p test --noEmit",
|
|
102
|
+
"test": "echo NO TESTS",
|
|
103
|
+
"posttest": "yarn lint",
|
|
104
|
+
"postpack": "shx rm -f oclif.manifest.json",
|
|
105
|
+
"prepack": "yarn build && oclif manifest && oclif readme",
|
|
106
|
+
"version": "oclif readme --multi --dir '' && yarn copy-files",
|
|
107
|
+
"copy-files": "copyfiles README.md docs",
|
|
108
|
+
"link": "npm link"
|
|
109
|
+
},
|
|
110
|
+
"types": "lib/index.d.ts",
|
|
111
|
+
"version": "0.1.1-next.23+038e7a6",
|
|
112
|
+
"gitHead": "038e7a68d45b2d93f39c7f7b2edce9798019007e"
|
|
113
|
+
}
|