Flowcore CLI
=================

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

![Version](https://npmjs.org/package/@flowcore/cli)
![oclif](https://oclif.io)
![Build and Release](https://github.com/flowcore-io/flowcore-cli/actions/workflows/build.yml)

* Usage
* Commands

Usage

sh-session
$ 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

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-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-adapter-adapter)
* [

flowcore get scenario [SCENARIO]

](#flowcore-get-scenario-scenario)
* [

flowcore get tenant [NAME]

](#flowcore-get-tenant-name)
* [

flowcore help [COMMAND]

](#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-remove-plugin)
*

flowcore plugins reset

* [

flowcore plugins uninstall [PLUGIN]

](#flowcore-plugins-uninstall-plugin)
* [

flowcore plugins unlink [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

flowcore apply

Apply a resource manifest against the Flowcore Platform

`USAGE $ flowcore apply -f [--profile ] [--v2] [-y]

FLAGS -f, --file=... (required) file to apply -y, --yes skip confirmation --profile= 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 [--profile ]

ARGUMENTS API_KEY_NAME Name of the API key to delete

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

DESCRIPTION Delete an API key

EXAMPLES $ flowcore auth delete key --tenant=tenant-id`

_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 [--profile ]

ARGUMENTS SECRET_KEY Key of the secret to delete

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

DESCRIPTION Delete an organization secret

EXAMPLES $ flowcore auth delete secret --tenant=tenant-id`

_See code: @flowcore/cli-plugin-auth-management_

flowcore auth list key

List all API keys

`USAGE $ flowcore auth list key -t [--profile ] [-j]

FLAGS -j, --json output the API key in JSON format -t, --tenant= (required) tenant where the API keys should be listed --profile= 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 [--profile ] [-j]

FLAGS -j, --json output the secrets in JSON format -t, --tenant= (required) tenant where the secrets should be listed --profile= 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 [--profile ] [-j]

ARGUMENTS NAME name of the API key

FLAGS -j, --json output the API key in JSON format -t, --tenant= (required) tenant where the API key should be created --profile= 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 [--profile ] [--from-file ] [--from-literal ]

ARGUMENTS NAME name of the secret

FLAGS -t, --tenant= (required) tenant where the secret should be created --from-file= read value from a file --from-literal= use literal value instead of reading from stdin --profile= 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 ] [-a ] [-p ]

FLAGS -a, --apiKey= api key -p, --provider= provider --profile= 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 ] [-b ] [-c ] [-n ] [-l ] [-p] [-u ]

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

FLAGS --profile= 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 [--profile ] [-n ] [-t ] [-y]

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

_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 ] [-d ] [-f ] [-n ]

FLAGS -d, --description= description of the event type -f, --file= [default: flowcore.yaml] file to modify -n, --name= name of the event type to generate --profile= 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 ] [-d ] [-f ] [-n ]

FLAGS -d, --description= description of the flow type -f, --file= [default: flowcore.yaml] file to modify -n, --name= name of the flow type to generate --profile= 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 [--profile ] [-f ] [-p] [-o]

FLAGS -f, --file= [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= (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= 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 [--profile ] [-y]

FLAGS -f, --file= (required) file that contains the resources to delete or '-' for stdin -y, --yes skip confirmation --profile= 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 [--profile ]

FLAGS -f, --file=... (required) file or directory to diff --profile= 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 ]

ARGUMENTS NAME name of the entity to generate

FLAGS --profile= 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 -t [--profile ]

ARGUMENTS ADAPTER adapter name or id

FLAGS -s, --scenario= (required) scenario -t, --tenant= (required) tenant --profile= 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 [--profile ]

ARGUMENTS SCENARIO scenario name

FLAGS -t, --tenant= (required) tenant --profile= 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 ] [-j] [-t ]

ARGUMENTS NAME name

FLAGS -j, --json output in json -t, --tenant= tenant --profile= 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 ]

FLAGS --profile= 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

login to the Flowcore Platform

`USAGE $ flowcore login [--profile ] [-p ]

FLAGS -p, --port= [default: 3000] port to listen for the callback --profile= 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 -t [--profile ] [-f] [-j] [-l ]

ARGUMENTS ADAPTER adapter name or id

FLAGS -f, --follow follow -j, --json json -l, --limit= [default: 1000] limit -s, --scenario= (required) scenario -t, --tenant= (required) tenant --profile= 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 ] [--no-flowcore]

ARGUMENTS NAME name of the bun service

FLAGS --no-flowcore do not use flowcore --profile= 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 ]

ARGUMENTS NAME name of the generator

FLAGS --profile= 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 ]

ARGUMENTS NAME name of the nextjs app

FLAGS --profile= 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 ]

ARGUMENTS NAME name of the plugin

FLAGS --profile= 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 ] [--no-flowcore]

ARGUMENTS NAME name of the bun transformer

FLAGS --no-flowcore do not use flowcore --profile= 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 -t [--profile ] [-b ] [-e ]

ARGUMENTS ADAPTER adapter name or id

FLAGS -b, --bucket= time bucket (YYYYMMDDHHmmss or first) -e, --eventId= time uuid -s, --scenario= (required) scenario -t, --tenant= (required) tenant --profile= 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 [--profile ] [-d] [-n ] [-t ] [-y]

FLAGS -d, --[no-]deploy deploy the scenario after applying -f, --file=... (required) file to apply -n, --name= name of the scenario to apply -t, --tenant= 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= 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 <`

_See code: @flowcore/cli-plugin-scenario_

flowcore scenario generate transformer

add a transformer to a scenario manifest

`USAGE $ flowcore scenario generate transformer [--profile ] [-d ] [-f ] [-n ]

FLAGS -d, --description= description of the transformer -f, --file= file to modify -n, --name= name of the transformer to generate --profile= 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 [--profile ] [-f ] [-n ] [-o] [--placeholder]

FLAGS -f, --file= [default: flowcore.yaml] file to apply -n, --name= name of the scenario to generate -o, --overwrite overwrite the existing scenario -t, --tenant= (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= 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 -f [--profile ] [-H ] [-m http] [-c] [-s ] [-t ] [-y]

FLAGS -H, --header=... [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN') -c, --scan Scan the full time range -e, --endpoint= (required) stream endpoint -f, --file=... (required) file to apply -m, --mode=

DESCRIPTION Spin up local stream threads based on a scenario manifest

EXAMPLES $ flowcore scenario local -f example.yaml

$ cat <`

_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 ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ]

ARGUMENTS STREAM stream url to connect to

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

$ flowcore stream "https://flowcore.io////.stream" -s 1y

$ flowcore stream "https://flowcore.io///*" -s 1y

$ flowcore stream "https://flowcore.io////*" -s 1y

$ flowcore stream "https://flowcore.io////.stream" -s 3m --json > some.json

$ flowcore stream "https://flowcore.io////[,,].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 ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ] [-d ] [-H ] [-t ]

ARGUMENTS STREAM stream url to connect to

FLAGS -H, --header=... [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN') -c, --scan Scan the full time range -d, --destination= [default: http://localhost:3000/transform] Destination to send events to -e, --end= 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= Maximum number of events to send to the destination -p, --payload Only send the event payload to the destination -s, --start= Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now) -t, --timeout= [default: 5000] Timeout in milliseconds to wait for a response from the destination --profile= 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////.stream" -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////.stream" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io///*" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////*" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////[,,].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 ]

FLAGS --profile= Specify the configuration profile to use

DESCRIPTION Check what user you are logged in as`

_See code: @flowcore/cli-plugin-config_

`$3`

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).

`$3`

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

`$3`

`bash npm install -g @flowcore/cli

`or`


yarn global add @flowcore/cli
or

pnpm add -g @flowcore/cli


Verify installation:

`bash flowcore --version flowcore help`

`$3`

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

`bash flowcore config set -u https://graph.api.flowcore.io/graphql \ -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration \ -c`

2) Login:

`bash flowcore login`

3) Work with manifests:

`bash

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


4) Stream events (via Core plugin):

`bash flowcore stream "https://flowcore.io////.stream" -s 1w --json`

`$3`

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

`$3`

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.

`$3`

Enable autocompletion for your shell:

`bash flowcore autocomplete`

`$3`

* 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.

`$3`

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

`$3`

* Run flowcore infoto print locations for data, config, and cache directories. * Use--jsonon commands that support it for machine-readable output. * If you see permission issues with global installs, consider using a Node version manager (nvm) orcorepack`.

Flowcore CLI
=================

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

![Version](https://npmjs.org/package/@flowcore/cli)
![oclif](https://oclif.io)
![Build and Release](https://github.com/flowcore-io/flowcore-cli/actions/workflows/build.yml)

* Usage
* Commands

Usage

sh-session
$ 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

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-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-adapter-adapter)
* [

flowcore get scenario [SCENARIO]

](#flowcore-get-scenario-scenario)
* [

flowcore get tenant [NAME]

](#flowcore-get-tenant-name)
* [

flowcore help [COMMAND]

](#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-remove-plugin)
*

flowcore plugins reset

* [

flowcore plugins uninstall [PLUGIN]

](#flowcore-plugins-uninstall-plugin)
* [

flowcore plugins unlink [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

flowcore apply

Apply a resource manifest against the Flowcore Platform

`USAGE $ flowcore apply -f [--profile ] [--v2] [-y]

FLAGS -f, --file=... (required) file to apply -y, --yes skip confirmation --profile= 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 [--profile ]

ARGUMENTS API_KEY_NAME Name of the API key to delete

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

DESCRIPTION Delete an API key

EXAMPLES $ flowcore auth delete key --tenant=tenant-id`

_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 [--profile ]

ARGUMENTS SECRET_KEY Key of the secret to delete

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

DESCRIPTION Delete an organization secret

EXAMPLES $ flowcore auth delete secret --tenant=tenant-id`

_See code: @flowcore/cli-plugin-auth-management_

flowcore auth list key

List all API keys

`USAGE $ flowcore auth list key -t [--profile ] [-j]

FLAGS -j, --json output the API key in JSON format -t, --tenant= (required) tenant where the API keys should be listed --profile= 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 [--profile ] [-j]

FLAGS -j, --json output the secrets in JSON format -t, --tenant= (required) tenant where the secrets should be listed --profile= 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 [--profile ] [-j]

ARGUMENTS NAME name of the API key

FLAGS -j, --json output the API key in JSON format -t, --tenant= (required) tenant where the API key should be created --profile= 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 [--profile ] [--from-file ] [--from-literal ]

ARGUMENTS NAME name of the secret

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 ] [-a ] [-p ]

FLAGS -a, --apiKey= api key -p, --provider= provider --profile= 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 ] [-b ] [-c ] [-n ] [-l ] [-p] [-u ]

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 ]

FLAGS --profile= 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 [--profile ] [-n ] [-t ] [-y]

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

_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 ] [-d ] [-f ] [-n ]

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 ] [-d ] [-f ] [-n ]

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 [--profile ] [-f ] [-p] [-o]

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 [--profile ] [-y]

FLAGS -f, --file= (required) file that contains the resources to delete or '-' for stdin -y, --yes skip confirmation --profile= 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 [--profile ]

FLAGS -f, --file=... (required) file or directory to diff --profile= 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 ]

ARGUMENTS NAME name of the entity to generate

FLAGS --profile= 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 -t [--profile ]

ARGUMENTS ADAPTER adapter name or id

FLAGS -s, --scenario= (required) scenario -t, --tenant= (required) tenant --profile= 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 [--profile ]

ARGUMENTS SCENARIO scenario name

FLAGS -t, --tenant= (required) tenant --profile= 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 ] [-j] [-t ]

ARGUMENTS NAME name

FLAGS -j, --json output in json -t, --tenant= tenant --profile= 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 ]

FLAGS --profile= 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

login to the Flowcore Platform

`USAGE $ flowcore login [--profile ] [-p ]

FLAGS -p, --port= [default: 3000] port to listen for the callback --profile= 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 -t [--profile ] [-f] [-j] [-l ]

ARGUMENTS ADAPTER adapter name or id

FLAGS -f, --follow follow -j, --json json -l, --limit= [default: 1000] limit -s, --scenario= (required) scenario -t, --tenant= (required) tenant --profile= 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 ] [--no-flowcore]

ARGUMENTS NAME name of the bun service

FLAGS --no-flowcore do not use flowcore --profile= 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 ]

ARGUMENTS NAME name of the generator

FLAGS --profile= 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 ]

ARGUMENTS NAME name of the nextjs app

FLAGS --profile= 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 ]

ARGUMENTS NAME name of the plugin

FLAGS --profile= 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 ] [--no-flowcore]

ARGUMENTS NAME name of the bun transformer

FLAGS --no-flowcore do not use flowcore --profile= 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.

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 -t [--profile ] [-b ] [-e ]

ARGUMENTS ADAPTER adapter name or id

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 [--profile ] [-d] [-n ] [-t ] [-y]

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

_See code: @flowcore/cli-plugin-scenario_

flowcore scenario generate transformer

add a transformer to a scenario manifest

`USAGE $ flowcore scenario generate transformer [--profile ] [-d ] [-f ] [-n ]

FLAGS -d, --description= description of the transformer -f, --file= file to modify -n, --name= name of the transformer to generate --profile= 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 [--profile ] [-f ] [-n ] [-o] [--placeholder]

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 -f [--profile ] [-H ] [-m http] [-c] [-s ] [-t ] [-y]

DESCRIPTION Spin up local stream threads based on a scenario manifest

EXAMPLES $ flowcore scenario local -f example.yaml

$ cat <`

_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 ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ]

ARGUMENTS STREAM stream url to connect to

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

EXAMPLES $ flowcore stream "https://flowcore.io////.stream"

$ flowcore stream "https://flowcore.io////.stream" -s 1y

$ flowcore stream "https://flowcore.io///*" -s 1y

$ flowcore stream "https://flowcore.io////*" -s 1y

$ flowcore stream "https://flowcore.io////.stream" -s 3m --json > some.json

$ flowcore stream "https://flowcore.io////[,,].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 ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ] [-d ] [-H ] [-t ]

ARGUMENTS STREAM stream url to connect to

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

EXAMPLES $ flowcore stream http "https://flowcore.io////.stream" -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////.stream" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io///*" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////*" -s 1y -d http://localhost:3000/transform

$ flowcore stream http "https://flowcore.io////[,,].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 ]

FLAGS --profile= Specify the configuration profile to use

DESCRIPTION Check what user you are logged in as`

_See code: @flowcore/cli-plugin-config_

`$3`

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

`$3`

`bash npm install -g @flowcore/cli

`or`


yarn global add @flowcore/cli
or

pnpm add -g @flowcore/cli


Verify installation:

`bash flowcore --version flowcore help`

`$3`

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

`bash flowcore config set -u https://graph.api.flowcore.io/graphql \ -l https://auth.flowcore.io/realms/flowcore/.well-known/openid-configuration \ -c`

2) Login:

`bash flowcore login`

3) Work with manifests:

`bash

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


4) Stream events (via Core plugin):

`bash flowcore stream "https://flowcore.io////.stream" -s 1w --json`

`$3`

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

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

`$3`

Enable autocompletion for your shell:

`bash flowcore autocomplete`