npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sw-tsdk/plugin-connector

v3.5.0

Published

Plugin for managing connectors.

Downloads

899

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

mr_charliemr_charlieswimlane.devswimlane.dev

Keywords

oclif-plugin

Readme

Integration Task CLI Plugin

Swimlane Logo

Version Downloads/week License

Usage

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

Commands

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
    python_37_swimlane|node_18|node_20|python_39_definition|python_310_definition|python_311_definition] [-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: python_37_swimlane|node_18|node_20|python_39_definition|python_310_definition|pytho
                           n_311_definition>

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 component:create

Scaffold a new Component

USAGE
  $ sw-tsdk-connector component:create [-d <value>] [--componentUseCaseType <value>] [--componentFamily <value>]
    [--vendor <value>] [--componentName <value>] [--keywords <value>] [--description <value>] [--logoPath <value>]
    [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]

FLAGS
  -d, --directory=<value>         [default: ./] root directory for where to store Component.
  -h, --help                      Show CLI help.
  --author=<value>                Component Author
  --authorEmail=<value>           Component Author Email
  --componentFamily=<value>       Component Family (e.g. classic | canvas)
  --componentName=<value>         Component Name (e.g. Alert Ingestion)
  --componentUseCaseType=<value>  Component Use Case Type (e.g. ingestion| enrichment | remidiation)
  --description=<value>           Description (e.g. CrowdStrike Alert Ingestion Component)
  --homepage=<value>              Component Author Support URL
  --keywords=<value>              Enter keywords
  --logoPath=<value>              URL or absolute path to logo file
  --sspPath=<value>               absolute path to .ssp file
  --vendor=<value>                Vendor (e.g. CrowdStrike)

DESCRIPTION
  Scaffold a new Component

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

sw-tsdk-connector component:logo

Update a Component logo.

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

FLAGS
  -d, --directory=<value>      [default: ./] root directory of the component folder.
  -h, --help                   Show CLI help.
  -n, --componentName=<value>  Component Name (e.g. google_alert_ingestion)
  -p, --logoPath=<value>       path or URL to product logo in PNG format.
  -t, --componentType=<value>  Component Type (e.g. classic)

DESCRIPTION
  Update a Component logo.

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

sw-tsdk-connector component:ssp

Update an SSP.

USAGE
  $ sw-tsdk-connector component:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]

FLAGS
  -d, --directory=<value>      [default: ./] root directory of the component folder.
  -h, --help                   Show CLI help.
  -n, --componentName=<value>  Component Name (e.g. google_alert_ingestion)
  -p, --sspPath=<value>        Absolute path to .SSP file
  -t, --componentType=<value>  Component Type (e.g. classic)

DESCRIPTION
  Update an SSP.

See code: lib/commands/component/ssp.js

sw-tsdk-connector connector:build

Builds a local docker image of the connector.

USAGE
  $ sw-tsdk-connector connector:build [--template
    python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python_310_definition|python_311_definitio
    n] [-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: python_37_swimlane|node_18|node_20|python_39_definition|python_39_turbine|python
                              _310_definition|python_311_definition>

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_310_definition|python_311_definition|python_3]
    [--vendor <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--author
    <value>] [--authorEmail <value>] [--homepage <value>] [-h] [--aspirationalConnector <value>] [--createSrcFolder
    <value>]

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] connector template to scaffold
                                   <options: python_310_definition|python_311_definition|python_3>
  --aspirationalConnector=<value>  Is it an aspirational connector? (e.g. false)
  --author=<value>                 Connector Author
  --authorEmail=<value>            Connector Author Email
  --createSrcFolder=<value>        Create Connector src folder? (e.g. false, true)
  --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
  --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 -p <value> [-d <value>] [-h]

FLAGS
  -d, --directory=<value>  [default: .] root directory of the connector folder.
  -h, --help               Show CLI help.
  -p, --path=<value>       (required) 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 description:action

Use to generate action description

USAGE
  $ sw-tsdk-connector description:action [-h] [-i <value>] [-s] [-d <value>] [-a <value>]

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

DESCRIPTION
  Use to generate action description

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

sw-tsdk-connector description:actions

Use to generate description for all actions

USAGE
  $ sw-tsdk-connector description:actions [-h] [-i <value>] [-s] [-d <value>]

FLAGS
  -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

DESCRIPTION
  Use to generate description for all actions

See code: lib/commands/description/actions.js

sw-tsdk-connector description:component

Use to generate component descriptions

