@sw-tsdk/plugin-connector 3.11.2 → 3.11.3-alpha.556fc3a

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.
Files changed (72) hide show
  1. package/README.md +49 -455
  2. package/lib/commands/action/add.js +4 -4
  3. package/lib/commands/action/add.js.map +1 -1
  4. package/lib/commands/component/create.d.ts +1 -0
  5. package/lib/commands/component/create.js +1 -0
  6. package/lib/commands/component/create.js.map +1 -1
  7. package/lib/commands/component/image.d.ts +1 -0
  8. package/lib/commands/component/image.js +1 -0
  9. package/lib/commands/component/image.js.map +1 -1
  10. package/lib/commands/component/ssp.d.ts +1 -0
  11. package/lib/commands/component/ssp.js +1 -0
  12. package/lib/commands/component/ssp.js.map +1 -1
  13. package/lib/commands/connector/build.js +1 -1
  14. package/lib/commands/connector/build.js.map +1 -1
  15. package/lib/commands/connector/create.d.ts +2 -2
  16. package/lib/commands/connector/create.js +18 -19
  17. package/lib/commands/connector/create.js.map +1 -1
  18. package/lib/commands/connector/logo.d.ts +1 -1
  19. package/lib/commands/connector/logo.js +18 -4
  20. package/lib/commands/connector/logo.js.map +1 -1
  21. package/lib/commands/description/action.d.ts +1 -0
  22. package/lib/commands/description/action.js +1 -0
  23. package/lib/commands/description/action.js.map +1 -1
  24. package/lib/commands/description/actions.d.ts +1 -0
  25. package/lib/commands/description/actions.js +1 -0
  26. package/lib/commands/description/actions.js.map +1 -1
  27. package/lib/commands/description/component.d.ts +1 -0
  28. package/lib/commands/description/component.js +1 -0
  29. package/lib/commands/description/component.js.map +1 -1
  30. package/lib/commands/description/connector.d.ts +1 -0
  31. package/lib/commands/description/connector.js +1 -0
  32. package/lib/commands/description/connector.js.map +1 -1
  33. package/lib/commands/migrator/convert.d.ts +1 -1
  34. package/lib/commands/migrator/convert.js +13 -10
  35. package/lib/commands/migrator/convert.js.map +1 -1
  36. package/lib/commands/migrator/export.js +1 -1
  37. package/lib/commands/migrator/export.js.map +1 -1
  38. package/lib/commands/playbook/create.d.ts +1 -0
  39. package/lib/commands/playbook/create.js +1 -0
  40. package/lib/commands/playbook/create.js.map +1 -1
  41. package/lib/commands/playbook/image.d.ts +1 -0
  42. package/lib/commands/playbook/image.js +1 -0
  43. package/lib/commands/playbook/image.js.map +1 -1
  44. package/lib/commands/playbook/ssp.d.ts +1 -0
  45. package/lib/commands/playbook/ssp.js +1 -0
  46. package/lib/commands/playbook/ssp.js.map +1 -1
  47. package/lib/commands/solution/create.d.ts +1 -0
  48. package/lib/commands/solution/create.js +6 -5
  49. package/lib/commands/solution/create.js.map +1 -1
  50. package/lib/commands/solution/image.d.ts +1 -0
  51. package/lib/commands/solution/image.js +1 -0
  52. package/lib/commands/solution/image.js.map +1 -1
  53. package/lib/commands/solution/ssp.d.ts +1 -0
  54. package/lib/commands/solution/ssp.js +1 -0
  55. package/lib/commands/solution/ssp.js.map +1 -1
  56. package/lib/commands/widget/create.d.ts +1 -0
  57. package/lib/commands/widget/create.js +1 -0
  58. package/lib/commands/widget/create.js.map +1 -1
  59. package/lib/commands/widget/image.d.ts +1 -0
  60. package/lib/commands/widget/image.js +1 -0
  61. package/lib/commands/widget/image.js.map +1 -1
  62. package/lib/commands/widget/ssp.d.ts +1 -0
  63. package/lib/commands/widget/ssp.js +1 -0
  64. package/lib/commands/widget/ssp.js.map +1 -1
  65. package/lib/transformers/connector-generator.js +6 -6
  66. package/lib/transformers/connector-generator.js.map +1 -1
  67. package/lib/types/connector-types.d.ts +3 -3
  68. package/lib/types/migrator-types.d.ts +3 -3
  69. package/lib/types/migrator-types.js +3 -3
  70. package/lib/types/migrator-types.js.map +1 -1
  71. package/oclif.manifest.json +35 -17
  72. package/package.json +10 -9
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @sw-tsdk/plugin-connector
16
16
  $ sw-tsdk-connector COMMAND
