@swsdk/plugin-integration
v5.6.0
Published
Admin Plugin for managing integration
Downloads
2,493
Readme
Integration CLI Plugin
Usage
$ npm install -g @swsdk/plugin-integration
$ swsdk-integration COMMAND
running command...
$ swsdk-integration (--version)
@swsdk/plugin-integration/5.6.0 darwin-arm64 node-v16.20.2
$ swsdk-integration --help [COMMAND]
USAGE
$ swsdk-integration COMMAND
...
Commands
swsdk-integration integration:build
swsdk-integration integration:create-pr
swsdk-integration integration:lint
swsdk-integration integration:pre-commit
swsdk-integration integration:scaffold
swsdk-integration integration:test
swsdk-integration integration:update
swsdk-integration integration:validate
swsdk-integration integration:build
Use to build an integration (.swimbundle)
USAGE
$ swsdk-integration integration:build [-h] [-i <value> | -v 3.6|3.7|3.12] [-d <value>] [-s]
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
-v, --python-version=<option> [default: 3.6] python version to use
<options: 3.6|3.7|3.12>
DESCRIPTION
Use to build an integration (.swimbundle)
See code: lib/commands/integration/build.js
swsdk-integration integration:create-pr
Use to create a PR for an integration
USAGE
$ swsdk-integration integration:create-pr -t <value> [-h] [-d <value>] [-b <value>] [-d <value>] [-o <value>] [--draft]
[-n <value>] [-r <value>]
FLAGS
-b, --branch=<value> The name branch
-d, --description=<value> description of the pull request
-d, --directory=<value> [default: ./] current directory to mount
-h, --help Show CLI help.
-n, --name=<value> GitHub repository
-o, --organization=<value> [default: swimlane] GitHub organization
-r, --reviewer=<value>... [default: swimlane/surf] GitHub user for the PR review
-t, --title=<value> (required) name of the pull request
--draft create the PR as a draft
DESCRIPTION
Use to create a PR for an integration
See code: lib/commands/integration/create-pr.js
swsdk-integration integration:lint
Use to validate source code through static analysis
USAGE
$ swsdk-integration integration:lint -t <value> [-h] [-i <value>] [-s] [-v] [-d <value>]
FLAGS
-d, --directory=<value> [default: ./] current directory to mount
-h, --help Show CLI help.
-i, --image=<value> [default: docker.io/codacy/codacy-analysis-cli] image to use
-s, --skip-pull skips pulling the image
-t, --tool=<value>... (required) [default: bandit,jackson-linter,prospector,pylint-python3,remark-lint] plugins
used in analysis (https://docs.codacy.com/repositories-configure/codacy-configuration-file/#w
hich-tools-can-be-configured-and-which-name-should-i-use)
-v, --verbose verbose logging
DESCRIPTION
Use to validate source code through static analysis
See code: lib/commands/integration/lint.js
swsdk-integration integration:pre-commit
Use to install a pre-commit hook on an integration, if the hook is already installed will be updated.
USAGE
$ swsdk-integration integration:pre-commit [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
Use to install a pre-commit hook on an integration, if the hook is already installed will be updated.
See code: lib/commands/integration/pre-commit.js
swsdk-integration integration:scaffold
Use to scaffold a new integration
USAGE
$ swsdk-integration integration:scaffold [-d <value>] [-i <value>] [-h] [--vendor <value>] [--product <value>] [--family
Investigation|Endpoint Security & Management|Network Security & Management|Communication|SIEM & Log
Management|Governance & Risk Management|Vulnerability & Patch Management|Ticket Management|DevOps & Application
Security|Identity & Access Management|Infrastructure|Miscellaneous] [--description <value>] [--logoPath <value>]
[--requirements <value>] [--use-rest-template] [--generate-examples] [--supported-swimlane-version <value>]
[--author <value>] [--author-email <value>] [--url <value>]
FLAGS
-d, --directory=<value> [default: ./] directory to scaffold
-h, --help Show CLI help.
-i, --input-config=<value> input config file
--author=<value> Integration Author
--author-email=<value> Integration Author Email
--description=<value> Description (e.g. CrowdStrike Host Query API)
--family=<option> Integration Family
<options: Investigation|Endpoint Security & Management|Network Security &
Management|Communication|SIEM & Log Management|Governance & Risk
Management|Vulnerability & Patch Management|Ticket Management|DevOps &
Application Security|Identity & Access Management|Infrastructure|Miscellaneous>
--generate-examples Generate example code
--logoPath=<value> URL or absolute path to logo file
--product=<value> Product (e.g. Falcon)
--requirements=<value> Requirements, comma separated (e.g. basic-rest-endpoint,pyflattener)
--supported-swimlane-version=<value> What is the supported Swimlane Version (>=10.3.0)
--url=<value> Author URL
--use-rest-template Use the basic rest template
--vendor=<value> Vendor (e.g. CrowdStrike)
DESCRIPTION
Use to scaffold a new integration
See code: lib/commands/integration/scaffold.js
swsdk-integration integration:test
Use to test an integration (.swimbundle)
USAGE
$ swsdk-integration integration:test [-h] [-i <value> | -v 3.6|3.7|3.12] [-d <value>] [-s] [-f]
[--report-portal-uuid <value> -r --report-portal-host <value> --report-portal-project <value>]
[--report-portal-launch <value> ]
FLAGS
-d, --directory=<value> [default: ./] current directory to mount
-f, --force-rebuild forces nocache on the image build
-h, --help Show CLI help.
-i, --image=<value> image to use
-r, --report-portal Send results to report portal
-s, --skip-pull skips pulling the image
-v, --python-version=<option> [default: 3.6] python version to use
<options: 3.6|3.7|3.12>
--report-portal-host=<value> Report Portal host.
--report-portal-launch=<value> Report Portal launch.
--report-portal-project=<value> Report Portal project.
--report-portal-uuid=<value> Report Portal UUID.
DESCRIPTION
Use to test an integration (.swimbundle)
See code: lib/commands/integration/test.js
swsdk-integration integration:update
Use to update the version or image of an integration
USAGE
$ swsdk-integration integration:update [-h] [-d <value>] [--logo-path <value>] [-v <value> | -t major|minor|patch |
--conventional-commits] [--preid <value> ] [--skip-commit ] [--dry-run] [--scaffold-pytest]
FLAGS
-d, --directory=<value> [default: ./] Current directory to mount
-h, --help Show CLI help.
-t, --type=<option> [default: patch] Increments based on the type
<options: major|minor|patch>
-v, --version=<value> Sets the current version
--conventional-commits Use conventional-changelog to determine version bump and generate CHANGELOG.
--dry-run Does not write the new version
--logo-path=<value> URL or absolute path to logo file
--preid=<value> [default: alpha] Specify the prerelease identifier when versioning a prerelease
--scaffold-pytest Create the directory structure for pytest.
--skip-commit If using conventional commits, this flag will skip committing the change
DESCRIPTION
Use to update the version or image of an integration
See code: lib/commands/integration/update.js
swsdk-integration integration:validate
Use to validate an integration
USAGE
$ swsdk-integration integration:validate [-h] [-i <value> | -v 3.6|3.7|3.12] [-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
-v, --python-version=<option> [default: 3.6] python version to use
<options: 3.6|3.7|3.12>
DESCRIPTION
Use to validate an integration
See code: lib/commands/integration/validate.js