USAGE
  $ sw-tsdk-connector description:component [-h] [-i <value>] [-s] [-d <value>] [-c <value>] [-v <value>] [-p <value>]

FLAGS
  -c, --componentName=<value>       component name
  -d, --directory=<value>           [default: ./] current directory to mount
  -h, --help                        Show CLI help.
  -i, --image=<value>               image to use
  -p, --connectorLocalPath=<value>  local path to connector
  -s, --skip-pull                   skips pulling the image
  -v, --componentFamily=<value>     [default: classic] classic | canvas

DESCRIPTION
  Use to generate component descriptions

See code: lib/commands/description/component.js

sw-tsdk-connector description:connector

Use to generate connector descriptions

USAGE
  $ sw-tsdk-connector description:connector [-h] [-i <value>] [-s] [-d <value>]

FLAGS
  -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

DESCRIPTION
  Use to generate connector descriptions

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

sw-tsdk-connector playbook:create

Scaffold a new playbook

USAGE
  $ sw-tsdk-connector playbook:create [-d <value>] [--playbookFamily <value>] [--playbookName <value>] [--keywords
    <value>] [--description <value>] [--logoPath <value>] [--overviewImagePath <value>] [--sspPath <value>] [--author
    <value>] [--authorEmail <value>] [--homepage <value>] [-h]

FLAGS
  -d, --directory=<value>      [default: ./] root directory for where to store Playbook.
  -h, --help                   Show CLI help.
  --author=<value>             Playbook Author
  --authorEmail=<value>        Playbook Author Email
  --description=<value>        Description (e.g. Text Aggregator Description)
  --homepage=<value>           Playbook Author Support URL
  --keywords=<value>           Enter keywords
  --logoPath=<value>           URL or absolute path to logo file
  --overviewImagePath=<value>  URL or absolute path to overview image file
  --playbookFamily=<value>     Playbook Family (e.g. classic | canvas)
  --playbookName=<value>       Playbook Name (e.g. Text Aggregator)
  --sspPath=<value>            absolute path to .ssp file

DESCRIPTION
  Scaffold a new playbook

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

sw-tsdk-connector playbook:ssp

Update an SSP

USAGE
  $ sw-tsdk-connector playbook:ssp [-d <value>] [-n <value>] [-p <value>] [-h]

FLAGS
  -d, --directory=<value>     [default: ./] root directory of the playbook folder.
  -h, --help                  Show CLI help.
  -n, --playbookName=<value>  Playbook Name (e.g. text_aggregator)
  -p, --sspPath=<value>       Absolute path to .SSP file

DESCRIPTION
  Update an SSP

See code: lib/commands/playbook/ssp.js

sw-tsdk-connector solution:create

Scaffold a new Solution

USAGE
  $ sw-tsdk-connector solution:create [-d <value>] [--solutionFamily <value>] [--solutionName <value>] [--description
    <value>] [--logoPath <value>] [--sspPath <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>]
    [-h]

FLAGS
  -d, --directory=<value>   [default: ./] root directory for where to store Solution.
  -h, --help                Show CLI help.
  --author=<value>          Solution Author
  --authorEmail=<value>     Solution Author Email
  --description=<value>     Description (e.g. SOC Solution Description)
  --homepage=<value>        Solution Author Support URL
  --logoPath=<value>        URL or absolute path to logo file
  --solutionFamily=<value>  Solution Family (e.g. classic | canvas)
  --solutionName=<value>    Solution Name (e.g. SOC Solution)
  --sspPath=<value>         absolute path to .ssp file

DESCRIPTION
  Scaffold a new Solution

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

sw-tsdk-connector solution:logo

Update a Solution logo.

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

FLAGS
  -d, --directory=<value>     [default: ./] root directory of the solution folder.
  -h, --help                  Show CLI help.
  -n, --solutionName=<value>  Solution Name (e.g. soc_solution)
  -p, --logoPath=<value>      path or URL to product logo
  -t, --solutionType=<value>  Solution Type (e.g. classic)

DESCRIPTION
  Update a Solution logo.

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

sw-tsdk-connector solution:ssp

Update an SSP.

USAGE
  $ sw-tsdk-connector solution:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]

FLAGS
  -d, --directory=<value>     [default: ./] root directory of the solution folder.
  -h, --help                  Show CLI help.
  -n, --solutionName=<value>  Solution Name (e.g. soc_solution)
  -p, --sspPath=<value>       Absolute path to .SSP file
  -t, --solutionType=<value>  Solution Type (e.g. classic)

DESCRIPTION
  Update an SSP.

See code: lib/commands/solution/ssp.js