17
17
  running command...
18
18
  $ sw-tsdk-connector (--version)
19
- @sw-tsdk/plugin-connector/3.11.2 linux-x64 node-v18.20.7
19
+ @sw-tsdk/plugin-connector/3.11.3-alpha.556fc3a linux-x64 node-v20.19.0
20
20
  $ sw-tsdk-connector --help [COMMAND]
21
21
  USAGE
22
22
  $ sw-tsdk-connector COMMAND
@@ -31,9 +31,6 @@ USAGE
31
31
  * [`sw-tsdk-connector action:generate:output`](#sw-tsdk-connector-actiongenerateoutput)
32
32
  * [`sw-tsdk-connector action:run:local`](#sw-tsdk-connector-actionrunlocal)
33
33
  * [`sw-tsdk-connector asset:add`](#sw-tsdk-connector-assetadd)
34
- * [`sw-tsdk-connector component:create`](#sw-tsdk-connector-componentcreate)
35
- * [`sw-tsdk-connector component:image`](#sw-tsdk-connector-componentimage)
36
- * [`sw-tsdk-connector component:ssp`](#sw-tsdk-connector-componentssp)
37
34
  * [`sw-tsdk-connector connector:build`](#sw-tsdk-connector-connectorbuild)
38
35
  * [`sw-tsdk-connector connector:create`](#sw-tsdk-connector-connectorcreate)
39
36
  * [`sw-tsdk-connector connector:create:openapi`](#sw-tsdk-connector-connectorcreateopenapi)
@@ -43,21 +40,8 @@ USAGE
43
40
  * [`sw-tsdk-connector connector:sign`](#sw-tsdk-connector-connectorsign)
44
41
  * [`sw-tsdk-connector connector:update`](#sw-tsdk-connector-connectorupdate)
45
42
  * [`sw-tsdk-connector connector:validate`](#sw-tsdk-connector-connectorvalidate)
46
- * [`sw-tsdk-connector description:action`](#sw-tsdk-connector-descriptionaction)
47
- * [`sw-tsdk-connector description:actions`](#sw-tsdk-connector-descriptionactions)
48
- * [`sw-tsdk-connector description:component`](#sw-tsdk-connector-descriptioncomponent)
49
- * [`sw-tsdk-connector description:connector`](#sw-tsdk-connector-descriptionconnector)
50
43
  * [`sw-tsdk-connector migrator:convert`](#sw-tsdk-connector-migratorconvert)
51
44
  * [`sw-tsdk-connector migrator:export`](#sw-tsdk-connector-migratorexport)
52
- * [`sw-tsdk-connector playbook:create`](#sw-tsdk-connector-playbookcreate)
53
- * [`sw-tsdk-connector playbook:image`](#sw-tsdk-connector-playbookimage)
54
- * [`sw-tsdk-connector playbook:ssp`](#sw-tsdk-connector-playbookssp)
55
- * [`sw-tsdk-connector solution:create`](#sw-tsdk-connector-solutioncreate)
56
- * [`sw-tsdk-connector solution:image`](#sw-tsdk-connector-solutionimage)
57
- * [`sw-tsdk-connector solution:ssp`](#sw-tsdk-connector-solutionssp)
58
- * [`sw-tsdk-connector widget:create`](#sw-tsdk-connector-widgetcreate)
59
- * [`sw-tsdk-connector widget:image`](#sw-tsdk-connector-widgetimage)
60
- * [`sw-tsdk-connector widget:ssp`](#sw-tsdk-connector-widgetssp)
61
45
 
62
46
  ## `sw-tsdk-connector action:add`
63
47
 
@@ -77,7 +61,7 @@ DESCRIPTION
77
61
  Update a connector action.
78
62
  ```
79
63
 
80
- _See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/action/add.js)_
64
+ _See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/action/add.js)_
81
65
 
82
66
  ## `sw-tsdk-connector action:generate:data`
83
67
 
@@ -102,7 +86,7 @@ DESCRIPTION
102
86
  Use to test a task in an integration
103
87
  ```
104
88
 
105
- _See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/action/generate/data.js)_
89
+ _See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/action/generate/data.js)_
106
90
 
107
91
  ## `sw-tsdk-connector action:generate:input`
108
92
 
@@ -127,7 +111,7 @@ DESCRIPTION
127
111
  Update action input schema.
128
112
  ```
129
113
 
130
- _See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/action/generate/input.js)_
114
+ _See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/action/generate/input.js)_
131
115
 
132
116
  ## `sw-tsdk-connector action:generate:output`
133
117
 
@@ -151,7 +135,7 @@ DESCRIPTION
151
135
  Update a connector action.
152
136
  ```
153
137
 
154
- _See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/action/generate/output.js)_
138
+ _See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/action/generate/output.js)_
155
139
 
156
140
  ## `sw-tsdk-connector action:run:local`
157
141
 
@@ -180,7 +164,7 @@ DESCRIPTION
180
164
  Runs a connector action. (Defaults to current image version in local repository).
181
165
  ```
182
166
 
183
- _See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/action/run/local.js)_
167
+ _See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/action/run/local.js)_
184
168
 
185
169
  ## `sw-tsdk-connector asset:add`
186
170
 
@@ -201,89 +185,7 @@ DESCRIPTION
201
185
  Update a connector action.
202
186
  ```
203
187
 
204
- _See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/asset/add.js)_
205
-
206
- ## `sw-tsdk-connector component:create`
207
-
208
- Scaffold a new Component
209
-
210
- ```
211
- USAGE
212
- $ sw-tsdk-connector component:create [-d <value>] [--componentUseCaseType <value>] [--componentFamily <value>]
213
- [--vendor <value>] [--componentName <value>] [--keywords <value>] [--description <value>] [--logoPath <value>]
214
- [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>]
215
- [--readmePath <value>] [--externalReadmePath <value>] [--documentationReadmePath <value>] [--externalymlPath
216
- <value>] [-h]
217
-
218
- FLAGS
219
- -d, --directory=<value> [default: ./] root directory for where to store Component.
220
- -h, --help Show CLI help.
221
- --author=<value> Component Author
222
- --authorEmail=<value> Component Author Email
223
- --componentFamily=<value> Component Family (e.g. classic | canvas)
224
- --componentName=<value> Component Name (e.g. Alert Ingestion)
225
- --componentUseCaseType=<value> Component Use Case Type (e.g. ingestion| enrichment | remidiation)
226
- --description=<value> Description (e.g. CrowdStrike Alert Ingestion Component)
227
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
228
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
229
- --externalymlPath=<value> Absolute path to external.yml file
230
- --homepage=<value> Component Author Support URL
231
- --keywords=<value> Enter keywords
232
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
233
- resolution 200x200
234
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
235
- --readmePath=<value> Absolute path to README.md file
236
- --sspPath=<value> Absolute path to .ssp file
237
- --vendor=<value> Vendor (e.g. CrowdStrike)
238
-
239
- DESCRIPTION
240
- Scaffold a new Component
241
- ```
242
-
243
- _See code: [lib/commands/component/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/component/create.js)_
244
-
245
- ## `sw-tsdk-connector component:image`
246
-
247
- Update a Component image.
248
-
249
- ```
250
- USAGE
251
- $ sw-tsdk-connector component:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
252
-
253
- FLAGS
254
- -d, --directory=<value> [default: ./] root directory of the component folder.
255
- -h, --help Show CLI help.
256
- -i, --imageType=<value> Image Type (e.g. logo/overview)
257
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
258
- -p, --imagePath=<value> path or URL to product image in PNG format.
259
- -t, --componentType=<value> Component Type (e.g. classic)
260
-
261
- DESCRIPTION
262
- Update a Component image.
263
- ```
264
-
265
- _See code: [lib/commands/component/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/component/image.js)_
266
-
267
- ## `sw-tsdk-connector component:ssp`
268
-
269
- Update an SSP.
270
-
271
- ```
272
- USAGE
273
- $ sw-tsdk-connector component:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
274
-
275
- FLAGS
276
- -d, --directory=<value> [default: ./] root directory of the component folder.
277
- -h, --help Show CLI help.
278
- -n, --componentName=<value> Component Name (e.g. google_alert_ingestion)
279
- -p, --sspPath=<value> Absolute path to .SSP file
280
- -t, --componentType=<value> Component Type (e.g. classic)
281
-
282
- DESCRIPTION
283
- Update an SSP.
284
- ```
285
-
286
- _See code: [lib/commands/component/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/component/ssp.js)_
188
+ _See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/asset/add.js)_
287
189
 
288
190
  ## `sw-tsdk-connector connector:build`
289
191
 
@@ -293,8 +195,8 @@ Builds a local docker image of the connector.
293
195
  USAGE
294
196
  $ sw-tsdk-connector connector:build [--template
295
197
  python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python_310_definition|python_311_definitio
296
- n] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry <value>] [-o <value>]
297
- [-h]
198
+ n|python_312_definition] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry
199
+ <value>] [-o <value>] [-h]
298
200
 
299
201
  FLAGS
300
202
  -d, --directory=<value> [default: ./] root directory of the repository.
@@ -307,13 +209,13 @@ FLAGS
307
209
  --signing-password=<value> password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
308
210
  --template=<option> connector language
309
211
  <options: python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python
310
- _310_definition|python_311_definition>
212
+ _310_definition|python_311_definition|python_312_definition>
311
213
 
312
214
  DESCRIPTION
313
215
  Builds a local docker image of the connector.
314
216
  ```
315
217
 
316
- _See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/build.js)_
218
+ _See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/build.js)_
317
219
 
318
220
  ## `sw-tsdk-connector connector:create`
319
221
 
@@ -323,32 +225,30 @@ Scaffold a new connector
323
225
  USAGE
324
226
  $ sw-tsdk-connector connector:create [-d <value>] [-t python_310_definition|python_311_definition|python_3]
325
227
  [--vendor <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author
326
- <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--aspirationalConnector <value>] [--createSrcFolder
327
- <value>]
228
+ <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--createSrcFolder]
328
229
 
329
230
  FLAGS
330
- -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory
331
- will be generated.
332
- -h, --help Show CLI help.
333
- -t, --template=<option> [default: python_311_definition] connector template to scaffold
334
- <options: python_310_definition|python_311_definition|python_3>
335
- --aspirationalConnector=<value> Is it an aspirational connector? (e.g. false)
336
- --author=<value> Connector Author
337
- --authorEmail=<value> Connector Author Email
338
- --createSrcFolder=<value> Create Connector src folder? (e.g. false, true)
339
- --description=<value> Description (e.g. CrowdStrike Host Query API)
340
- --homepage=<value> Connector Author Support URL
341
- --keywords=<value> Enter keywords (Comma-Separated)
342
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
343
- resolution 200x200
344
- --product=<value> Product (e.g. Falcon)
345
- --vendor=<value> Vendor (e.g. CrowdStrike)
231
+ -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
232
+ generated.
233
+ -h, --help Show CLI help.
234
+ -t, --template=<option> [default: python_311_definition] connector template to scaffold
235
+ <options: python_310_definition|python_311_definition|python_3>
236
+ --author=<value> Connector Author
237
+ --authorEmail=<value> Connector Author Email
238
+ --createSrcFolder Create Connector src folder?
239
+ --description=<value> Description (e.g. CrowdStrike Host Query API)
240
+ --homepage=<value> Connector Author Support URL
241
+ --keywords=<value> Enter keywords (Comma-Separated)
242
+ --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
243
+ 200x200
244
+ --product=<value> Product (e.g. Falcon)
245
+ --vendor=<value> Vendor (e.g. CrowdStrike)
346
246
 
347
247
  DESCRIPTION
348
248
  Scaffold a new connector
349
249
  ```
350
250
 
351
- _See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/create.js)_
251
+ _See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/create.js)_
352
252
 
353
253
  ## `sw-tsdk-connector connector:create:openapi`
354
254
 
@@ -377,7 +277,7 @@ DESCRIPTION
377
277
  Scaffold a new connector
378
278
  ```
379
279
 
380
- _See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/create/openapi.js)_
280
+ _See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/create/openapi.js)_
381
281
 
382
282
  ## `sw-tsdk-connector connector:create:source`
383
283
 
@@ -395,7 +295,7 @@ DESCRIPTION
395
295
  Generates 11x source from 10x
396
296
  ```
397
297
 
398
- _See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/create/source.js)_
298
+ _See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/create/source.js)_
399
299
 
400
300
  ## `sw-tsdk-connector connector:lint`
401
301
 
@@ -418,7 +318,7 @@ DESCRIPTION
418
318
  Use to lint the connector
419
319
  ```
420
320
 
421
- _See code: [lib/commands/connector/lint.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/lint.js)_
321
+ _See code: [lib/commands/connector/lint.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/lint.js)_
422
322
 
423
323
  ## `sw-tsdk-connector connector:logo`
424
324
 
@@ -426,18 +326,18 @@ Update a connector.
426
326
 
427
327
  ```
428
328
  USAGE
429
- $ sw-tsdk-connector connector:logo -p <value> [-d <value>] [-h]
329
+ $ sw-tsdk-connector connector:logo [-d <value>] [-p <value>] [-h]
430
330
 
431
331
  FLAGS
432
332
  -d, --directory=<value> [default: .] root directory of the connector folder.
433
333
  -h, --help Show CLI help.
434
- -p, --path=<value> (required) path or URL to product logo in PNG format.
334
+ -p, --path=<value> path or URL to product logo in PNG format.
435
335
 
436
336
  DESCRIPTION
437
337
  Update a connector.
438
338
  ```
439
339
 
440
- _See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/logo.js)_
340
+ _See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/logo.js)_
441
341
 
442
342
  ## `sw-tsdk-connector connector:sign`
443
343
 
@@ -462,7 +362,7 @@ DESCRIPTION
462
362
  Builds a local docker image of the connector.
463
363
  ```
464
364
 
465
- _See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/sign.js)_
365
+ _See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/sign.js)_
466
366
 
467
367
  ## `sw-tsdk-connector connector:update`
468
368
 
@@ -482,7 +382,7 @@ DESCRIPTION
482
382
  Update a connector.
483
383
  ```
484
384
 
485
- _See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/update.js)_
385
+ _See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/update.js)_
486
386
 
487
387
  ## `sw-tsdk-connector connector:validate`
488
388
 
@@ -505,91 +405,7 @@ DESCRIPTION
505
405
  Use to validate an integration
506
406
  ```
507
407
 
508
- _See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/connector/validate.js)_
509
-
510
- ## `sw-tsdk-connector description:action`
511
-
512
- Use to generate action description
513
-
514
- ```
515
- USAGE
516
- $ sw-tsdk-connector description:action [-h] [-i <value>] [-s] [-d <value>] [-a <value>]
517
-
518
- FLAGS
519
- -a, --action=<value> Generate description for specific action
520
- -d, --directory=<value> [default: ./] current directory to mount
521
- -h, --help Show CLI help.
522
- -i, --image=<value> image to use
523
- -s, --skip-pull skips pulling the image
524
-
525
- DESCRIPTION
526
- Use to generate action description
527
- ```
528
-
529
- _See code: [lib/commands/description/action.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/description/action.js)_
530
-
531
- ## `sw-tsdk-connector description:actions`
532
-
533
- Use to generate description for all actions
534
-
535
- ```
536
- USAGE
537
- $ sw-tsdk-connector description:actions [-h] [-i <value>] [-s] [-d <value>]
538
-
539
- FLAGS
540
- -d, --directory=<value> [default: ./] current directory to mount
541
- -h, --help Show CLI help.
542
- -i, --image=<value> image to use
543
- -s, --skip-pull skips pulling the image
544
-
545
- DESCRIPTION
546
- Use to generate description for all actions
547
- ```
548
-
549
- _See code: [lib/commands/description/actions.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/description/actions.js)_
550
-
551
- ## `sw-tsdk-connector description:component`
552
-
553
- Use to generate component descriptions
554
-
555
- ```
556
- USAGE
557
- $ sw-tsdk-connector description:component [-h] [-i <value>] [-s] [-d <value>] [-c <value>] [-v <value>] [-p <value>]
558
-
559
- FLAGS
560
- -c, --componentName=<value> component name
561
- -d, --directory=<value> [default: ./] current directory to mount
562
- -h, --help Show CLI help.
563
- -i, --image=<value> image to use
564
- -p, --connectorLocalPath=<value> local path to connector
565
- -s, --skip-pull skips pulling the image
566
- -v, --componentFamily=<value> [default: classic] classic | canvas
567
-
568
- DESCRIPTION
569
- Use to generate component descriptions
570
- ```
571
-
572
- _See code: [lib/commands/description/component.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/description/component.js)_
573
-
574
- ## `sw-tsdk-connector description:connector`
575
-
576
- Use to generate connector descriptions
577
-
578
- ```
579
- USAGE
580
- $ sw-tsdk-connector description:connector [-h] [-i <value>] [-s] [-d <value>]
581
-
582
- FLAGS
583
- -d, --directory=<value> [default: ./] current directory to mount
584
- -h, --help Show CLI help.
585
- -i, --image=<value> image to use
586
- -s, --skip-pull skips pulling the image
587
-
588
- DESCRIPTION
589
- Use to generate connector descriptions
590
- ```
591
-
592
- _See code: [lib/commands/description/connector.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/description/connector.js)_
408
+ _See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/connector/validate.js)_
593
409
 
594
410
  ## `sw-tsdk-connector migrator:convert`
595
411
 
@@ -597,25 +413,25 @@ Convert scripts and forked plugins from Swimlane V10x to connectors.
597
413
 
598
414
  ```
599
415
  USAGE
600
- $ sw-tsdk-connector migrator:convert [-f <value>] [-t <value>] [--vendor <value>] [--product <value>] [--description
416
+ $ sw-tsdk-connector migrator:convert -t <value> [-s <value>] [--vendor <value>] [--product <value>] [--description
601
417
  <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]
602
418
 
603
419
  FLAGS
604
- -f, --fromDirectory=<value> [default: ./] Root directory of the 10X export.
605
- -h, --help Show CLI help.
606
- -t, --toDirectory=<value> [default: ./connectors] Root directory of the destination repository.
607
- --author=<value> Connector Author
608
- --authorEmail=<value> Connector Author Email
609
- --description=<value> Description (e.g. CrowdStrike Host Query API)
610
- --homepage=<value> Connector Author Support URL
611
- --product=<value> Product (e.g. Falcon)
612
- --vendor=<value> Vendor (e.g. CrowdStrike)
420
+ -h, --help Show CLI help.
421
+ -s, --source=<value> [default: ./] Source zip of the 10X export.
422
+ -t, --toDirectory=<value> (required) Root directory of the destination repository.
423
+ --author=<value> Connector Author
424
+ --authorEmail=<value> Connector Author Email
425
+ --description=<value> Description (e.g. CrowdStrike Host Query API)
426
+ --homepage=<value> Connector Author Support URL
427
+ --product=<value> Product (e.g. Falcon)
428
+ --vendor=<value> Vendor (e.g. CrowdStrike)
613
429
 
614
430
  DESCRIPTION
615
431
  Convert scripts and forked plugins from Swimlane V10x to connectors.
616
432
  ```
617
433
 
618
- _See code: [lib/commands/migrator/convert.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/migrator/convert.js)_
434
+ _See code: [lib/commands/migrator/convert.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/migrator/convert.js)_
619
435
 
620
436
  ## `sw-tsdk-connector migrator:export`
621
437
 
@@ -636,227 +452,5 @@ DESCRIPTION
636
452
  Use to export python scripts from a Swimlane instance
637
453
  ```
638
454
 
639
- _See code: [lib/commands/migrator/export.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/migrator/export.js)_
640
-
641
- ## `sw-tsdk-connector playbook:create`
642
-
643
- Scaffold a new playbook
644
-
645
- ```
646
- USAGE
647
- $ sw-tsdk-connector playbook:create [-d <value>] [--playbookFamily <value>] [--playbookName <value>] [--keywords
648
- <value>] [--description <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author
649
- <value>] [--authorEmail <value>] [--homepage <value>] [--readmePath <value>] [--externalReadmePath <value>]
650
- [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
651
-
652
- FLAGS
653
- -d, --directory=<value> [default: ./] root directory for where to store Playbook.
654
- -h, --help Show CLI help.
655
- --author=<value> Playbook Author
656
- --authorEmail=<value> Playbook Author Email
657
- --description=<value> Description (e.g. Text Aggregator Description)
658
- --documentationReadmePath=<value> Absolute path to documentation.README.md file
659
- --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
660
- --externalymlPath=<value> Absolute path to external.yml file
661
- --homepage=<value> Playbook Author Support URL
662
- --keywords=<value> Enter keywords
663
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
664
- resolution 200x200
665
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
666
- --playbookFamily=<value> Playbook Family (e.g. classic | canvas)
667
- --playbookName=<value> Playbook Name (e.g. Text Aggregator)
668
- --readmePath=<value> Absolute path to README.md file
669
- --sspPath=<value> Absolute path to .ssp file
670
-
671
- DESCRIPTION
672
- Scaffold a new playbook
673
- ```
674
-
675
- _See code: [lib/commands/playbook/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/playbook/create.js)_
676
-
677
- ## `sw-tsdk-connector playbook:image`
678
-
679
- Update a Playbook image.
680
-
681
- ```
682
- USAGE
683
- $ sw-tsdk-connector playbook:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
684
-
685
- FLAGS
686
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
687
- -h, --help Show CLI help.
688
- -i, --imageType=<value> Image Type (e.g. logo/overview)
689
- -n, --componentName=<value> Playbook Name (e.g. google_alert_ingestion)
690
- -p, --imagePath=<value> path or URL to product image in PNG format.
691
- -t, --componentType=<value> Playbook Type (e.g. classic)
692
-
693
- DESCRIPTION
694
- Update a Playbook image.
695
- ```
696
-
697
- _See code: [lib/commands/playbook/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/playbook/image.js)_
698
-
699
- ## `sw-tsdk-connector playbook:ssp`
700
-
701
- Update an SSP
702
-
703
- ```
704
- USAGE
705
- $ sw-tsdk-connector playbook:ssp [-d <value>] [-n <value>] [-p <value>] [-h]
706
-
707
- FLAGS
708
- -d, --directory=<value> [default: ./] root directory of the playbook folder.
709
- -h, --help Show CLI help.
710
- -n, --playbookName=<value> Playbook Name (e.g. text_aggregator)
711
- -p, --sspPath=<value> Absolute path to .SSP file
712
-
713
- DESCRIPTION
714
- Update an SSP
715
- ```
716
-
717
- _See code: [lib/commands/playbook/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/playbook/ssp.js)_
718
-
719
- ## `sw-tsdk-connector solution:create`
720
-
721
- Scaffold a new Solution
722
-
723
- ```
724
- USAGE
725
- $ sw-tsdk-connector solution:create [-d <value>] [--solutionFamily <value>] [--solutionName <value>] [--description
726
- <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail
727
- <value>] [--homepage <value>] [-h]
728
-
729
- FLAGS
730
- -d, --directory=<value> [default: ./] root directory for where to store Solution.
731
- -h, --help Show CLI help.
732
- --author=<value> Solution Author
733
- --authorEmail=<value> Solution Author Email
734
- --description=<value> Description (e.g. SOC Solution Description)
735
- --homepage=<value> Solution Author Support URL
736
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
737
- 200x200
738
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
739
- --solutionFamily=<value> Solution Family (e.g. classic | canvas)
740
- --solutionName=<value> Solution Name (e.g. SOC Solution)
741
- --sspPath=<value> absolute path to .ssp file
742
-
743
- DESCRIPTION
744
- Scaffold a new Solution
745
- ```
746
-
747
- _See code: [lib/commands/solution/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/solution/create.js)_
748
-
749
- ## `sw-tsdk-connector solution:image`
750
-
751
- Update a Solution image.
752
-
753
- ```
754
- USAGE
755
- $ sw-tsdk-connector solution:image [-d <value>] [-t <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
756
-
757
- FLAGS
758
- -d, --directory=<value> [default: ./] root directory of the solution folder.
759
- -h, --help Show CLI help.
760
- -i, --imageType=<value> Image Type (e.g. logo/overview)
761
- -n, --solutionName=<value> Solution Name (e.g. google_alert_ingestion)
762
- -p, --imagePath=<value> path or URL to product image in PNG format.
763
- -t, --solutionType=<value> Solution Type (e.g. classic)
764
-
765
- DESCRIPTION
766
- Update a Solution image.
767
- ```
768
-
769
- _See code: [lib/commands/solution/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/solution/image.js)_
770
-
771
- ## `sw-tsdk-connector solution:ssp`
772
-
773
- Update an SSP.
774
-
775
- ```
776
- USAGE
777
- $ sw-tsdk-connector solution:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
778
-
779
- FLAGS
780
- -d, --directory=<value> [default: ./] root directory of the solution folder.
781
- -h, --help Show CLI help.
782
- -n, --solutionName=<value> Solution Name (e.g. soc_solution)
783
- -p, --sspPath=<value> Absolute path to .SSP file
784
- -t, --solutionType=<value> Solution Type (e.g. classic)
785
-
786
- DESCRIPTION
787
- Update an SSP.
788
- ```
789
-
790
- _See code: [lib/commands/solution/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/solution/ssp.js)_
791
-
792
- ## `sw-tsdk-connector widget:create`
793
-
794
- Scaffold a new widget
795
-
796
- ```
797
- USAGE
798
- $ sw-tsdk-connector widget:create [-d <value>] [--widgetName <value>] [--keywords <value>] [--description
799
- <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>] [--authorEmail
800
- <value>] [--homepage <value>] [-h]
801
-
802
- FLAGS
803
- -d, --directory=<value> [default: ./] root directory for where to store Widget.
804
- -h, --help Show CLI help.
805
- --author=<value> Widget Author
806
- --authorEmail=<value> Widget Author Email
807
- --description=<value> Description (e.g. Action Buttons Description)
808
- --homepage=<value> Widget Author Support URL
809
- --keywords=<value> Enter keywords
810
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
811
- 200x200
812
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
813
- --sspPath=<value> absolute path to .ssp file
814
- --widgetName=<value> Widget Name (e.g. Action Buttons)
815
-
816
- DESCRIPTION
817
- Scaffold a new widget
818
- ```
819
-
820
- _See code: [lib/commands/widget/create.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/widget/create.js)_
821
-
822
- ## `sw-tsdk-connector widget:image`
823
-
824
- Update a Widget image.
825
-
826
- ```
827
- USAGE
828
- $ sw-tsdk-connector widget:image [-d <value>] [-n <value>] [-i <value>] [-p <value>] [-h]
829
-
830
- FLAGS
831
- -d, --directory=<value> [default: ./] root directory of the widget folder.
832
- -h, --help Show CLI help.
833
- -i, --imageType=<value> Image Type (e.g. logo/overview)
834
- -n, --componentName=<value> Widget Name (e.g. action_buttons)
835
- -p, --imagePath=<value> path or URL to product image in PNG format.
836
-
837
- DESCRIPTION
838
- Update a Widget image.
839
- ```
840
-
841
- _See code: [lib/commands/widget/image.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/widget/image.js)_
842
-
843
- ## `sw-tsdk-connector widget:ssp`
844
-
845
- Update an SSP
846
-
847
- ```
848
- USAGE
849
- $ sw-tsdk-connector widget:ssp [-d <value>] [-n <value>] [-p <value>] [-h]
850
-
851
- FLAGS
852
- -d, --directory=<value> [default: ./] root directory of the widget folder.
853
- -h, --help Show CLI help.
854
- -n, --widgetName=<value> Widget Name (e.g. action_buttons)
855
- -p, --sspPath=<value> Absolute path to .SSP file
856
-
857
- DESCRIPTION
858
- Update an SSP
859
- ```
860
-
861
- _See code: [lib/commands/widget/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.2/lib/commands/widget/ssp.js)_
455
+ _See code: [lib/commands/migrator/export.js](https://github.com/swimlane/turbine-sdk/blob/v3.11.3-alpha.556fc3a/lib/commands/migrator/export.js)_
862
456
  <!-- commandsstop -->