@flowcore/cli

v4.18.1

Published

a month ago

Flowcore CLI for interacting with the Flowcore platform

0High
0Medium
0Low

jbiskur

suuunly

fjandin

flowcore cli flowcore-cli streaming events data

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/4.9.1 darwin-arm64 node-v20.15.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>] [--v2] [-y]

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

DESCRIPTION
  Apply a resource manifest against the Flowcore Platform

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

See code: src/commands/apply.ts

`flowcore auth delete key API_KEY_NAME`

Delete an API key

USAGE
  $ flowcore auth delete key API_KEY_NAME -t <value> [--profile <value>]

ARGUMENTS
  API_KEY_NAME  Name of the API key to delete

FLAGS
  -t, --tenant=<value>   (required) tenant where the API keys should be listed
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete an API key

EXAMPLES
  $ flowcore auth delete key --tenant=tenant-id <api-key-name>

See code: @flowcore/cli-plugin-auth-management

`flowcore auth delete secret SECRET_KEY`

Delete an organization secret

USAGE
  $ flowcore auth delete secret SECRET_KEY -t <value> [--profile <value>]

ARGUMENTS
  SECRET_KEY  Key of the secret to delete

FLAGS
  -t, --tenant=<value>   (required) tenant where the secret should be deleted
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete an organization secret

EXAMPLES
  $ flowcore auth delete secret --tenant=tenant-id <secret-key>

See code: @flowcore/cli-plugin-auth-management

`flowcore auth list key`

List all API keys

USAGE
  $ flowcore auth list key -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json             output the API key in JSON format
  -t, --tenant=<value>   (required) tenant where the API keys should be listed
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all API keys

EXAMPLES
  $ flowcore auth list key --tenant=tenant-id

See code: @flowcore/cli-plugin-auth-management

`flowcore auth list secret`

List all organization secrets

USAGE
  $ flowcore auth list secret -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json             output the secrets in JSON format
  -t, --tenant=<value>   (required) tenant where the secrets should be listed
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all organization secrets

EXAMPLES
  $ flowcore auth list secret --tenant=tenant-id

See code: @flowcore/cli-plugin-auth-management

`flowcore auth new key NAME`

Create a new API key

USAGE
  $ flowcore auth new key NAME -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the API key

FLAGS
  -j, --json             output the API key in JSON format
  -t, --tenant=<value>   (required) tenant where the API key should be created
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Create a new API key

EXAMPLES
  $ flowcore auth new key --tenant=tenant-id --name=key-name

See code: @flowcore/cli-plugin-auth-management

`flowcore auth new secret NAME`

Create a new secret for the tenant

USAGE
  $ flowcore auth new secret NAME -t <value> [--profile <value>] [--from-file <value>] [--from-literal <value>]

ARGUMENTS
  NAME  name of the secret

FLAGS
  -t, --tenant=<value>        (required) tenant where the secret should be created
      --from-file=<value>     read value from a file
      --from-literal=<value>  use literal value instead of reading from stdin
      --profile=<value>       Specify the configuration profile to use

DESCRIPTION
  Create a new secret for the tenant

EXAMPLES
  $ flowcore auth new secret --tenant=tenant-id --from-literal=value

See code: @flowcore/cli-plugin-auth-management

`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 ai`

AI Config

USAGE
  $ flowcore config ai [--profile <value>] [-a <value>] [-p <value>]

FLAGS
  -a, --apiKey=<value>    api key
  -p, --provider=<value>  provider
      --profile=<value>   Specify the configuration profile to use

DESCRIPTION
  AI Config

EXAMPLES
  $ flowcore

See code: @flowcore/cli-plugin-ai

`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>         [default: flowcore.yaml] 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>         [default: flowcore.yaml] 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 init`

Initialize a data core manifest

USAGE
  $ flowcore data-core init -t <value> [--profile <value>] [-f <value>] [-p] [-o]

FLAGS
  -f, --file=<value>     [default: flowcore.yaml] filename it will be created with, defaults to flowcore.yaml
  -o, --overwrite        overwrite the existing data core
  -p, --no-placeholders  use placeholders for the 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
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Initialize a data core manifest

