@sw-tsdk/plugin-connector

Integration Task CLI Plugin

• Usage
• Commands

Usage

$ npm install -g @sw-tsdk/plugin-connector
$ sw-tsdk-connector COMMAND
running command...
$ sw-tsdk-connector (--version)
@sw-tsdk/plugin-connector/3.26.0 linux-x64 node-v20.19.0
$ sw-tsdk-connector --help [COMMAND]
USAGE
  $ sw-tsdk-connector COMMAND
...

Commands

• sw-tsdk-connector action:add
• sw-tsdk-connector action:generate:data
• sw-tsdk-connector action:generate:input
• sw-tsdk-connector action:generate:output
• sw-tsdk-connector action:run:local
• sw-tsdk-connector asset:add
• sw-tsdk-connector connector:build
• sw-tsdk-connector connector:create
• sw-tsdk-connector connector:create:openapi
• sw-tsdk-connector connector:create:source
• sw-tsdk-connector connector:lint
• sw-tsdk-connector connector:logo
• sw-tsdk-connector connector:sign
• sw-tsdk-connector connector:update
• sw-tsdk-connector connector:validate
• sw-tsdk-connector migrator:convert
• sw-tsdk-connector migrator:export

sw-tsdk-connector action:add

Update a connector action.

USAGE
  $ sw-tsdk-connector action:add [-d <value>] [-t node|python_definition|python] [-h]

FLAGS
  -d, --directory=<value>  [default: ./] Root directory of the repository.
  -h, --help               Show CLI help.
  -t, --template=<option>  [default: python_definition] action template to scaffold
                           <options: node|python_definition|python>

DESCRIPTION
  Update a connector action.

See code: lib/commands/action/add.js

sw-tsdk-connector action:generate:data

Use to test a task in an integration

USAGE
  $ sw-tsdk-connector action:generate:data [-h] [-a <value>] [--asset <value>] [--inputs <value>] [-d <value>]
    [--include-optional] [--force]

FLAGS
  -a, --action=<value>     action to generate data
  -d, --directory=<value>  [default: ./] current directory to mount
  -h, --help               Show CLI help.
  --asset=<value>          Filename for asset, defaults to the task name under the data folder. ie: data/asset_name.json
  --force                  overwrites current files
  --include-optional       used to only generate required properties
  --inputs=<value>         Filename for JSON inputs, defaults to the task name under the data folder. ie:
                           data/my_task.json

DESCRIPTION
  Use to test a task in an integration

See code: lib/commands/action/generate/data.js

sw-tsdk-connector action:generate:input

Update action input schema.

USAGE
  $ sw-tsdk-connector action:generate:input [-a <value>] [-d <value>] [--amend] [--action-config-path <value>]
    [--input-path <value>] [-h]

FLAGS
  -a, --action=<value>          Action name to run
  -d, --directory=<value>       [default: ./] Root directory of the repository.
  -h, --help                    Show CLI help.
  --action-config-path=<value>  Override path to action configuration file. Defaults to
                                /connector/config/actions/<action>.yaml
  --amend                       Merge with existing schema.
  --input-path=<value>          Relative path to the output data JSON file, defaults to the task name under the data
                                folder. ie: /data/<taskName>_output.json

DESCRIPTION
  Update action input schema.

See code: lib/commands/action/generate/input.js

sw-tsdk-connector action:generate:output

Update a connector action.

USAGE
  $ sw-tsdk-connector action:generate:output [-a <value>] [-d <value>] [--action-config-path <value>] [--amend]
    [--output-path <value>] [-h]

FLAGS
  -a, --action=<value>          Action name to run
  -d, --directory=<value>       [default: ./] Root directory of the repository.
  -h, --help                    Show CLI help.
  --action-config-path=<value>  Override path to action configuration file. Defaults to /connector/config/<action>.yaml
  --amend                       Merge with existing schema.
  --output-path=<value>         Relative path to the output data JSON file, defaults to the task name under the data
                                folder. ie: /data/<taskName>_output.json

DESCRIPTION
  Update a connector action.

See code: lib/commands/action/generate/output.js

sw-tsdk-connector action:run:local

Runs a connector action. (Defaults to current image version in local repository).

USAGE
  $ sw-tsdk-connector action:run:local [-a <value>] [-d <value>] [--input-path <value>] [--output-path <value>]
    [--error-path <value>] [--asset-path <value>] [--template
    node_18|node_20|python_311_definition|python_311_definition_fips|python_312_definition|python_312_definition_fips|py
    thon_313_definition|python_313_definition_fips|python_314_definition|python_314_definition_fips] [-f] [-h]

FLAGS
  -a, --action=<value>     Action name to run
  -d, --directory=<value>  [default: ./] Root directory of the repository.
  -f, --force-rebuild      forces nocache on the image build
  -h, --help               Show CLI help.
  --asset-path=<value>     File to asset data JSON file, defaults to /data/asset.json
  --error-path=<value>     File to write the errors to, defaults to /data/<action>_error.json
  --input-path=<value>     File to input data JSON file, defaults to /data/<action>.json
  --output-path=<value>    File to write the outputs to, defaults to /data/<action>_output.json
  --template=<option>      connector template
                           <options: node_18|node_20|python_311_definition|python_311_definition_fips|python_312_definit
                           ion|python_312_definition_fips|python_313_definition|python_313_definition_fips|python_314_de
                           finition|python_314_definition_fips>

