0.1.1-next.6 • Published 2 years ago

@swimlane/turbine-developer-kit v0.1.1-next.6

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Swimlane Integrations CLI (SDK)

Version Downloads/week License

Requirements

Installation

npm install -g @swimlane/swimlane-sdk@latest

Usage

$ npm install -g @swimlane/turbine-developer-kit
$ swtdk COMMAND
running command...
$ swtdk (--version|-v)
@swimlane/turbine-developer-kit/0.1.1-next.8+da1ed2b darwin-x64 node-v16.14.0
$ swtdk --help [COMMAND]
USAGE
  $ swtdk COMMAND
...

Commands

swtdk action add

Update a connector action.

USAGE
  $ swtdk action add [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [-h]

FLAGS
  -d, --directory=<value>  [default: ./] Root directory of the repository.
  -h, --help               Show CLI help.
  -t, --template=<option>  [default: python_310_definition] action template to scaffold
                           <options: node_18|python_310_definition|python_3.7_swimlane>

DESCRIPTION
  Update a connector action.

swtdk action input

Update action input schema.

USAGE
  $ swtdk action 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.

swtdk action output

Update a connector action.

USAGE
  $ swtdk action 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.

swtdk action run

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

USAGE
  $ swtdk action run [-a <value>] [-d <value>] [--input-path <value>] [--output-path <value>] [--error-path
    <value>] [--asset-path <value>] [-i <value> | --build | --latest] [--template
    python_3.7|node_18|python_310_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.
  -i, --image=<value>      The connector image to run.
  --asset-path=<value>     File to asset data JSON file, defaults to /data/asset.json
  --build                  Builds image and runs it.
  --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
  --latest                 Use the latest release image from quay.
  --output-path=<value>    File to write the outputs to, defaults to /data/<action>_output.json
  --template=<option>      [default: python_310_definition] connector template
                           <options: python_3.7|node_18|python_310_definition>

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

swtdk asset add

Update a connector action.

USAGE
  $ swtdk asset add [-d <value>] [-s custom|apikey_header|client_credentials|basic|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_header|client_credentials|basic|bearer>

DESCRIPTION
  Update a connector action.

swtdk autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ swtdk autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ swtdk autocomplete

  $ swtdk autocomplete bash

  $ swtdk autocomplete zsh

  $ swtdk autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

swtdk commands

list all the commands

USAGE
  $ swtdk commands [--json] [-h] [--hidden] [--columns <value> | -x] [--sort <value>] [--filter <value>]
    [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help         Show CLI help.
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

swtdk connector build

Builds a local docker image of the connector.

USAGE
  $ swtdk connector build --template python_3.7_swimlane|node_18|python_310_definition [-d <value>] [--save] [-f] [-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.
  --save                   saves docker image as tar in local directory.
  --template=<option>      (required) [default: python_310_definition] connector language
                           <options: python_3.7_swimlane|node_18|python_310_definition>

DESCRIPTION
  Builds a local docker image of the connector.

swtdk connector create

Scaffold a new connector

USAGE
  $ swtdk connector create [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [--skip-repo] [-h]

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_310_definition] connector template to scaffold
                           <options: node_18|python_310_definition|python_3.7_swimlane>
  --skip-repo              skips the repository creation process

DESCRIPTION
  Scaffold a new connector

swtdk connector create-source

Generates 11x source from 10x

USAGE
  $ swtdk 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

swtdk connector logo

Update a connector.

USAGE
  $ swtdk 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.

swtdk connector save

Save a docker image locally as .tar.gz

USAGE
  $ swtdk connector save -o <value> -i <value> [-d <value>] [-s] [-h]

FLAGS
  -d, --directory=<value>  [default: .] Root directory of the repo.
  -h, --help               Show CLI help.
  -i, --image=<value>      (required) image to save.
  -o, --output=<value>     (required) output file to where to store the image.
  -s, --skip-pull          skips pulling the image

DESCRIPTION
  Save a docker image locally as .tar.gz

swtdk connector update

Update a connector.

USAGE
  $ swtdk 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.

swtdk connector validate

Use to validate an integration

USAGE
  $ swtdk connector validate -c <value> [-h] [-i <value>] [-s] [-d <value>]

FLAGS
  -c, --connector=<value>  (required) 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

DESCRIPTION
  Use to validate an integration

swtdk help [COMMAND]

Display help for swtdk.

USAGE
  $ swtdk help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for swtdk.

See code: @oclif/plugin-help

swtdk plugins

List installed plugins.

USAGE
  $ swtdk plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ swtdk plugins

See code: @oclif/plugin-plugins

swtdk plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ swtdk plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ swtdk plugins add

EXAMPLES
  $ swtdk plugins:install myplugin 

  $ swtdk plugins:install https://github.com/someuser/someplugin

  $ swtdk plugins:install someuser/someplugin

swtdk plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ swtdk plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ swtdk plugins:inspect myplugin

swtdk plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ swtdk plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ swtdk plugins add

EXAMPLES
  $ swtdk plugins:install myplugin 

  $ swtdk plugins:install https://github.com/someuser/someplugin

  $ swtdk plugins:install someuser/someplugin

swtdk plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ swtdk plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ swtdk plugins:link myplugin

swtdk plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ swtdk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swtdk plugins unlink
  $ swtdk plugins remove

swtdk plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ swtdk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swtdk plugins unlink
  $ swtdk plugins remove

swtdk plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ swtdk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swtdk plugins unlink
  $ swtdk plugins remove

swtdk plugins update

Update installed plugins.

USAGE
  $ swtdk plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

swtdk turbine connector push

Use to push an integration to Turbine

USAGE
  $ swtdk turbine connector push -f <value> --turbine-url <value> [-u <value>] [-p <value>] [-h]

FLAGS
  -f, --file=<value>      (required) path of the file to be uploaded to Turbine
  -h, --help              Show CLI help.
  -p, --password=<value>  Turbine password
  -u, --username=<value>  Turbine username
  --turbine-url=<value>   (required) the url of the turbine instance [https://turbine.acme.com]

DESCRIPTION
  Use to push an integration to Turbine

swtdk turbine login

Use to login to Turbine

USAGE
  $ swtdk turbine login --turbine-url <value> [-u <value>] [-p <value>] [-h]

FLAGS
  -h, --help              Show CLI help.
  -p, --password=<value>  Turbine password
  -u, --username=<value>  Turbine username
  --turbine-url=<value>   (required) the url of the turbine instance [https://turbine.acme.com]

DESCRIPTION
  Use to login to Turbine

swtdk version

USAGE
  $ swtdk version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

swtdk which

Show which plugin a command is in.

USAGE
  $ swtdk which

DESCRIPTION
  Show which plugin a command is in.

See code: @oclif/plugin-which

Roles and Works

  1. Person Develop and Submit Release Pull Request
  2. Team Review Release Pull Request
  3. CI Publish

Release Flow

  1. Local Checkout release branch: git checkout release/<uniq>
  2. Local Run yarn run versionup
    • Update CHANGELOG.md and package.json's version, and lerna.json's version
    • It does not git tag
  3. Local Submit to Release Pull Request
  4. GitHub Review Release Pull Request
  5. GitHub Write Release Note into the Release Pull Request's body
  6. GitHub Merge Release Pull Request
  7. CI Create git tag && Create GitHub Release && publish to npm(GitHub Package Registry)
    • :memo: The GitHub Release's body is copied from Release Pull Request's body

Quickstart

See Quickstart

Contributing

See Contributing

Testing

See Integration Tests

swimlaneturbine-developer-kit
@oclif/core@oclif/plugin-autocomplete@oclif/plugin-commands@oclif/plugin-help@oclif/plugin-legacy@oclif/plugin-not-found@oclif/plugin-plugins@oclif/plugin-update@oclif/plugin-version@oclif/plugin-warn-if-update-available@oclif/plugin-which@swtdk/core@swtdk/plugin-connector@swtdk/plugin-turbinefs-extrainquirernpmlogtslib
@infinitebrahmanuniverse/nolb-_swi@everything-registry/sub-chunk-887@zalastax/nolb-_swi
0.1.1-next.21

2 years ago

0.1.1-next.20

2 years ago

0.1.1-next.19

2 years ago

0.1.1-next.18

2 years ago

0.1.1-next.15

2 years ago

0.1.1-next.14

2 years ago

0.1.1-next.13

2 years ago

0.1.1-next.10

2 years ago

0.1.1-next.9

2 years ago

0.1.1-next.8

2 years ago

0.1.1-next.6

2 years ago