EXAMPLES
  $ flowcore data-core init -t flowcore

  $ flowcore data-core init -t flowcore --placeholder

  $ flowcore data-core init -t flowcore -f example.yaml

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

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

`flowcore delete`

Delete a resource manifest from the Flowcore Platform

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

FLAGS
  -f, --file=<value>     (required) file that contains the resources to delete or '-' for stdin
  -y, --yes              skip confirmation
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Delete a resource manifest from the Flowcore Platform

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

  cat ./path/to/manifest.yml | flowcore delete -f -

See code: src/commands/delete.ts

`flowcore diff`

Diff a resource manifests against the Flowcore Platform

USAGE
  $ flowcore diff -f <value> [--profile <value>]

FLAGS
  -f, --file=<value>...  (required) file or directory to diff
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Diff a resource manifests against the Flowcore Platform

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

See code: src/commands/diff.ts

`flowcore generate nextjs-entity NAME`

Create a new NextJS entity using the Flowcore IDD approach

USAGE
  $ flowcore generate nextjs-entity NAME [--profile <value>]

ARGUMENTS
  NAME  name of the entity to generate

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

DESCRIPTION
  Create a new NextJS entity using the Flowcore IDD approach

EXAMPLES
  $ flowcore generate nextjs-entity my-entity

See code: @flowcore/cli-plugin-generator

`flowcore get adapter [ADAPTER]`

Get adapter

USAGE
  $ flowcore get adapter [ADAPTER] -s <value> -t <value> [--profile <value>]

ARGUMENTS
  ADAPTER  adapter name or id

FLAGS
  -s, --scenario=<value>  (required) scenario
  -t, --tenant=<value>    (required) tenant
      --profile=<value>   Specify the configuration profile to use

DESCRIPTION
  Get adapter

EXAMPLES
  $ flowcore get adapter -t tenant-name -s scenario-name

  $ flowcore get adapter adapter-name -t tenant-name -s scenario-name

See code: @flowcore/cli-plugin-scenario

`flowcore get scenario [SCENARIO]`

Get scenario

USAGE
  $ flowcore get scenario [SCENARIO] -t <value> [--profile <value>]

ARGUMENTS
  SCENARIO  scenario name

FLAGS
  -t, --tenant=<value>   (required) tenant
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Get scenario

EXAMPLES
  $ flowcore get scenario -t tenant-name

  $ flowcore get scenario scenario-name -t tenant-name

See code: @flowcore/cli-plugin-scenario

`flowcore get tenant [NAME]`

Get tenant

USAGE
  $ flowcore get tenant [NAME] [--profile <value>] [-j] [-t <value>]

ARGUMENTS
  NAME  name

FLAGS
  -j, --json             output in json
  -t, --tenant=<value>   tenant
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Get tenant

EXAMPLES
  $ flowcore get tenant

  $ flowcore get tenant --tenant=tenant-name

  $ flowcore get tenant --tenant=tenant-name --json

See code: @flowcore/cli-plugin-tenant-management

`flowcore help [COMMAND]`

Display help for flowcore.

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

See code: @oclif/plugin-help

`flowcore info`

Get information about the Flowcore CLI and its configuration

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

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

DESCRIPTION
  Get information about the Flowcore CLI and its configuration

EXAMPLES
  $ flowcore info

See code: src/commands/info.ts

`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 logs adapter ADAPTER`

Get adapter logs

USAGE
  $ flowcore logs adapter ADAPTER -s <value> -t <value> [--profile <value>] [-f] [-j] [-l <value>]

ARGUMENTS
  ADAPTER  adapter name or id

FLAGS
  -f, --follow            follow
  -j, --json              json
  -l, --limit=<value>     [default: 1000] limit
  -s, --scenario=<value>  (required) scenario
  -t, --tenant=<value>    (required) tenant
      --profile=<value>   Specify the configuration profile to use

DESCRIPTION
  Get adapter logs

EXAMPLES
  $ flowcore logs adapter adapter-name -t tenant-name -s scenario-name

  $ flowcore logs adapter adapter-name -t tenant-name -s scenario-name -f

  $ flowcore logs adapter adapter-name -t tenant-name -s scenario-name -l 100

  $ flowcore logs adapter adapter-name -t tenant-name -s scenario-name --json

