@swimlane/turbine-sdk 2.0.0 → 2.0.1-next.102

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 (3) hide show
  1. package/README.md +99 -40
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +5 -5
package/README.md CHANGED
@@ -35,7 +35,7 @@ $ npm install -g @swimlane/turbine-sdk
35
35
  $ tsdk COMMAND
36
36
  running command...
37
37
  $ tsdk (--version|-v)
38
- @swimlane/turbine-sdk/2.0.0 darwin-x64 node-v16.17.1
38
+ @swimlane/turbine-sdk/2.0.1-next.102+1852615 linux-x64 node-v16.18.1
39
39
  $ tsdk --help [COMMAND]
40
40
  USAGE
41
41
  $ tsdk COMMAND
@@ -54,7 +54,8 @@ USAGE
54
54
  * [`tsdk commands`](#tsdk-commands)
55
55
  * [`tsdk connector build`](#tsdk-connector-build)
56
56
  * [`tsdk connector create`](#tsdk-connector-create)
57
- * [`tsdk connector create-source`](#tsdk-connector-create-source)
57
+ * [`tsdk connector create openapi`](#tsdk-connector-create-openapi)
58
+ * [`tsdk connector create source`](#tsdk-connector-create-source)
58
59
  * [`tsdk connector logo`](#tsdk-connector-logo)
59
60
  * [`tsdk connector save`](#tsdk-connector-save)
60
61
  * [`tsdk connector sign`](#tsdk-connector-sign)
@@ -73,6 +74,7 @@ USAGE
73
74
  * [`tsdk turbine connector keys generate`](#tsdk-turbine-connector-keys-generate)
74
75
  * [`tsdk turbine connector keys list local`](#tsdk-turbine-connector-keys-list-local)
75
76
  * [`tsdk turbine connector keys list remote`](#tsdk-turbine-connector-keys-list-remote)
77
+ * [`tsdk turbine connector keys push`](#tsdk-turbine-connector-keys-push)
76
78
  * [`tsdk turbine connector push`](#tsdk-turbine-connector-push)
77
79
  * [`tsdk turbine login`](#tsdk-turbine-login)
78
80
  * [`tsdk version`](#tsdk-version)
@@ -273,19 +275,20 @@ Builds a local docker image of the connector.
273
275
 
274
276
  ```
275
277
  USAGE
276
- $ tsdk connector build --template python_3.7_swimlane|node_18|python_310_definition [-d <value>] [--save] [-f]
277
- [--signing-password <value>] [--key-name <value>] [--registry <value>] [-h]
278
+ $ tsdk connector build [--template python_37_swimlane|node_18|python_310_definition|python_311_definition] [-d
279
+ <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry <value>] [-o <value>] [-h]
278
280
 
279
281
  FLAGS
280
282
  -d, --directory=<value> [default: ./] root directory of the repository.
281
283
  -f, --force-rebuild forces nocache on the image build
282
284
  -h, --help Show CLI help.
285
+ -o, --output=<value> output path to where to store the image.
283
286
  --key-name=<value> name used for the key (default: username)
284
287
  --registry=<value> [default: localhost:5000] registry to use for signing
285
288
  --save saves a signed docker image as tar in local directory.
286
- --signing-password=<value> password used for the private key
287
- --template=<option> (required) [default: python_310_definition] connector language
288
- <options: python_3.7_swimlane|node_18|python_310_definition>
289
+ --signing-password=<value> password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
290
+ --template=<option> connector language
291
+ <options: python_37_swimlane|node_18|python_310_definition|python_311_definition>
289
292
 
290
293
  DESCRIPTION
291
294
  Builds a local docker image of the connector.
@@ -297,37 +300,63 @@ Scaffold a new connector
297
300
 
298
301
  ```
299
302
  USAGE
300
- $ tsdk connector create [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [--skip-repo] [--vendor
301
- <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author <value>]
303
+ $ tsdk connector create [-d <value>] [-t python_310_definition|python_311_definition|python_3] [--vendor <value>]
304
+ [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author <value>]
302
305
  [--authorEmail <value>] [--homepage <value>] [-h]
303
306
 
304
307
  FLAGS
305
308
  -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
306
309
  generated.
307
310
  -h, --help Show CLI help.
308
- -t, --template=<option> [default: python_310_definition] connector template to scaffold
309
- <options: node_18|python_310_definition|python_3.7_swimlane>
311
+ -t, --template=<option> [default: python_311_definition] connector template to scaffold
312
+ <options: python_310_definition|python_311_definition|python_3>
310
313
  --author=<value> Connector Author
311
314
  --authorEmail=<value> Connector Author Email
312
315
  --description=<value> Description (e.g. CrowdStrike Host Query API)
313
316
  --homepage=<value> Connector Author Support URL
314
- --keywords=<value> Enter keyword (Comma-Separated)
317
+ --keywords=<value> Enter keywords (Comma-Separated)
315
318
  --logoPath=<value> URL or absolute path to logo file
316
319
  --product=<value> Product (e.g. Falcon)
317
- --skip-repo skips the repository creation process
318
320
  --vendor=<value> Vendor (e.g. CrowdStrike)
319
321
 
320
322
  DESCRIPTION
321
323
  Scaffold a new connector
322
324
  ```
323
325
 
324
- ## `tsdk connector create-source`
326
+ ## `tsdk connector create openapi`
327
+
328
+ Scaffold a new connector
329
+
330
+ ```
331
+ USAGE
332
+ $ tsdk connector create openapi [-d <value>] [--vendor <value>] [--product <value>] [-k <value>] [--description <value>]
333
+ [--logoPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-o <value>] [-h]
334
+
335
+ FLAGS
336
+ -d, --directory=<value> [default: ./] root directory for where to store connectors, the connector directory will be
337
+ generated.
338
+ -h, --help Show CLI help.
339
+ -k, --keywords=<value> Please enter keyword (Comma-Separated)
340
+ -o, --specs=<value> root directory for where to store connectors, the connector directory will be generated.
341
+ --author=<value> Connector Author
342
+ --authorEmail=<value> Connector Author Email
343
+ --description=<value> Description (e.g. CrowdStrike Host Query API)
344
+ --homepage=<value> Connector Author Support URL
345
+ --logoPath=<value> URL or absolute path to logo file
346
+ --product=<value> Product (e.g. Falcon)
347
+ --vendor=<value> Vendor (e.g. CrowdStrike)
348
+
349
+ DESCRIPTION
350
+ Scaffold a new connector
351
+ ```
352
+
353
+ ## `tsdk connector create source`
325
354
 
326
355
  Generates 11x source from 10x
327
356
 
328
357
  ```
329
358
  USAGE
330
- $ tsdk connector create-source [-d <value>] [-h]
359
+ $ tsdk connector create source [-d <value>] [-h]
331
360
 
332
361
  FLAGS
333
362
  -d, --directory=<value> [default: ./] root directory of the repository.
@@ -380,11 +409,12 @@ Builds a local docker image of the connector.
380
409
  ```
381
410
  USAGE
382
411
  $ tsdk connector sign --image <value> --key-name <value> [-d <value>] [--signing-password <value>] [--save]
383
- [--registry <value>] [-h]
412
+ [--registry <value>] [-o <value>] [-h]
384
413
 
385
414
  FLAGS
386
415
  -d, --directory=<value> [default: ./] root directory of the repository.
387
416
  -h, --help Show CLI help.
417
+ -o, --output=<value> output path to where to store the image.
388
418
  --image=<value> (required) image name to sign
389
419
  --key-name=<value> (required) name used for the key (default: username)
390
420
  --registry=<value> [default: localhost:5000] registry to use for signing
@@ -427,7 +457,7 @@ FLAGS
427
457
  -h, --help Show CLI help.
428
458
  -i, --image=<value> image to use
429
459
  -s, --skip-pull skips pulling the image
430
- --key=<value> public key for verfication
460
+ --key=<value> public key for verification
431
461
  --signed validates a signed connector
432
462
 
433
463
  DESCRIPTION
@@ -691,15 +721,17 @@ Use to generate and store signing keys in Turbine
691
721
  ```
692
722
  USAGE
693
723
  $ tsdk turbine connector keys generate --turbine-url <value> [-u <value>] [-p <value>] [--signing-password <value>] [--key-name
694
- <value>] [-h]
724
+ <value>] [-b] [-h]
695
725
 
696
726
  FLAGS
697
- -h, --help Show CLI help.
698
- -p, --password=<value> Turbine password
699
- -u, --username=<value> Turbine username
700
- --key-name=<value> name used for the key (default: username)
701
- --signing-password=<value> password used for the private key
702
- --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
727
+ -b, --bypass-certificate-check disable certificate validation for Turbine instance (ENV:
728
+ TURBINE_BYPASS_CERTIFICATE_CHECK)
729
+ -h, --help Show CLI help.
730
+ -p, --password=<value> Turbine password (ENV: TURBINE_PASSWORD)
731
+ -u, --username=<value> Turbine username
732
+ --key-name=<value> name used for the key (default: username)
733
+ --signing-password=<value> password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
734
+ --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
703
735
 
704
736
  DESCRIPTION
705
737
  Use to generate and store signing keys in Turbine
@@ -726,32 +758,57 @@ Use to list remote keys
726
758
 
727
759
  ```
728
760
  USAGE
729
- $ tsdk turbine connector keys list remote --turbine-url <value> [-u <value>] [-p <value>] [-h]
761
+ $ tsdk turbine connector keys list remote --turbine-url <value> [-u <value>] [-p <value>] [-b] [-h]
730
762
 
731
763
  FLAGS
732
- -h, --help Show CLI help.
733
- -p, --password=<value> Turbine password
734
- -u, --username=<value> Turbine username
735
- --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
764
+ -b, --bypass-certificate-check disable certificate validation for Turbine instance (ENV:
765
+ TURBINE_BYPASS_CERTIFICATE_CHECK)
766
+ -h, --help Show CLI help.
767
+ -p, --password=<value> Turbine password (ENV: TURBINE_PASSWORD)
768
+ -u, --username=<value> Turbine username
769
+ --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
736
770
 
737
771
  DESCRIPTION
738
772
  Use to list remote keys
739
773
  ```
740
774
 
775
+ ## `tsdk turbine connector keys push`
776
+
777
+ Use to generate and store signing keys in Turbine
778
+
779
+ ```
780
+ USAGE
781
+ $ tsdk turbine connector keys push --turbine-url <value> [-u <value>] [-p <value>] [--key-name <value>] [-b] [-h]
782
+
783
+ FLAGS
784
+ -b, --bypass-certificate-check disable certificate validation for Turbine instance (ENV:
785
+ TURBINE_BYPASS_CERTIFICATE_CHECK)
786
+ -h, --help Show CLI help.
787
+ -p, --password=<value> Turbine password (ENV: TURBINE_PASSWORD)
788
+ -u, --username=<value> Turbine username
789
+ --key-name=<value> name used for the key (default: username)
790
+ --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
791
+
792
+ DESCRIPTION
793
+ Use to generate and store signing keys in Turbine
794
+ ```
795
+
741
796
  ## `tsdk turbine connector push`
742
797
 
743
798
  Use to push an integration to Turbine
744
799
 
745
800
  ```
746
801
  USAGE
747
- $ tsdk turbine connector push -f <value> --turbine-url <value> [-u <value>] [-p <value>] [-h]
802
+ $ tsdk turbine connector push -f <value> --turbine-url <value> [-u <value>] [-p <value>] [-b] [-h]
748
803
 
749
804
  FLAGS
750
- -f, --file=<value> (required) path of the file to be uploaded to Turbine
751
- -h, --help Show CLI help.
752
- -p, --password=<value> Turbine password
753
- -u, --username=<value> Turbine username
754
- --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
805
+ -b, --bypass-certificate-check disable certificate validation for Turbine instance (ENV:
806
+ TURBINE_BYPASS_CERTIFICATE_CHECK)
807
+ -f, --file=<value> (required) path of the file to be uploaded to Turbine
808
+ -h, --help Show CLI help.
809
+ -p, --password=<value> Turbine password (ENV: TURBINE_PASSWORD)
810
+ -u, --username=<value> Turbine username
811
+ --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
755
812
 
756
813
  DESCRIPTION
757
814
  Use to push an integration to Turbine
@@ -763,13 +820,15 @@ Use to login to Turbine
763
820
 
764
821
  ```
765
822
  USAGE
766
- $ tsdk turbine login --turbine-url <value> [-u <value>] [-p <value>] [-h]
823
+ $ tsdk turbine login --turbine-url <value> [-u <value>] [-p <value>] [-b] [-h]
767
824
 
768
825
  FLAGS
769
- -h, --help Show CLI help.
770
- -p, --password=<value> Turbine password
771
- -u, --username=<value> Turbine username
772
- --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
826
+ -b, --bypass-certificate-check disable certificate validation for Turbine instance (ENV:
827
+ TURBINE_BYPASS_CERTIFICATE_CHECK)
828
+ -h, --help Show CLI help.
829
+ -p, --password=<value> Turbine password (ENV: TURBINE_PASSWORD)
830
+ -u, --username=<value> Turbine username
831
+ --turbine-url=<value> (required) the url of the turbine instance [https://turbine.acme.com]
773
832
 
774
833
  DESCRIPTION
775
834
  Use to login to Turbine
package/oclif.manifest.json CHANGED
@@ -1 +1 @@
1
- {"version":"2.0.0","commands":{}}
1
+ {"version":"2.0.1-next.102+1852615","commands":{}}
package/package.json CHANGED
@@ -16,9 +16,9 @@
16
16
  "@oclif/plugin-version": "1.0.4",
17
17
  "@oclif/plugin-warn-if-update-available": "2.0.4",
18
18
  "@oclif/plugin-which": "2.1.0",
19
- "@sw-tsdk/core": "^2.0.0",
20
- "@sw-tsdk/plugin-connector": "^2.0.0",
21
- "@sw-tsdk/plugin-turbine": "^2.0.0",
19
+ "@sw-tsdk/core": "^2.0.1-next.102+1852615",
20
+ "@sw-tsdk/plugin-connector": "^2.0.1-next.102+1852615",
21
+ "@sw-tsdk/plugin-turbine": "^2.0.1-next.102+1852615",
22
22
  "fs-extra": "10.0.1",
23
23
  "inquirer": "8.2.2",
24
24
  "npmlog": "6.0.1",
@@ -104,6 +104,6 @@
104
104
  "dev:setup": "npm link"
105
105
  },
106
106
  "types": "lib/index.d.ts",
107
- "version": "2.0.0",
108
- "gitHead": "0df4f0ee14534b1bf106707ddd752c5f6724efc5"
107
+ "version": "2.0.1-next.102+1852615",
108
+ "gitHead": "18526150ea6273dbcf6fa0d9ad74722d902616c3"
109
109
  }