# @swsdk/plugin-task

> Plugin for managing integration tasks.

Latest version **5.6.0** (published 2024-02-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install @swsdk/plugin-task
pnpm add @swsdk/plugin-task
yarn add @swsdk/plugin-task
bun add @swsdk/plugin-task
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.6.0 |
| Published | 2024-02-09 |
| First published | 2021-10-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 15 |
| Unpacked size | 76.9 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Swimlane |
| Maintainers | swimlane.dev, mr_charlie |
| Keywords | oclif-plugin |

## Links

- npm: https://www.npmjs.com/package/@swsdk/plugin-task
- Repository: https://github.com/swimlane/swimlane-sdk-cli
- Homepage: https://github.com/swimlane/swimlane-sdk-cli#readme
- Issues: https://github.com/swimlane/swimlane-sdk-cli/issues
- npm.io page: https://npm.io/package/@swsdk/plugin-task

## Dependencies (15)

- [luxon](https://npm.io/package/luxon.md) 2.3.1
- [phone](https://npm.io/package/phone.md) 3.1.15
- [tslib](https://npm.io/package/tslib.md) 2.3.1
- [listr2](https://npm.io/package/listr2.md) 4.0.5
- [npmlog](https://npm.io/package/npmlog.md) 6.0.1
- [semver](https://npm.io/package/semver.md) 7.3.6
- [fs-extra](https://npm.io/package/fs-extra.md) 10.0.1
- [inquirer](https://npm.io/package/inquirer.md) 8.2.2
- [fast-glob](https://npm.io/package/fast-glob.md) 3.2.11
- [@oclif/core](https://npm.io/package/@oclif/core.md) 1.7.0
- [@swsdk/core](https://npm.io/package/@swsdk/core.md) ^5.6.0
- [noop-stream](https://npm.io/package/noop-stream.md) 1.0.0
- [@swsdk/common](https://npm.io/package/@swsdk/common.md) ^5.6.0
- [@swsdk/docker](https://npm.io/package/@swsdk/docker.md) ^5.6.0
- [inquirer-autocomplete-prompt](https://npm.io/package/inquirer-autocomplete-prompt.md) 2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 5.6.0 (latest) — 2024-02-09
- 5.4.1-next.39 (next) — 2022-08-11
- 5.5.0 — 2022-09-06
- 5.4.1-next.38 — 2022-08-10
- 5.4.1-next.36 — 2022-08-07
- 5.4.1-next.34 — 2022-08-04
- 5.4.1-next.33 — 2022-08-04
- 5.4.1-next.30 — 2022-07-28
- 5.4.1-next.24 — 2022-07-07
- 5.4.0 — 2022-07-07
- 5.3.4-next.19 — 2022-07-06
- 5.3.4-next.18 — 2022-07-05
- 5.3.4-next.17 — 2022-06-29
- 5.3.4-next.16 — 2022-06-29
- 5.3.4-next.14 — 2022-06-28
- … 48 more at https://npm.io/package/@swsdk/plugin-task/versions

## README

Integration Task CLI Plugin
============
![Swimlane Logo](https://swimlane.com/assets/images/swimlane-svg-logo.svg)

[![Version](https://img.shields.io/npm/v/@swsdk/plugin-task)](https://npmjs.org/package/@swsdk/plugin-task)
[![Downloads/week](https://img.shields.io/npm/dw/@swsdk/plugin-task)](https://npmjs.org/package/@swsdk/plugin-task)
[![License](https://img.shields.io/npm/l/@swsdk/plugin-task)](https://github.com/swimlane/swimlane-sdk-cli/blob/main/packages/cli/package.json)
<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`swsdk-task task:generate-inputs`](#swsdk-task-taskgenerate-inputs)
* [`swsdk-task task:generate-outputs`](#swsdk-task-taskgenerate-outputs)
* [`swsdk-task task:run`](#swsdk-task-taskrun)
* [`swsdk-task task:scaffold-task`](#swsdk-task-taskscaffold-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](https://github.com/swimlane/swimlane-sdk-cli/blob/v5.6.0/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](https://github.com/swimlane/swimlane-sdk-cli/blob/v5.6.0/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](https://github.com/swimlane/swimlane-sdk-cli/blob/v5.6.0/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](https://github.com/swimlane/swimlane-sdk-cli/blob/v5.6.0/lib/commands/task/scaffold-task.js)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@swsdk/plugin-task · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
