@flowcore/cli
v4.18.10
Published
Flowcore CLI for interacting with the Flowcore platform
Readme
Flowcore CLI
Flowcore CLI is a command line interface for interacting with the Flowcore Platform.
- Usage
- Commands
- or
- or
- Dry-run differences
- Apply changes (confirm prompt unless -y)
- Delete resources from a manifest or stdin
Usage
$ npm install -g @flowcore/cli
$ flowcore COMMAND
running command...
$ flowcore (--version)
@flowcore/cli/4.18.10 linux-x64 node-v24.13.0
$ flowcore --help [COMMAND]
USAGE
$ flowcore COMMAND
...Commands
flowcore applyflowcore assign policy POLICY_NAMEflowcore assign role ROLE_NAMEflowcore auth delete key API_KEY_NAMEflowcore auth delete pat PATflowcore auth delete secret SECRET_KEYflowcore auth list keyflowcore auth list patflowcore auth list secretflowcore auth new key NAMEflowcore auth new pat NAMEflowcore auth new secret NAMEflowcore autocomplete [SHELL]flowcore config aiflowcore config setflowcore config showflowcore create policy NAMEflowcore create role NAMEflowcore data-core applyflowcore data-core create NAMEflowcore data-core delete NAMEflowcore data-core generate event-type FLOWTYPEflowcore data-core generate flow-typeflowcore data-core get NAMEflowcore data-core initflowcore data-core listflowcore data-core update NAMEflowcore deleteflowcore delete policy NAMEflowcore delete role NAMEflowcore diffflowcore edit policy NAMEflowcore edit role NAMEflowcore event-type create NAMEflowcore event-type delete NAMEflowcore event-type get NAMEflowcore event-type listflowcore event-type update NAMEflowcore flow-type create NAMEflowcore flow-type delete NAMEflowcore flow-type get NAMEflowcore flow-type listflowcore flow-type update NAMEflowcore generate nextjs-entity NAMEflowcore get adapter [ADAPTER]flowcore get key-policies KEY_IDflowcore get key-roles KEY_IDflowcore get policy [NAME]flowcore get role [NAME]flowcore get scenario [SCENARIO]flowcore get tenant [NAME]flowcore get user-policies USER_IDflowcore get user-roles USER_IDflowcore help [COMMAND]flowcore infoflowcore loginflowcore logs adapter ADAPTERflowcore new bun-service NAMEflowcore new generator NAMEflowcore new nextjs-app NAMEflowcore new plugin NAMEflowcore new transformer NAMEflowcore pluginsflowcore plugins add PLUGINflowcore plugins:inspect PLUGIN...flowcore plugins install PLUGINflowcore plugins link PATHflowcore plugins remove [PLUGIN]flowcore plugins resetflowcore plugins uninstall [PLUGIN]flowcore plugins unlink [PLUGIN]flowcore plugins updateflowcore plugins update checkflowcore reset adapter ADAPTERflowcore scenario applyflowcore scenario generate transformerflowcore scenario initflowcore scenario localflowcore stream STREAMflowcore stream http STREAMflowcore unassign policy POLICY_NAMEflowcore unassign role ROLE_NAMEflowcore updateflowcore validate key KEY_IDflowcore validate user USER_IDflowcore versionflowcore whoami
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.ymlSee code: src/commands/apply.ts
flowcore assign policy POLICY_NAME
Assign an IAM policy to a user, API key, or role. Exactly one of --user, --key, or --role must be specified
USAGE
$ flowcore assign policy POLICY_NAME -t <value> [--profile <value>] [-j] [--key <value> | --user <value> | --role
<value>]
ARGUMENTS
POLICY_NAME The name of the policy to assign
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> (required) The tenant (organization slug) containing the policy
--key=<value> The API key ID to assign the policy to
--profile=<value> Specify the configuration profile to use
--role=<value> The role name to assign the policy to
--user=<value> The user ID to assign the policy to
DESCRIPTION
Assign an IAM policy to a user, API key, or role. Exactly one of --user, --key, or --role must be specified
EXAMPLES
$ flowcore iam assign policy read-access --user "auth0|abc123" -t my-org
$ flowcore iam assign policy read-access --key "550e8400-e29b-41d4-a716-446655440000" -t my-org
$ flowcore iam assign policy read-access --role data-reader -t my-org
$ flowcore iam assign policy read-access --user "auth0|abc123" -t my-org -jSee code: @flowcore/cli-plugin-iam
flowcore assign role ROLE_NAME
Assign an IAM role to a user or API key. Exactly one of --user or --key must be specified
USAGE
$ flowcore assign role ROLE_NAME -t <value> [--profile <value>] [-j] [--key <value> | --user <value>]
ARGUMENTS
ROLE_NAME The name of the role to assign
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> (required) The tenant (organization slug) containing the role
--key=<value> The API key ID to assign the role to
--profile=<value> Specify the configuration profile to use
--user=<value> The user ID to assign the role to
DESCRIPTION
Assign an IAM role to a user or API key. Exactly one of --user or --key must be specified
EXAMPLES
$ flowcore iam assign role data-reader --user "auth0|abc123" -t my-org
$ flowcore iam assign role data-reader --key "550e8400-e29b-41d4-a716-446655440000" -t my-org
$ flowcore iam assign role data-reader --user "auth0|abc123" -t my-org -jSee code: @flowcore/cli-plugin-iam
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 pat PAT
Delete a Personal Access Token (PAT)
USAGE
$ flowcore auth delete pat PAT [--profile <value>] [-j]
ARGUMENTS
PAT PAT id to delete
FLAGS
-j, --json output the PAT in JSON format
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Delete a Personal Access Token (PAT)
EXAMPLES
$ flowcore auth delete pat <pat-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 <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-idSee code: @flowcore/cli-plugin-auth-management
flowcore auth list pat
List all Personal Access Tokens (PATs)
USAGE
$ flowcore auth list pat [--profile <value>] [-j]
FLAGS
-j, --json output the PATs in JSON format
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all Personal Access Tokens (PATs)
EXAMPLES
$ flowcore auth list patSee 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-idSee 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 <NAME> --tenant=tenant-idSee code: @flowcore/cli-plugin-auth-management
flowcore auth new pat NAME
Create a new PAT (Personal Access Token)
USAGE
$ flowcore auth new pat NAME [--profile <value>] [-j]
ARGUMENTS
NAME PAT name
FLAGS
-j, --json output the API key in JSON format
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Create a new PAT (Personal Access Token)
EXAMPLES
$ flowcore auth new pat <pat-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 <NAME> --tenant=tenant-id --from-literal=valueSee 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-cacheSee 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
$ flowcoreSee 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 -pSee 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 showSee code: @flowcore/cli-plugin-config
flowcore create policy NAME
Create a new IAM policy with the specified name, version, and policy documents defining resource access rules
USAGE
$ flowcore create policy NAME --documents <value> -t <value> --version <value> [--profile <value>] [--description
<value>] [-j]
ARGUMENTS
NAME The name of the policy to create
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> (required) The tenant (organization slug) to create the policy in
--description=<value> A description of the policy
--documents=<value> (required) JSON array of policy documents, each with "resource" and "action" fields. Use
"-" to read from stdin
--profile=<value> Specify the configuration profile to use
--version=<value> (required) The version of the policy (e.g. 2024-01-01)
DESCRIPTION
Create a new IAM policy with the specified name, version, and policy documents defining resource access rules
EXAMPLES
$ flowcore iam create policy read-access -t my-org --version "2024-01-01" --documents '[{"resource":"frn::my-org:data-core/*","action":["read","fetch"]}]'
$ cat docs.json | flowcore iam create policy read-access -t my-org --version "2024-01-01" --documents -
$ flowcore iam create policy admin-access -t my-org --version "2024-01-01" --description "Full admin access" --documents '[{"resource":"frn::my-org:*","action":"*"}]' -jSee code: @flowcore/cli-plugin-iam
flowcore create role NAME
Create a new IAM role with the specified name and optional description
USAGE
$ flowcore create role NAME -t <value> [--profile <value>] [--description <value>] [-j]
ARGUMENTS
NAME The name of the role to create
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> (required) The tenant (organization slug) to create the role in
--description=<value> A description of the role
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Create a new IAM role with the specified name and optional description
EXAMPLES
$ flowcore iam create role data-reader -t my-org --description "Read-only data access"
$ flowcore iam create role admin -t my-org -jSee code: @flowcore/cli-plugin-iam
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 create NAME
Create a new data core
USAGE
$ flowcore data-core create NAME -t <value> [--profile <value>] [--delete-protection] [-d <value>] [-j] [--public]
ARGUMENTS
NAME name of the data core
FLAGS
-d, --description=<value> description of the data core
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--delete-protection enable delete protection
--profile=<value> Specify the configuration profile to use
--public make the data core public
DESCRIPTION
Create a new data core
EXAMPLES
$ flowcore data-core create my-data-core -t my-tenant
$ flowcore data-core create my-data-core -t my-tenant -d "My description" --publicSee code: @flowcore/cli-plugin-data-core
flowcore data-core delete NAME
Delete a data core
USAGE
$ flowcore data-core delete NAME -t <value> [--profile <value>] [--wait] [-y]
ARGUMENTS
NAME name of the data core
FLAGS
-t, --tenant=<value> (required) tenant name
-y, --yes skip confirmation
--profile=<value> Specify the configuration profile to use
--[no-]wait wait for deletion to complete
DESCRIPTION
Delete a data core
EXAMPLES
$ flowcore data-core delete my-data-core -t my-tenant
$ flowcore data-core delete my-data-core -t my-tenant -ySee 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.yamlSee 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.yamlSee code: @flowcore/cli-plugin-data-core
flowcore data-core get NAME
Get a data core by name
USAGE
$ flowcore data-core get NAME -t <value> [--profile <value>] [-j]
ARGUMENTS
NAME name of the data core
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Get a data core by name
EXAMPLES
$ flowcore data-core get my-data-core -t my-tenant
$ flowcore data-core get my-data-core -t my-tenant -jSee 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.yamlSee code: @flowcore/cli-plugin-data-core
flowcore data-core list
List all data cores for a tenant
USAGE
$ flowcore data-core list -t <value> [--profile <value>] [-j]
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all data cores for a tenant
EXAMPLES
$ flowcore data-core list -t my-tenant
$ flowcore data-core list -t my-tenant -jSee code: @flowcore/cli-plugin-data-core
flowcore data-core update NAME
Update a data core
USAGE
$ flowcore data-core update NAME -t <value> [--profile <value>] [--delete-protection] [-d <value>] [-j] [--public]
ARGUMENTS
NAME name of the data core
FLAGS
-d, --description=<value> description of the data core
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--[no-]delete-protection enable delete protection
--profile=<value> Specify the configuration profile to use
--[no-]public make the data core public
DESCRIPTION
Update a data core
EXAMPLES
$ flowcore data-core update my-data-core -t my-tenant -d "New description"
$ flowcore data-core update my-data-core -t my-tenant --public --delete-protectionSee 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 delete policy NAME
Delete a policy
USAGE
$ flowcore delete policy NAME -t <value> [--profile <value>] [-j] [-y]
ARGUMENTS
NAME name
FLAGS
-j, --json json output
-t, --tenant=<value> (required) tenant
-y, --yes yes to all
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Delete a policySee code: @flowcore/cli-plugin-iam
flowcore delete role NAME
Delete a role
USAGE
$ flowcore delete role NAME -t <value> [--profile <value>] [-j] [-y]
ARGUMENTS
NAME name
FLAGS
-j, --json json output
-t, --tenant=<value> (required) tenant
-y, --yes yes to all
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Delete a roleSee code: @flowcore/cli-plugin-iam
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.ymlSee code: src/commands/diff.ts
flowcore edit policy NAME
Edit a policy in your preferred editor
USAGE
$ flowcore edit policy NAME -t <value> [--profile <value>]
ARGUMENTS
NAME name
FLAGS
-t, --tenant=<value> (required) tenant
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Edit a policy in your preferred editor
EXAMPLES
$ flowcore iam edit policy my-policy -t my-tenant
$ FC_EDITOR=code flowcore iam edit policy my-policy -t my-tenantSee code: @flowcore/cli-plugin-iam
flowcore edit role NAME
Edit a role in your preferred editor
USAGE
$ flowcore edit role NAME -t <value> [--profile <value>]
ARGUMENTS
NAME name
FLAGS
-t, --tenant=<value> (required) tenant
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Edit a role in your preferred editor
EXAMPLES
$ flowcore iam edit role my-role -t my-tenant
$ FC_EDITOR=code flowcore iam edit role my-role -t my-tenantSee code: @flowcore/cli-plugin-iam
flowcore event-type create NAME
Create a new event type
USAGE
$ flowcore event-type create NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-d <value>]
[-j]
ARGUMENTS
NAME name of the event type
FLAGS
-d, --description=<value> description of the event type
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--flow-type=<value> (required) name of the flow type
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Create a new event type
EXAMPLES
$ flowcore event-type create my-event-type --data-core my-dc --flow-type my-ft -t my-tenant
$ flowcore event-type create my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -d "My description"See code: @flowcore/cli-plugin-data-core
flowcore event-type delete NAME
Delete an event type
USAGE
$ flowcore event-type delete NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [--wait] [-y]
ARGUMENTS
NAME name of the event type
FLAGS
-t, --tenant=<value> (required) tenant name
-y, --yes skip confirmation
--data-core=<value> (required) name of the data core
--flow-type=<value> (required) name of the flow type
--profile=<value> Specify the configuration profile to use
--[no-]wait wait for deletion to complete
DESCRIPTION
Delete an event type
EXAMPLES
$ flowcore event-type delete my-event-type --data-core my-dc --flow-type my-ft -t my-tenant
$ flowcore event-type delete my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -ySee code: @flowcore/cli-plugin-data-core
flowcore event-type get NAME
Get an event type by name
USAGE
$ flowcore event-type get NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-j]
ARGUMENTS
NAME name of the event type
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--flow-type=<value> (required) name of the flow type
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Get an event type by name
EXAMPLES
$ flowcore event-type get my-event-type --data-core my-dc --flow-type my-ft -t my-tenantSee code: @flowcore/cli-plugin-data-core
flowcore event-type list
List all event types for a flow type
USAGE
$ flowcore event-type list --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-j]
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--flow-type=<value> (required) name of the flow type
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all event types for a flow type
EXAMPLES
$ flowcore event-type list --data-core my-dc --flow-type my-ft -t my-tenant
$ flowcore event-type list --data-core my-dc --flow-type my-ft -t my-tenant -jSee code: @flowcore/cli-plugin-data-core
flowcore event-type update NAME
Update an event type
USAGE
$ flowcore event-type update NAME --data-core <value> -d <value> --flow-type <value> -t <value> [--profile <value>]
[-j]
ARGUMENTS
NAME name of the event type
FLAGS
-d, --description=<value> (required) description of the event type
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--flow-type=<value> (required) name of the flow type
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Update an event type
EXAMPLES
$ flowcore event-type update my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -d "New description"See code: @flowcore/cli-plugin-data-core
flowcore flow-type create NAME
Create a new flow type
USAGE
$ flowcore flow-type create NAME --data-core <value> -t <value> [--profile <value>] [-d <value>] [-j]
ARGUMENTS
NAME name of the flow type
FLAGS
-d, --description=<value> description of the flow type
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Create a new flow type
EXAMPLES
$ flowcore flow-type create my-flow-type --data-core my-dc -t my-tenant
$ flowcore flow-type create my-flow-type --data-core my-dc -t my-tenant -d "My description"See code: @flowcore/cli-plugin-data-core
flowcore flow-type delete NAME
Delete a flow type
USAGE
$ flowcore flow-type delete NAME --data-core <value> -t <value> [--profile <value>] [--wait] [-y]
ARGUMENTS
NAME name of the flow type
FLAGS
-t, --tenant=<value> (required) tenant name
-y, --yes skip confirmation
--data-core=<value> (required) name of the data core
--profile=<value> Specify the configuration profile to use
--[no-]wait wait for deletion to complete
DESCRIPTION
Delete a flow type
EXAMPLES
$ flowcore flow-type delete my-flow-type --data-core my-dc -t my-tenant
$ flowcore flow-type delete my-flow-type --data-core my-dc -t my-tenant -ySee code: @flowcore/cli-plugin-data-core
flowcore flow-type get NAME
Get a flow type by name
USAGE
$ flowcore flow-type get NAME --data-core <value> -t <value> [--profile <value>] [-j]
ARGUMENTS
NAME name of the flow type
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Get a flow type by name
EXAMPLES
$ flowcore flow-type get my-flow-type --data-core my-dc -t my-tenantSee code: @flowcore/cli-plugin-data-core
flowcore flow-type list
List all flow types for a data core
USAGE
$ flowcore flow-type list --data-core <value> -t <value> [--profile <value>] [-j]
FLAGS
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all flow types for a data core
EXAMPLES
$ flowcore flow-type list --data-core my-dc -t my-tenant
$ flowcore flow-type list --data-core my-dc -t my-tenant -jSee code: @flowcore/cli-plugin-data-core
flowcore flow-type update NAME
Update a flow type
USAGE
$ flowcore flow-type update NAME --data-core <value> -d <value> -t <value> [--profile <value>] [-j]
ARGUMENTS
NAME name of the flow type
FLAGS
-d, --description=<value> (required) description of the flow type
-j, --json output as JSON
-t, --tenant=<value> (required) tenant name
--data-core=<value> (required) name of the data core
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Update a flow type
EXAMPLES
$ flowcore flow-type update my-flow-type --data-core my-dc -t my-tenant -d "New description"See code: @flowcore/cli-plugin-data-core
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-entitySee 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-nameSee code: @flowcore/cli-plugin-scenario
flowcore get key-policies KEY_ID
List all IAM policies assigned to a specific API key
USAGE
$ flowcore get key-policies KEY_ID [--profile <value>] [-j] [-w]
ARGUMENTS
KEY_ID The API key ID to get policies for
FLAGS
-j, --json Output result as JSON
-w, --wide Show additional columns in table output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all IAM policies assigned to a specific API key
EXAMPLES
$ flowcore iam get key-policies "550e8400-e29b-41d4-a716-446655440000"
$ flowcore iam get key-policies "550e8400-e29b-41d4-a716-446655440000" -j
$ flowcore iam get key-policies "550e8400-e29b-41d4-a716-446655440000" -wSee code: @flowcore/cli-plugin-iam
flowcore get key-roles KEY_ID
List all IAM roles assigned to a specific API key
USAGE
$ flowcore get key-roles KEY_ID [--profile <value>] [-j] [-w]
ARGUMENTS
KEY_ID The API key ID to get roles for
FLAGS
-j, --json Output result as JSON
-w, --wide Show additional columns in table output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all IAM roles assigned to a specific API key
EXAMPLES
$ flowcore iam get key-roles "550e8400-e29b-41d4-a716-446655440000"
$ flowcore iam get key-roles "550e8400-e29b-41d4-a716-446655440000" -j
$ flowcore iam get key-roles "550e8400-e29b-41d4-a716-446655440000" -wSee code: @flowcore/cli-plugin-iam
flowcore get policy [NAME]
Get a policy
USAGE
$ flowcore get policy [NAME] [--profile <value>] [-j] [-t <value>] [-w]
ARGUMENTS
NAME name
FLAGS
-j, --json json output
-t, --tenant=<value> tenant
-w, --wide wide output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Get a policySee code: @flowcore/cli-plugin-iam
flowcore get role [NAME]
Get a role
USAGE
$ flowcore get role [NAME] [--profile <value>] [-j] [-t <value>] [-w]
ARGUMENTS
NAME name
FLAGS
-j, --json json output
-t, --tenant=<value> tenant
-w, --wide wide output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
Get a roleSee code: @flowcore/cli-plugin-iam
flowcore get scenario [SCENARIO]
Get scenario
USAGE
$ flowcore get scenario [SCENARIO] -t <value> [--profile <value>] [--v2]
ARGUMENTS
SCENARIO scenario name
FLAGS
-t, --tenant=<value> (required) tenant
--profile=<value> Specify the configuration profile to use
--v2 use v2 api
DESCRIPTION
Get scenario
EXAMPLES
$ flowcore get scenario -t tenant-name
$ flowcore get scenario scenario-name -t tenant-nameSee 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 --jsonSee code: @flowcore/cli-plugin-tenant-management
flowcore get user-policies USER_ID
List all IAM policies assigned to a specific user, optionally scoped to a tenant
USAGE
$ flowcore get user-policies USER_ID [--profile <value>] [-j] [-t <value>] [-w]
ARGUMENTS
USER_ID The user ID to get policies for (e.g. auth0|abc123)
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> Scope results to a specific tenant (organization slug)
-w, --wide Show additional columns in table output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all IAM policies assigned to a specific user, optionally scoped to a tenant
EXAMPLES
$ flowcore iam get user-policies "auth0|abc123" -t my-org
$ flowcore iam get user-policies "auth0|abc123" -j
$ flowcore iam get user-policies "auth0|abc123" -t my-org -wSee code: @flowcore/cli-plugin-iam
flowcore get user-roles USER_ID
List all IAM roles assigned to a specific user, optionally scoped to a tenant
USAGE
$ flowcore get user-roles USER_ID [--profile <value>] [-j] [-t <value>] [-w]
ARGUMENTS
USER_ID The user ID to get roles for (e.g. auth0|abc123)
FLAGS
-j, --json Output result as JSON
-t, --tenant=<value> Scope results to a specific tenant (organization slug)
-w, --wide Show additional columns in table output
--profile=<value> Specify the configuration profile to use
DESCRIPTION
List all IAM roles assigned to a specific user, optionally scoped to a tenant
EXAMPLES
$ flowcore iam get user-roles "auth0|abc123" -t my-org
$ flowcore iam get user-roles "auth0|abc123" -j
$ flowcore iam get user-roles "auth0|abc123" -t my-org -wSee code: @flowcore/cli-plugin-iam
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 infoSee code: src/commands/info.ts
flowcore login
login to the Flowcore Platform
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 8080See 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 --jsonSee 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-flowcoreSee 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-generatorSee 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-appSee 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-pluginSee 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-flowcoreSee 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 pluginsSee 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/somepluginflowcore 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 mypluginSee 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/somepluginSee 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 mypluginSee 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 mypluginflowcore 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 mypluginSee 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 mypluginflowcore 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 updatesSee 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, first, or last)
-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 -b last
$ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -e 9cb35da2-ba64-4bb5-86d6-ef20ebc62ab7See 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.yamlSee 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.yamlSee 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] [-z <value>] [-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, latest)
-t, --timeout=<value> [default: 5000] Timeout in milliseconds to wait for a response from the destination
-y, --yes skip confirmation
-z, --pageSize=<value> [default: 10000] Page size for the stream
--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>] [-z <value>] [-i] [-x
<value>] [-b <value>] [--profile <value>]
ARGUMENTS
STREAM stream url to connect to
FLAGS
-b, --bufferSize=<value> Buffer size for event processing
-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
-i, --includeSensitiveData Include sensitive data in the output
-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)
-x, --concurrency=<value> [default: 1] Number of events to process concurrently
-z, --pageSize=<value> [default: 10000] Number of events to fetch per page
--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