DESCRIPTION
  Runs a connector action. (Defaults to current image version in local repository).

See code: lib/commands/action/run/local.js

sw-tsdk-connector asset:add

Update a connector action.

USAGE
  $ sw-tsdk-connector asset:add [-d <value>] [-s
    custom|apikey|oauth2_client_credentials|http_basic|http_bearer] [-h]

FLAGS
  -d, --directory=<value>  [default: ./] Root directory of the repository.
  -h, --help               Show CLI help.
  -s, --scheme=<option>    asset template to scaffold
                           <options: custom|apikey|oauth2_client_credentials|http_basic|http_bearer>

DESCRIPTION
  Update a connector action.

See code: lib/commands/asset/add.js

sw-tsdk-connector connector:build

Builds a local docker image of the connector.

USAGE
  $ sw-tsdk-connector connector:build [--template
    node_18|node_20|python_311_definition|python_311_definition_fips|python_312_definition|python_312_definition_fips|py
    thon_313_definition|python_313_definition_fips|python_314_definition|python_314_definition_fips|native_python_custom
    ] [-d <value>] [--save] [-f] [--signing-password <value>] [--key-name <value>] [--registry <value>] [-o <value>]
    [-h]

FLAGS
  -d, --directory=<value>     [default: ./] root directory of the repository.
  -f, --force-rebuild         forces nocache on the image build
  -h, --help                  Show CLI help.
  -o, --output=<value>        output path to where to store the image.
  --key-name=<value>          name used for the key (default: username_yyyy-MM-dd)
  --registry=<value>          [default: localhost:5000] registry to use for signing
  --save                      saves a signed docker image as tar in local directory.
  --signing-password=<value>  password used for the private key (ENV: TURBINE_SIGNING_PASSWORD)
  --template=<option>         connector language
                              <options: node_18|node_20|python_311_definition|python_311_definition_fips|python_312_defi
                              nition|python_312_definition_fips|python_313_definition|python_313_definition_fips|python_
                              314_definition|python_314_definition_fips|native_python_custom>

DESCRIPTION
  Builds a local docker image of the connector.

See code: lib/commands/connector/build.js

sw-tsdk-connector connector:create

Scaffold a new connector

USAGE
  $ sw-tsdk-connector connector:create [-d <value>] [-t
    python_311_definition|python_311_definition_fips|python_312_definition|python_312_definition_fips|python_313_definit
    ion|python_313_definition_fips|python_314_definition|python_314_definition_fips|python_3|native_python_custom]
    [--vendor <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author
    <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--createSrcFolder]

FLAGS
  -d, --directory=<value>  [default: ./] root directory for where to store connectors, the connector directory will be
                           generated.
  -h, --help               Show CLI help.
  -t, --template=<option>  [default: python_311_definition_fips] connector template to scaffold
                           <options: python_311_definition|python_311_definition_fips|python_312_definition|python_312_d
                           efinition_fips|python_313_definition|python_313_definition_fips|python_314_definition|python_
                           314_definition_fips|python_3|native_python_custom>
  --author=<value>         Connector Author
  --authorEmail=<value>    Connector Author Email
  --createSrcFolder        Create Connector src folder?
  --description=<value>    Description (e.g. CrowdStrike Host Query API)
  --homepage=<value>       Connector Author Support URL
  --keywords=<value>       Enter keywords (Comma-Separated)
  --logoPath=<value>       URL or absolute path to logo file. Image should be in 1:1 aspect ratio and min resolution
                           200x200
  --product=<value>        Product (e.g. Falcon)
  --vendor=<value>         Vendor (e.g. CrowdStrike)

DESCRIPTION
  Scaffold a new connector

See code: lib/commands/connector/create.js

sw-tsdk-connector connector:create:openapi

Scaffold a new connector

USAGE
  $ sw-tsdk-connector connector:create:openapi [-d <value>] [--vendor <value>] [--product <value>] [-k <value>] [--description
    <value>] [--logoPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-o <value>] [-h]

FLAGS
  -d, --directory=<value>  [default: ./] root directory for where to store connectors, the connector directory will be
                           generated.
  -h, --help               Show CLI help.
  -k, --keywords=<value>   Please enter keyword (Comma-Separated)
  -o, --specs=<value>      path to the spec file
  --author=<value>         Connector Author
  --authorEmail=<value>    Connector Author Email
  --description=<value>    Description (e.g. CrowdStrike Host Query API)
  --homepage=<value>       Connector Author Support URL
  --logoPath=<value>       URL or absolute path to logo file
  --product=<value>        Product (e.g. Falcon)
  --vendor=<value>         Vendor (e.g. CrowdStrike)

DESCRIPTION
  Scaffold a new connector

See code: lib/commands/connector/create/openapi.js

