@flowcore/cli NPM

Flowcore CLI

Flowcore CLI is a command line interface for interacting with the Flowcore Platform.

Usage

$ npm install -g @flowcore/cli
$ flowcore COMMAND
running command...
$ flowcore (--version)
@flowcore/cli/2.12.0 darwin-arm64 node-v18.18.0
$ flowcore --help [COMMAND]
USAGE
  $ flowcore COMMAND
...

Commands

`flowcore apply`

Apply a resource manifest against the Flowcore Platform

USAGE
  $ flowcore apply -f <value> [--profile <value>] [-y]

FLAGS
  -f, --file=<value>...  (required) file to apply
  -y, --yes              skip confirmation
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Apply a resource manifest against the Flowcore Platform

EXAMPLES
  $ flowcore apply -f ./path/to/manifest.yml

See code: src/commands/apply.ts

`flowcore autocomplete [SHELL]`

Display autocomplete installation instructions.

USAGE
  $ flowcore autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

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

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ flowcore autocomplete

  $ flowcore autocomplete bash

  $ flowcore autocomplete zsh

  $ flowcore autocomplete powershell

  $ flowcore autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`flowcore config set`

Configure the cli

USAGE
  $ flowcore config set [--profile <value>] [-b <value>] [-c <value>] [-n <value>] [-l <value>] [-p] [-u <value>]

FLAGS
  -b, --baseUrl=<value>       base url to the flowcore platform
  -c, --clientId=<value>      client id to use for the login
  -l, --loginUrl=<value>      url to discover the openid configuration
  -n, --clientSecret=<value>  name to print
  -p, --port                  prompt for port to listen for the callback
  -u, --url=<value>           url to the flowcore platform api
      --profile=<value>       Specify the configuration profile to use

DESCRIPTION
  Configure the cli

EXAMPLES
  $ flowcore config set -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -s my-client-secret

  $ flowcore config set -u https://graph.api.flowcore.io/graphql

  $ flowcore config set -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration -c my-client-id -p

See code: @flowcore/cli-plugin-config

`flowcore config show`

Show the configured login url

USAGE
  $ flowcore config show [--profile <value>]

FLAGS
  --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Show the configured login url

EXAMPLES
  $ flowcore config show

See code: @flowcore/cli-plugin-config

`flowcore data-core apply`

Apply a manifest configuration for a Data Core to the Flowcore Platform

USAGE
  $ flowcore data-core apply -f <value> [--profile <value>] [-n <value>] [-t <value>] [-y]

FLAGS
  -f, --file=<value>...  (required) file to apply
  -n, --name=<value>     name of the data core to apply
  -t, --tenant=<value>   tenant to apply the data core 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 Data Core to the Flowcore Platform

EXAMPLES
  $ flowcore data-core apply -t flowcore -f example.yaml

  $ flowcore data-core apply -t flowcore -n data-core-name -f example.yaml

  $ cat <<EOF | flowcore data-core apply -f -

See code: @flowcore/cli-plugin-data-core

`flowcore data-core generate event-type FLOWTYPE`

add a event type to a data core manifest

USAGE
  $ flowcore data-core generate event-type FLOWTYPE [--profile <value>] [-d <value>] [-f <value>] [-n <value>]

FLAGS
  -d, --description=<value>  description of the event type
  -f, --file=<value>         file to modify
  -n, --name=<value>         name of the event type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a event type to a data core manifest

EXAMPLES
  $ flowcore data-core generate event-type flow-type-name -n event-type-name

  $ flowcore data-core generate event-type flow-type-name -n event-type-name -d "description of the event type"

  $ flowcore data-core generate event-type flow-type-name -n event-type-name -d "description of the event type" -f example.yaml

See code: @flowcore/cli-plugin-data-core

`flowcore data-core generate flow-type`

add a flow type to a data core manifest

USAGE
  $ flowcore data-core generate flow-type [--profile <value>] [-d <value>] [-f <value>] [-n <value>]

FLAGS
  -d, --description=<value>  description of the flow type
  -f, --file=<value>         file to modify
  -n, --name=<value>         name of the flow type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a flow type to a data core manifest

EXAMPLES
  $ flowcore data-core generate flow-type -n flow-type-name

  $ flowcore data-core generate flow-type -n flow-type-name -d "description of the flow type"

  $ flowcore data-core generate flow-type -n flow-type-name -d "description of the flow type" -f example.yaml

See code: @flowcore/cli-plugin-data-core

`flowcore data-core generate manifest`

Generate a data core manifest

USAGE
  $ flowcore data-core 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 data core to generate
  -o, --overwrite        overwrite the existing data core
  -t, --tenant=<value>   (required) tenant to apply the data core 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 data core manifest

EXAMPLES
  $ flowcore data-core generate manifest -t flowcore

  $ flowcore data-core generate manifest -t flowcore --placeholder

  $ flowcore data-core generate manifest -t flowcore -f example.yaml

  $ flowcore data-core generate manifest -t flowcore -n data-core-name -f example.yaml

See code: @flowcore/cli-plugin-data-core

