@swsdk/plugin-task v5.6.0

Integration Task CLI Plugin

• Usage
• Commands

Usage

$ npm install -g @swsdk/plugin-task
$ swsdk-task COMMAND
running command...
$ swsdk-task (--version)
@swsdk/plugin-task/5.6.0 darwin-arm64 node-v16.20.2
$ swsdk-task --help [COMMAND]
USAGE
  $ swsdk-task COMMAND
...

Commands

• swsdk-task task:generate-inputs
• swsdk-task task:generate-outputs
• swsdk-task task:run
• swsdk-task task:scaffold-task

swsdk-task task:generate-inputs

Generate task manifest inputs from test data.

USAGE
  $ swsdk-task task:generate-inputs [-n <value>] [-d <value>] [--inputs <value>] [-a] [-p] [-h]

FLAGS
  -a, --append             append new inputs to existing.
  -d, --directory=<value>  [default: ./] root directory of the repository.
  -h, --help               Show CLI help.
  -n, --name=<value>       task name to generate inputs.
  -p, --interactive        prompts to add description and required for each input.
  --inputs=<value>         input data as JSON

DESCRIPTION
  Generate task manifest inputs from test data.

See code: lib/commands/task/generate-inputs.js

swsdk-task task:generate-outputs

Generate a task manifest outputs from test data.

USAGE
  $ swsdk-task task:generate-outputs [-n <value>] [-d <value>] [--outputs <value>] [-a] [-h]

FLAGS
  -a, --append             append new outputs to existing.
  -d, --directory=<value>  [default: ./] root directory of the repository.
  -h, --help               Show CLI help.
  -n, --name=<value>       task name to generate outputs.
  --outputs=<value>        Filename to write JSON outputs, defaults to the task "name". ie: data/name_outputs.json

DESCRIPTION
  Generate a task manifest outputs from test data.

See code: lib/commands/task/generate-outputs.js

swsdk-task task:run

Use to test a task in an integration

USAGE
  $ swsdk-task task:run --asset <value> [-h] [-i <value> | -v 3.6|3.7|3.12] [-n <value>] [-d <value>] [-g]
    [--inputs <value>] [-t <value>] [-s] [-f] [-d code] [--pycharm-host <value>] [--pycharm-port <value>]

FLAGS
  -d, --debug=<option>           enable debugging
                                 <options: code>
  -d, --directory=<value>        [default: ./] current directory to mount
  -f, --force-rebuild            forces nocache on the image build
  -g, --generate                 generates the asset and input files in the current directory
  -h, --help                     Show CLI help.
  -i, --image=<value>            image to use
  -n, --name=<value>             task name to run
  -s, --skip-pull                skips pulling the image
  -t, --generate-test=<value>    Generate a test case using this run. Provide the name of the test
  -v, --python-version=<option>  [default: 3.6] python version to use
                                 <options: 3.6|3.7|3.12>
  --asset=<value>                (required) [default: data/asset.json] asset json
  --inputs=<value>               Filename for JSON inputs, defaults to the task name under the data folder. ie:
                                 data/my_task.json
  --pycharm-host=<value>         [default: host.docker.internal] pycharm debugging host
  --pycharm-port=<value>         [default: 30000] pycharm debugging port

DESCRIPTION
  Use to test a task in an integration

See code: lib/commands/task/run.js

swsdk-task task:scaffold-task

Use to scaffold a new task in an integration.

USAGE
  $ swsdk-task task:scaffold-task [-d <value>] [-h] [-n <value>] [--copy-task <value> | --new] [--description <value>]

FLAGS
  -d, --directory=<value>  [default: ./] directory to scaffold
  -h, --help               Show CLI help.
  -n, --name=<value>       task name
  --copy-task=<value>      name of the task to copy
  --description=<value>    description (e.g. CrowdStrike Host Query API)
  --new                    generates a new task

DESCRIPTION
  Use to scaffold a new task in an integration.

See code: lib/commands/task/scaffold-task.js