See code: @flowcore/cli-plugin-scenario

`flowcore new bun-service NAME`

Create a new Bun service

USAGE
  $ flowcore new bun-service NAME [--profile <value>] [--no-flowcore]

ARGUMENTS
  NAME  name of the bun service

FLAGS
  --no-flowcore      do not use flowcore
  --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Create a new Bun service

EXAMPLES
  $ flowcore new bun-service my-service

  $ flowcore new bun-service my-service --no-flowcore

See code: @flowcore/cli-plugin-generator

`flowcore new generator NAME`

Create a new generator

USAGE
  $ flowcore new generator NAME [--profile <value>]

ARGUMENTS
  NAME  name of the generator

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

DESCRIPTION
  Create a new generator

EXAMPLES
  $ flowcore new generator my-generator

See code: @flowcore/cli-plugin-generator

`flowcore new nextjs-app NAME`

Create a new NextJS application using the Flowcore IDD approach

USAGE
  $ flowcore new nextjs-app NAME [--profile <value>]

ARGUMENTS
  NAME  name of the nextjs app

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

DESCRIPTION
  Create a new NextJS application using the Flowcore IDD approach

EXAMPLES
  $ flowcore new nextjs-app my-app

See code: @flowcore/cli-plugin-generator

`flowcore new plugin NAME`

Create a new plugin

USAGE
  $ flowcore new plugin NAME [--profile <value>]

ARGUMENTS
  NAME  name of the plugin

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

DESCRIPTION
  Create a new plugin

EXAMPLES
  $ flowcore new plugin my-plugin

See code: @flowcore/cli-plugin-generator

`flowcore new transformer NAME`

Create a new Bun transformer

USAGE
  $ flowcore new transformer NAME [--profile <value>] [--no-flowcore]

ARGUMENTS
  NAME  name of the bun transformer

FLAGS
  --no-flowcore      do not use flowcore
  --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Create a new Bun transformer

EXAMPLES
  $ flowcore new transformer my-transformer

  $ flowcore new transformer my-transformer --no-flowcore

See code: @flowcore/cli-plugin-generator

`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 add PLUGIN`

Installs a plugin into flowcore.

USAGE
  $ flowcore plugins add PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into flowcore.

  Uses npm to install plugins.

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

  Use the FLOWCORE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the FLOWCORE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ flowcore plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ flowcore plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

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

USAGE
  $ flowcore plugins install PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into flowcore.

  Uses npm to install plugins.

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

  Use the FLOWCORE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the FLOWCORE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ flowcore plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ flowcore plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ flowcore plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`flowcore plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ flowcore plugins link PATH [-h] [--install] [-v]

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 remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ flowcore plugins remove [PLUGIN] [-h] [-v]

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] [-h] [-v]

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 unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ flowcore plugins unlink [PLUGIN] [-h] [-v]

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 plugins update check`

check installed plugins for updates

USAGE
  $ flowcore plugins update check

DESCRIPTION
  check installed plugins for updates

See code: oclif-plugin-update-notifier

`flowcore reset adapter ADAPTER`

Reset a adapter

USAGE
  $ flowcore reset adapter ADAPTER -s <value> -t <value> [--profile <value>] [-b <value>] [-e <value>]

ARGUMENTS
  ADAPTER  adapter name or id

FLAGS
  -b, --bucket=<value>    time bucket (YYYYMMDDHHmmss or first)
  -e, --eventId=<value>   time uuid
  -s, --scenario=<value>  (required) scenario
  -t, --tenant=<value>    (required) tenant
      --profile=<value>   Specify the configuration profile to use

DESCRIPTION
  Reset a adapter

EXAMPLES
  $ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -b 20240718110000

  $ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -b first

  $ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -e 9cb35da2-ba64-4bb5-86d6-ef20ebc62ab7

See code: @flowcore/cli-plugin-scenario

`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 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 init`

Generate a scenario manifest

USAGE
  $ flowcore scenario init -t <value> [--profile <value>] [-f <value>] [-n <value>] [-o] [--placeholder]