`flowcore help [COMMANDS]`

Display help for flowcore.

USAGE
  $ flowcore help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for flowcore.

See code: @oclif/plugin-help

`flowcore login`

USAGE
  $ flowcore login [--profile <value>] [-p <value>]

FLAGS
  -p, --port=<value>     [default: 3000] port to listen for the callback
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  login to the Flowcore Platform

EXAMPLES
  $ flowcore login

  $ flowcore login --port 8080

See code: @flowcore/cli-plugin-config

`flowcore plugins`

List installed plugins.

USAGE
  $ flowcore plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ flowcore plugins

See code: @oclif/plugin-plugins

`flowcore plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ flowcore plugins add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

GLOBAL FLAGS
  --json  Format output as json.

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
  $ flowcore plugins add

EXAMPLES
  $ flowcore plugins add myplugin 

  $ flowcore plugins add https://github.com/someuser/someplugin

  $ flowcore plugins add someuser/someplugin

`flowcore plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ flowcore plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ flowcore plugins inspect myplugin

See code: @oclif/plugin-plugins

`flowcore plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ flowcore plugins install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

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

GLOBAL FLAGS
  --json  Format output as json.

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
  $ flowcore plugins add

EXAMPLES
  $ flowcore plugins install myplugin 

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

  $ flowcore plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`flowcore plugins:link PLUGIN`

Links a plugin into the CLI for development.

USAGE
  $ flowcore plugins link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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
  $ flowcore plugins link myplugin

See code: @oclif/plugin-plugins

`flowcore plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ flowcore plugins remove plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ flowcore plugins unlink
  $ flowcore plugins remove

EXAMPLES
  $ flowcore plugins remove myplugin

`flowcore plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ flowcore plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

`flowcore plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ flowcore plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ flowcore plugins unlink
  $ flowcore plugins remove

EXAMPLES
  $ flowcore plugins uninstall myplugin

See code: @oclif/plugin-plugins

`flowcore plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ flowcore plugins unlink plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ flowcore plugins unlink
  $ flowcore plugins remove

EXAMPLES
  $ flowcore plugins unlink myplugin

`flowcore plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

`flowcore scenario apply`

Apply a manifest configuration for a Scenario to the Flowcore Platform

USAGE
  $ flowcore 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
  $ flowcore scenario apply -t flowcore -f example.yaml

  $ flowcore scenario apply -t flowcore -n scenario-name -f example.yaml

  $ cat <<EOF | flowcore scenario apply -f -

See code: @flowcore/cli-plugin-scenario

`flowcore scenario generate manifest`

Generate a scenario manifest

USAGE
  $ flowcore 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
  $ flowcore scenario generate manifest -t flowcore

  $ flowcore scenario generate manifest -t flowcore --placeholder

  $ flowcore scenario generate manifest -t flowcore -f example.yaml

  $ flowcore scenario generate manifest -t flowcore -n scenario-name -f example.yaml

See code: @flowcore/cli-plugin-scenario

`flowcore scenario generate transformer`

add a transformer to a scenario manifest

USAGE
  $ flowcore 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
  $ flowcore scenario generate transformer -n flow-type-name

  $ flowcore scenario generate transformer -n flow-type-name -d "description of the transformer"

  $ flowcore scenario generate transformer -n flow-type-name -d "description of the transformer" -f example.yaml

See code: @flowcore/cli-plugin-scenario

`flowcore scenario local`

Spin up local stream threads based on a scenario manifest

USAGE
  $ flowcore 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
  $ flowcore scenario local -f example.yaml

  $ cat <<EOF | flowcore scenario local -f -

See code: @flowcore/cli-plugin-scenario

`flowcore stream STREAM`

Stream events from a datacore running on the Flowcore Platform

USAGE
  $ flowcore stream STREAM [--profile <value>] [-j] [-l] [-m <value>] [-o http|log] [-p] [-c] [-s <value>]
    [-d <value>] [-H <value>] [-t <value>]

ARGUMENTS
  STREAM  stream url to connect to

FLAGS
  -H, --header=<value>...    [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN')
  -c, --scan                 Scan the full time range
  -d, --destination=<value>  [default: http://localhost:3000/transform] Destination to send events to
  -j, --json                 Output json only
  -l, --[no-]live            Change to live mode when reaching last time bucket
  -m, --max=<value>          Maximum number of events to send to the destination
  -o, --output=<option>      [default: http] Output format
                             <options: http|log>
  -p, --payload              Only send the event payload to the destination
  -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
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  Stream events from a datacore running on the Flowcore Platform

EXAMPLES
  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream

  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -s 1y

  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream -o log -s 3m --json > some.json

  $ flowcore stream https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream -o log -s 3m

See code: @flowcore/cli-plugin-core

`flowcore version`

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

`flowcore whoami`

Check what user you are logged in as

USAGE
  $ flowcore whoami [--profile <value>]

FLAGS
  --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Check what user you are logged in as

See code: @flowcore/cli-plugin-config

flowcore cli flowcore-cli streaming events data