@flowcore/cli-plugin-scenario
v2.9.1
Published
A Flowcore CLI plugin for working with Scenarios in the Flowcore Platform
Downloads
371
Readme
Flowcore CLI Plugin - Scenario
A Flowcore CLI plugin for working with Scenarios in the Flowcore Platform
Usage
$ npm install -g @flowcore/cli-plugin-scenario
$ scenario COMMAND
running command...
$ scenario (--version)
@flowcore/cli-plugin-scenario/2.6.1 darwin-arm64 node-v18.18.0
$ scenario --help [COMMAND]
USAGE
$ scenario COMMAND
...
Commands
scenario scenario apply
scenario scenario generate manifest
scenario scenario generate transformer
scenario scenario local
scenario scenario apply
Apply a manifest configuration for a Scenario to the Flowcore Platform
USAGE
$ scenario scenario apply -f <value> [--profile <value>] [-d] [-n <value>] [-t <value>] [-y]
FLAGS
-d, --[no-]deploy deploy the scenario after applying
-f, --file=<value>... (required) file to apply
-n, --name=<value> name of the scenario to apply
-t, --tenant=<value> tenant to apply the scenario to, this is the org for your organization, it can be seen in the
url when accessing your organization
-y, --yes skip confirmation
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Apply a manifest configuration for a Scenario to the Flowcore Platform
EXAMPLES
$ scenario scenario apply -t flowcore -f example.yaml
$ scenario scenario apply -t flowcore -n scenario-name -f example.yaml
$ cat <<EOF | scenario scenario apply -f -
See code: src/commands/scenario/apply.ts
scenario scenario generate manifest
Generate a scenario manifest
USAGE
$ scenario scenario generate manifest -t <value> [--profile <value>] [-f <value>] [-n <value>] [-o] [--placeholder]
FLAGS
-f, --file=<value> file to apply
-n, --name=<value> name of the scenario to generate
-o, --overwrite overwrite the existing scenario
-t, --tenant=<value> (required) tenant to apply the scenario to, this is the org for your organization, it can be
seen in the url when accessing your organization
--placeholder generate a placeholder manifest
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Generate a scenario manifest
EXAMPLES
$ scenario scenario generate manifest -t flowcore
$ scenario scenario generate manifest -t flowcore --placeholder
$ scenario scenario generate manifest -t flowcore -f example.yaml
$ scenario scenario generate manifest -t flowcore -n scenario-name -f example.yaml
See code: src/commands/scenario/generate/manifest.ts
scenario scenario generate transformer
add a transformer to a scenario manifest
USAGE
$ scenario scenario generate transformer [--profile <value>] [-d <value>] [-f <value>] [-n <value>]
FLAGS
-d, --description=<value> description of the transformer
-f, --file=<value> file to modify
-n, --name=<value> name of the transformer to generate
--profile=<value> Specify the configuration profile to use
DESCRIPTION
add a transformer to a scenario manifest
EXAMPLES
$ scenario scenario generate transformer -n flow-type-name
$ scenario scenario generate transformer -n flow-type-name -d "description of the transformer"
$ scenario scenario generate transformer -n flow-type-name -d "description of the transformer" -f example.yaml
See code: src/commands/scenario/generate/transformer.ts
scenario scenario local
Spin up local stream threads based on a scenario manifest
USAGE
$ scenario scenario local -e <value> -f <value> [--profile <value>] [-H <value>] [-m http] [-c] [-s <value>] [-t
<value>] [-y]
FLAGS
-H, --header=<value>... [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN')
-c, --scan Scan the full time range
-e, --endpoint=<value> (required) stream endpoint
-f, --file=<value>... (required) file to apply
-m, --mode=<option> [default: http] stream mode
<options: http>
-s, --start=<value> Start time bucket to stream from, example: (1y, 1m, 1w, 1d, 1h, now)
-t, --timeout=<value> [default: 5000] Timeout in milliseconds to wait for a response from the destination
-y, --yes skip confirmation
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Spin up local stream threads based on a scenario manifest
EXAMPLES
$ scenario scenario local -f example.yaml
$ cat <<EOF | scenario scenario local -f -
See code: src/commands/scenario/local.ts