@swimlane/turbine-sdk 3.9.1 → 3.11.1

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 +122 -36
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +5 -5
package/README.md CHANGED
@@ -8,6 +8,7 @@ Swimlane Turbine SDK
8
8
  <!-- toc -->
9
9
  * [Requirements](#requirements)
10
10
  * [Installation](#installation)
11
+ * [Colima](#colima)
11
12
  * [Usage](#usage)
12
13
  * [Commands](#commands)
13
14
  <!-- tocstop -->
@@ -19,8 +20,8 @@ Swimlane Turbine SDK
19
20
  ```
20
21
  docker run -d -p 5000:5000 --name registry registry:2
21
22
  ```
22
- * nvm - (https://github.com/nvm-sh/nvm#installing-and-updating)
23
- * Node >= 16.13.0
23
+ * [Volta] (https://volta.sh/)
24
+ * Node >= 18
24
25
 
25
26
  # Installation
26
27
 
@@ -28,6 +29,36 @@ Swimlane Turbine SDK
28
29
  npm install -g @swimlane/turbine-sdk@latest
29
30
  ```
30
31
 
32
+ # Colima
33
+
34
+ If you are using Colima, you might need to remove your credStore value for it to work
35
+
36
+ Instead of:
37
+ ```json
38
+ {
39
+ "auths": {
40
+ "nexus.swimlane.io:5000": {}
41
+ },
42
+ **"credsStore": "desktop",**
43
+ "experimental": "disabled",
44
+ "currentContext": "colima",
45
+ "plugins": {
46
+ "-x-cli-hints": {
47
+ "enabled": "true"
48
+ },
49
+ "debug": {
50
+ "hooks": "exec"
51
+ },
52
+ "scout": {
53
+ "hooks": "pull,buildx build"
54
+ }
55
+ },
56
+ "features": {
57
+ "hooks": "true"
58
+ }
59
+ }
60
+ ```
61
+
31
62
  # Usage
32
63
  <!-- usage -->
33
64
  ```sh-session
@@ -35,7 +66,7 @@ $ npm install -g @swimlane/turbine-sdk
35
66
  $ tsdk COMMAND
36
67
  running command...
37
68
  $ tsdk (--version|-v)
38
- @swimlane/turbine-sdk/3.9.1 linux-x64 node-v16.20.2
69
+ @swimlane/turbine-sdk/3.11.1 linux-x64 node-v18.20.7
39
70
  $ tsdk --help [COMMAND]
40
71
  USAGE
41
72
  $ tsdk COMMAND
@@ -69,6 +100,8 @@ USAGE
69
100
  * [`tsdk description component`](#tsdk-description-component)
70
101
  * [`tsdk description connector`](#tsdk-description-connector)
71
102
  * [`tsdk help [COMMANDS]`](#tsdk-help-commands)
103
+ * [`tsdk migrator convert`](#tsdk-migrator-convert)
104
+ * [`tsdk migrator export`](#tsdk-migrator-export)
72
105
  * [`tsdk playbook create`](#tsdk-playbook-create)
73
106
  * [`tsdk playbook image`](#tsdk-playbook-image)
74
107
  * [`tsdk playbook ssp`](#tsdk-playbook-ssp)
@@ -192,8 +225,8 @@ Runs a connector action. (Defaults to current image version in local repository)
192
225
  ```
193
226
  USAGE
194
227
  $ tsdk action run local [-a <value>] [-d <value>] [--input-path <value>] [--output-path <value>] [--error-path
195
- <value>] [--asset-path <value>] [--template
196
- python_37_swimlane|node_18|node_20|python_39_definition|python_310_definition|python_311_definition] [-f] [-h]
228
+ <value>] [--asset-path <value>] [--template python_37_swimlane|node_18|node_20|python_39_definition|python_310_defin
229
+ ition|python_311_definition|python_312_definition] [-f] [-h]
197
230
 
198
231
  FLAGS
199
232
  -a, --action=<value> Action name to run
@@ -206,7 +239,7 @@ FLAGS
206
239
  --output-path=<value> File to write the outputs to, defaults to /data/<action>_output.json
207
240
  --template=<option> connector template
208
241
  <options: python_37_swimlane|node_18|node_20|python_39_definition|python_310_definition|pytho
209
- n_311_definition>
242
+ n_311_definition|python_312_definition>
210
243
 
211
244
  DESCRIPTION
212
245
  Runs a connector action. (Defaults to current image version in local repository).
@@ -301,24 +334,29 @@ Scaffold a new Component
301
334
  USAGE
302
335
  $ tsdk component create [-d <value>] [--componentUseCaseType <value>] [--componentFamily <value>] [--vendor <value>]
303
336
  [--componentName <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--overviewImagePath
304
- <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]
337
+ <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [--readmePath <value>]
338
+ [--externalReadmePath <value>] [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
305
339
 
306
340
  FLAGS
307
- -d, --directory=<value> [default: ./] root directory for where to store Component.
308
- -h, --help Show CLI help.
309
- --author=<value> Component Author
310
- --authorEmail=<value> Component Author Email
311
- --componentFamily=<value> Component Family (e.g. classic | canvas)
312
- --componentName=<value> Component Name (e.g. Alert Ingestion)
313
- --componentUseCaseType=<value> Component Use Case Type (e.g. ingestion| enrichment | remidiation)
314
- --description=<value> Description (e.g. CrowdStrike Alert Ingestion Component)
315
- --homepage=<value> Component Author Support URL
316
- --keywords=<value> Enter keywords
317
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
318
- resolution 200x200
319
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
320
- --sspPath=<value> absolute path to .ssp file
321
- --vendor=<value> Vendor (e.g. CrowdStrike)
341
+ -d, --directory=<value> [default: ./] root directory for where to store Component.
342
+ -h, --help Show CLI help.
343
+ --author=<value> Component Author
344
+ --authorEmail=<value> Component Author Email
345
+ --componentFamily=<value> Component Family (e.g. classic | canvas)
346
+ --componentName=<value> Component Name (e.g. Alert Ingestion)
347
+ --componentUseCaseType=<value> Component Use Case Type (e.g. ingestion| enrichment | remidiation)
348
+ --description=<value> Description (e.g. CrowdStrike Alert Ingestion Component)
349
+ --documentationReadmePath=<value> Absolute path to documentation.README.md file
350
+ --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
351
+ --externalymlPath=<value> Absolute path to external.yml file
352
+ --homepage=<value> Component Author Support URL
353
+ --keywords=<value> Enter keywords
354
+ --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
355
+ resolution 200x200
356
+ --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
357
+ --readmePath=<value> Absolute path to README.md file
358
+ --sspPath=<value> Absolute path to .ssp file
359
+ --vendor=<value> Vendor (e.g. CrowdStrike)
322
360
 
323
361
  DESCRIPTION
324
362
  Scaffold a new Component
@@ -662,6 +700,49 @@ DESCRIPTION
662
700
 
663
701
  _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
664
702
 
703
+ ## `tsdk migrator convert`
704
+
705
+ Convert scripts and forked plugins from Swimlane V10x to connectors.
706
+
707
+ ```
708
+ USAGE
709
+ $ tsdk migrator convert [-f <value>] [-t <value>] [--vendor <value>] [--product <value>] [--description <value>]
710
+ [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]
711
+
712
+ FLAGS
713
+ -f, --fromDirectory=<value> [default: ./] Root directory of the 10X export.
714
+ -h, --help Show CLI help.
715
+ -t, --toDirectory=<value> [default: ./connectors] Root directory of the destination repository.
716
+ --author=<value> Connector Author
717
+ --authorEmail=<value> Connector Author Email
718
+ --description=<value> Description (e.g. CrowdStrike Host Query API)
719
+ --homepage=<value> Connector Author Support URL
720
+ --product=<value> Product (e.g. Falcon)
721
+ --vendor=<value> Vendor (e.g. CrowdStrike)
722
+
723
+ DESCRIPTION
724
+ Convert scripts and forked plugins from Swimlane V10x to connectors.
725
+ ```
726
+
727
+ ## `tsdk migrator export`
728
+
729
+ Use to export python scripts from a Swimlane instance
730
+
731
+ ```
732
+ USAGE
733
+ $ tsdk migrator export [-c <value>] [-d <value>] [-o <value>] [-i] [-h]
734
+
735
+ FLAGS
736
+ -c, --mongoConnectionString=<value> Mongo Connection String
737
+ -d, --databaseName=<value> [default: Swimlane] Database Name
738
+ -h, --help Show CLI help.
739
+ -i, --tlsAllowInvalidCertificates Allow invalid certificates
740
+ -o, --outputFile=<value> [default: scripts.zip] Output file
741
+
742
+ DESCRIPTION
743
+ Use to export python scripts from a Swimlane instance
744
+ ```
745
+
665
746
  ## `tsdk playbook create`
666
747
 
667
748
  Scaffold a new playbook
@@ -670,22 +751,27 @@ Scaffold a new playbook
670
751
  USAGE
671
752
  $ tsdk playbook create [-d <value>] [--playbookFamily <value>] [--playbookName <value>] [--keywords <value>]
672
753
  [--description <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author <value>]
673
- [--authorEmail <value>] [--homepage <value>] [-h]
754
+ [--authorEmail <value>] [--homepage <value>] [--readmePath <value>] [--externalReadmePath <value>]
755
+ [--documentationReadmePath <value>] [--externalymlPath <value>] [-h]
674
756
 
675
757
  FLAGS
676
- -d, --directory=<value> [default: ./] root directory for where to store Playbook.
677
- -h, --help Show CLI help.
678
- --author=<value> Playbook Author
679
- --authorEmail=<value> Playbook Author Email
680
- --description=<value> Description (e.g. Text Aggregator Description)
681
- --homepage=<value> Playbook Author Support URL
682
- --keywords=<value> Enter keywords
683
- --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
684
- 200x200
685
- --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
686
- --playbookFamily=<value> Playbook Family (e.g. classic | canvas)
687
- --playbookName=<value> Playbook Name (e.g. Text Aggregator)
688
- --sspPath=<value> absolute path to .ssp file
758
+ -d, --directory=<value> [default: ./] root directory for where to store Playbook.
759
+ -h, --help Show CLI help.
760
+ --author=<value> Playbook Author
761
+ --authorEmail=<value> Playbook Author Email
762
+ --description=<value> Description (e.g. Text Aggregator Description)
763
+ --documentationReadmePath=<value> Absolute path to documentation.README.md file
764
+ --externalReadmePath=<value> Absolute path to EXTERNAL_README.md file
765
+ --externalymlPath=<value> Absolute path to external.yml file
766
+ --homepage=<value> Playbook Author Support URL
767
+ --keywords=<value> Enter keywords
768
+ --logoPath=<value> URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min
769
+ resolution 200x200
770
+ --overviewImagePath=<value> URL or absolute path to overview image file. Min resolution 1100x660
771
+ --playbookFamily=<value> Playbook Family (e.g. classic | canvas)
772
+ --playbookName=<value> Playbook Name (e.g. Text Aggregator)
773
+ --readmePath=<value> Absolute path to README.md file
774
+ --sspPath=<value> Absolute path to .ssp file
689
775
 
690
776
  DESCRIPTION
691
777
  Scaffold a new playbook
package/oclif.manifest.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "3.9.1",
2
+ "version": "3.11.1",
3
3
  "commands": {}
4
4
  }
package/package.json CHANGED
@@ -16,9 +16,9 @@
16
16
  "@oclif/plugin-version": "1.3.4",
17
17
  "@oclif/plugin-warn-if-update-available": "2.0.37",
18
18
  "@oclif/plugin-which": "2.2.21",
19
- "@sw-tsdk/core": "^3.9.1",
20
- "@sw-tsdk/plugin-connector": "^3.9.1",
21
- "@sw-tsdk/plugin-turbine": "^3.9.1",
19
+ "@sw-tsdk/core": "^3.11.1",
20
+ "@sw-tsdk/plugin-connector": "^3.11.1",
21
+ "@sw-tsdk/plugin-turbine": "^3.11.1",
22
22
  "fs-extra": "11.1.1",
23
23
  "inquirer": "8.2.2",
24
24
  "npmlog": "7.0.1",
@@ -105,6 +105,6 @@
105
105
  "dev:setup": "npm link"
106
106
  },
107
107
  "types": "lib/index.d.ts",
108
- "version": "3.9.1",
109
- "gitHead": "b0ecf39a08c42379ae016e54d2203e4690dc1a4c"
108
+ "version": "3.11.1",
109
+ "gitHead": "19426fb8524bccb52b4bfdbf42db5aac349ba80c"
110
110
  }