sw-tsdk-connector connector:create:source

Generates 11x source from 10x

USAGE
  $ sw-tsdk-connector connector:create:source [-d <value>] [-h]

FLAGS
  -d, --directory=<value>  [default: ./] root directory of the repository.
  -h, --help               Show CLI help.

DESCRIPTION
  Generates 11x source from 10x

See code: lib/commands/connector/create/source.js

sw-tsdk-connector connector:lint

Use to lint the connector

USAGE
  $ sw-tsdk-connector connector:lint [-h] [-i <value>] [-s] [-d <value>] [-a <value>] [--verify] [--debug]

FLAGS
  -a, --action=<value>     Generate description for specific action
  -d, --directory=<value>  [default: ./] current directory to mount
  -h, --help               Show CLI help.
  -i, --image=<value>      image to use
  -s, --skip-pull          skips pulling the image
  --debug                  Debug mode.
  --verify                 Verifies connector linting

DESCRIPTION
  Use to lint the connector

See code: lib/commands/connector/lint.js

sw-tsdk-connector connector:logo

Update a connector.

USAGE
  $ sw-tsdk-connector connector:logo [-d <value>] [-p <value>] [-h]

FLAGS
  -d, --directory=<value>  [default: .] root directory of the connector folder.
  -h, --help               Show CLI help.
  -p, --path=<value>       path or URL to product logo in PNG format.

DESCRIPTION
  Update a connector.

See code: lib/commands/connector/logo.js

sw-tsdk-connector connector:sign

Builds a local docker image of the connector.

USAGE
  $ sw-tsdk-connector connector:sign --image <value> --key-name <value> [-d <value>] [--signing-password <value>]
    [--save] [--registry <value>] [-o <value>] [-h]

FLAGS
  -d, --directory=<value>     [default: ./] root directory of the repository.
  -h, --help                  Show CLI help.
  -o, --output=<value>        output path to where to store the image.
  --image=<value>             (required) image name to sign
  --key-name=<value>          (required) name used for the key (default: username)
  --registry=<value>          [default: localhost:5000] registry to use for signing
  --save                      saves docker image as tar in local directory.
  --signing-password=<value>  password used for the private key

DESCRIPTION
  Builds a local docker image of the connector.

See code: lib/commands/connector/sign.js

sw-tsdk-connector connector:update

Update a connector.

USAGE
  $ sw-tsdk-connector connector:update [-d <value>] [-v <value>] [-f <value>] [-h]

FLAGS
  -d, --directory=<value>      [default: .] root directory of the connector folder.
  -f, --manifest-path=<value>  [default: /connector/connector.yaml] connector manifest path relative to directory.
  -h, --help                   Show CLI help.
  -v, --version=<value>        new version of the connector.

DESCRIPTION
  Update a connector.

See code: lib/commands/connector/update.js

sw-tsdk-connector connector:validate

Use to validate an integration

USAGE
  $ sw-tsdk-connector connector:validate -c <value> [-h] [-i <value>] [--key <value> --signed] [-s] [-d <value>]

FLAGS
  -c, --connector=<value>  (required) [default: connector] connector to validate (relative to directory)
  -d, --directory=<value>  [default: ./] current directory to mount
  -h, --help               Show CLI help.
  -i, --image=<value>      image to use
  -s, --skip-pull          skips pulling the image
  --key=<value>            public key for verification
  --signed                 validates a signed connector

DESCRIPTION
  Use to validate an integration

See code: lib/commands/connector/validate.js

sw-tsdk-connector migrator:convert

Convert scripts and forked plugins from Swimlane V10x to connectors.

USAGE
  $ sw-tsdk-connector migrator:convert -t <value> [-s <value>] [--vendor <value>] [--product <value>] [--description
    <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]

FLAGS
  -h, --help                 Show CLI help.
  -s, --source=<value>       [default: ./] Source zip of the 10X export.
  -t, --toDirectory=<value>  (required) Root directory of the destination repository.
  --author=<value>           Connector Author
  --authorEmail=<value>      Connector Author Email
  --description=<value>      Description (e.g. CrowdStrike Host Query API)
  --homepage=<value>         Connector Author Support URL
  --product=<value>          Product (e.g. Falcon)
  --vendor=<value>           Vendor (e.g. CrowdStrike)

DESCRIPTION
  Convert scripts and forked plugins from Swimlane V10x to connectors.

See code: lib/commands/migrator/convert.js

sw-tsdk-connector migrator:export

Use to export python scripts from a Swimlane instance

USAGE
  $ sw-tsdk-connector migrator:export [-c <value>] [-d <value>] [-o <value>] [-i] [-h]

FLAGS
  -c, --mongoConnectionString=<value>  Mongo Connection String
  -d, --databaseName=<value>           [default: Swimlane] Database Name
  -h, --help                           Show CLI help.
  -i, --tlsAllowInvalidCertificates    Allow invalid certificates
  -o, --outputFile=<value>             [default: scripts.zip] Output file

DESCRIPTION
  Use to export python scripts from a Swimlane instance

See code: lib/commands/migrator/export.js