FLAGS
  -f, --file=<value>     [default: flowcore.yaml] 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 init -t flowcore

  $ flowcore scenario init -t flowcore --placeholder

  $ flowcore scenario init -t flowcore -f example.yaml

  $ flowcore scenario init -t flowcore -n scenario-name -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 and output them to the console

USAGE
  $ flowcore stream STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [--profile <value>]

ARGUMENTS
  STREAM  stream url to connect to

FLAGS
  -c, --scan             Scan the full time range
  -e, --end=<value>      End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
  -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
  -p, --payload          Only send the event payload to the destination
  -s, --start=<value>    Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Stream events from a datacore running on the Flowcore Platform and output them to the console

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>/*" -s 1y

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

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

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

See code: @flowcore/cli-plugin-core

`flowcore stream http STREAM`

Stream events from a datacore running on the Flowcore Platform and stream to a http endpoint

USAGE
  $ flowcore stream http STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [--profile <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
  -e, --end=<value>          End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
  -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
  -p, --payload              Only send the event payload to the destination
  -s, --start=<value>        Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 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 and stream to a http endpoint

EXAMPLES
  $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -d http://localhost:3000/transform

  $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y -d http://localhost:3000/transform

  $ flowcore stream http "https://flowcore.io/<org>/<data core>/*" -s 1y -d http://localhost:3000/transform

  $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y -d http://localhost:3000/transform

  $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m -d http://localhost:3000/transform

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

What is this CLI?

The flowcore CLI is the main entrypoint for the Flowcore Platform. It aggregates a set of official plugins to help you configure projects, manage Data Cores and Scenarios, stream events, scaffold apps, and administer tenants and access.

This repository provides the binary (flowcore), wires plugin loading, and ships a few core commands (apply, diff, delete, info). All other functionality is provided by bundled plugins (see below).

Requirements

Node.js >= 18
macOS, Linux, or Windows (PowerShell supported via autocompletion)

Installation

npm install -g @flowcore/cli
# or
yarn global add @flowcore/cli
# or
pnpm add -g @flowcore/cli

Verify installation:

flowcore --version
flowcore help

Quick start

Configure the CLI (GraphQL and Auth endpoints, client credentials):

flowcore config set -u https://graph.api.flowcore.io/graphql \
  -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration \
  -c <client-id>

flowcore login

Work with manifests:

# Dry-run differences
flowcore diff -f ./flowcore.yaml

# Apply changes (confirm prompt unless -y)
flowcore apply -f ./flowcore.yaml

# Delete resources from a manifest or stdin
flowcore delete -f ./flowcore.yaml
cat ./flowcore.yaml | flowcore delete -f -

Stream events (via Core plugin):

flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1w --json

Configuration profiles

Most commands accept --profile <name> to select a saved configuration profile. Use flowcore config set --profile <name> to create/update profiles and flowcore config show to view active settings. Profiles are respected by all bundled plugins that support them.

Included plugins

These are loaded by default (see package.json -> oclif.plugins):

@flowcore/cli-plugin-config: Configuration and auth utilities. Repository
@flowcore/cli-plugin-data-core: Data Core authoring commands. Repository
@flowcore/cli-plugin-scenario: Scenario authoring, logs and local runners. Repository
@flowcore/cli-plugin-core: Streaming (stream, stream http). Repository
@flowcore/cli-plugin-generator: Scaffolding for apps, services, plugins, transformers. Repository
@flowcore/cli-plugin-auth-management: API keys and secrets management. Repository
@flowcore/cli-plugin-tenant-management: Tenant retrieval and management. Repository
@flowcore/cli-plugin-ai: AI configuration helpers. Repository
@flowcore/cli-plugin-iam: Identity and access management helpers. Repository

Refer to each plugin’s README for complete command references. The autogenerated section above also lists available commands as detected at build time.

Shell autocompletion

Enable autocompletion for your shell:

flowcore autocomplete

Update checks and first-run behavior

The CLI periodically checks for updates and will warn if a newer version is available.
On first run, a small hook adds the JSR registry mapping to the CLI data directory’s .npmrc so JSR-scoped packages resolve correctly.

Environment variables

| Variable | Type | Description | Default | Required | |----------|------|-------------|----------|----------| | FLOWCORE_NPM_LOG_LEVEL | string | Log level for npm operations used by plugin management | - | | | FLOWCORE_NPM_REGISTRY | string | Custom npm registry for plugin installation and updates | - | |

Troubleshooting

Run flowcore info to print locations for data, config, and cache directories.
Use --json on commands that support it for machine-readable output.
If you see permission issues with global installs, consider using a Node version manager (nvm) or corepack.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Flowcore CLI

Usage

Commands

flowcore apply

flowcore auth delete key API_KEY_NAME

flowcore auth delete secret SECRET_KEY

flowcore auth list key

flowcore auth list secret

flowcore auth new key NAME

flowcore auth new secret NAME

flowcore autocomplete [SHELL]

flowcore config ai

flowcore config set

flowcore config show

flowcore data-core apply

flowcore data-core generate event-type FLOWTYPE

flowcore data-core generate flow-type

flowcore data-core init

flowcore delete

flowcore diff

flowcore generate nextjs-entity NAME

flowcore get adapter [ADAPTER]

flowcore get scenario [SCENARIO]

flowcore get tenant [NAME]

flowcore help [COMMAND]

flowcore info

flowcore login

flowcore logs adapter ADAPTER

flowcore new bun-service NAME

flowcore new generator NAME

flowcore new nextjs-app NAME

flowcore new plugin NAME

flowcore new transformer NAME

flowcore plugins

flowcore plugins add PLUGIN

flowcore plugins:inspect PLUGIN...

flowcore plugins install PLUGIN

flowcore plugins link PATH

flowcore plugins remove [PLUGIN]

flowcore plugins reset

flowcore plugins uninstall [PLUGIN]

flowcore plugins unlink [PLUGIN]

flowcore plugins update

flowcore plugins update check

flowcore reset adapter ADAPTER

flowcore scenario apply

flowcore scenario generate transformer

flowcore scenario init

flowcore scenario local

flowcore stream STREAM

flowcore stream http STREAM

flowcore version

flowcore whoami

What is this CLI?

Requirements

Installation

Quick start

Configuration profiles

Included plugins

Shell autocompletion

Update checks and first-run behavior

Environment variables

Troubleshooting

`flowcore apply`

`flowcore auth delete key API_KEY_NAME`

`flowcore auth delete secret SECRET_KEY`

`flowcore auth list key`

`flowcore auth list secret`

`flowcore auth new key NAME`

`flowcore auth new secret NAME`

`flowcore autocomplete [SHELL]`

`flowcore config ai`

`flowcore config set`

`flowcore config show`

`flowcore data-core apply`

`flowcore data-core generate event-type FLOWTYPE`

`flowcore data-core generate flow-type`

`flowcore data-core init`

`flowcore delete`

`flowcore diff`

`flowcore generate nextjs-entity NAME`

`flowcore get adapter [ADAPTER]`

`flowcore get scenario [SCENARIO]`

`flowcore get tenant [NAME]`

`flowcore help [COMMAND]`

`flowcore info`

`flowcore login`

`flowcore logs adapter ADAPTER`

`flowcore new bun-service NAME`

`flowcore new generator NAME`

`flowcore new nextjs-app NAME`

`flowcore new plugin NAME`

`flowcore new transformer NAME`

`flowcore plugins`

`flowcore plugins add PLUGIN`

`flowcore plugins:inspect PLUGIN...`

`flowcore plugins install PLUGIN`

`flowcore plugins link PATH`

`flowcore plugins remove [PLUGIN]`

`flowcore plugins reset`

`flowcore plugins uninstall [PLUGIN]`

`flowcore plugins unlink [PLUGIN]`

`flowcore plugins update`

`flowcore plugins update check`

`flowcore reset adapter ADAPTER`

`flowcore scenario apply`

`flowcore scenario generate transformer`

`flowcore scenario init`

`flowcore scenario local`

`flowcore stream STREAM`

`flowcore stream http STREAM`

`flowcore version`

`flowcore whoami`