@flowcore/cli/README.md

Flowcore CLI for interacting with the Flowcore platform

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

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

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

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
* [or](#or)
* [or](#or-1)
* [Dry-run differences](#dry-run-differences)
* [Apply changes (confirm prompt unless -y)](#apply-changes-confirm-prompt-unless--y)
* [Delete resources from a manifest or stdin](#delete-resources-from-a-manifest-or-stdin)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @flowcore/cli
$ flowcore COMMAND
running command...
$ flowcore (--version)
@flowcore/cli/4.17.1 linux-x64 node-v20.16.0
$ flowcore --help [COMMAND]
USAGE
  $ flowcore COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`flowcore apply`](#flowcore-apply)
* [`flowcore auth delete key API_KEY_NAME`](#flowcore-auth-delete-key-api_key_name)
* [`flowcore auth delete pat PAT`](#flowcore-auth-delete-pat-pat)
* [`flowcore auth delete secret SECRET_KEY`](#flowcore-auth-delete-secret-secret_key)
* [`flowcore auth list key`](#flowcore-auth-list-key)
* [`flowcore auth list pat`](#flowcore-auth-list-pat)
* [`flowcore auth list secret`](#flowcore-auth-list-secret)
* [`flowcore auth new key NAME`](#flowcore-auth-new-key-name)
* [`flowcore auth new pat NAME`](#flowcore-auth-new-pat-name)
* [`flowcore auth new secret NAME`](#flowcore-auth-new-secret-name)
* [`flowcore autocomplete [SHELL]`](#flowcore-autocomplete-shell)
* [`flowcore config ai`](#flowcore-config-ai)
* [`flowcore config set`](#flowcore-config-set)
* [`flowcore config show`](#flowcore-config-show)
* [`flowcore data-core apply`](#flowcore-data-core-apply)
* [`flowcore data-core generate event-type FLOWTYPE`](#flowcore-data-core-generate-event-type-flowtype)
* [`flowcore data-core generate flow-type`](#flowcore-data-core-generate-flow-type)
* [`flowcore data-core init`](#flowcore-data-core-init)
* [`flowcore delete`](#flowcore-delete)
* [`flowcore delete policy NAME`](#flowcore-delete-policy-name)
* [`flowcore delete role NAME`](#flowcore-delete-role-name)
* [`flowcore diff`](#flowcore-diff)
* [`flowcore edit policy NAME`](#flowcore-edit-policy-name)
* [`flowcore edit role NAME`](#flowcore-edit-role-name)
* [`flowcore generate nextjs-entity NAME`](#flowcore-generate-nextjs-entity-name)
* [`flowcore get adapter [ADAPTER]`](#flowcore-get-adapter-adapter)
* [`flowcore get policy [NAME]`](#flowcore-get-policy-name)
* [`flowcore get role [NAME]`](#flowcore-get-role-name)
* [`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-info)
* [`flowcore login`](#flowcore-login)
* [`flowcore logs adapter ADAPTER`](#flowcore-logs-adapter-adapter)
* [`flowcore new bun-service NAME`](#flowcore-new-bun-service-name)
* [`flowcore new generator NAME`](#flowcore-new-generator-name)
* [`flowcore new nextjs-app NAME`](#flowcore-new-nextjs-app-name)
* [`flowcore new plugin NAME`](#flowcore-new-plugin-name)
* [`flowcore new transformer NAME`](#flowcore-new-transformer-name)
* [`flowcore plugins`](#flowcore-plugins)
* [`flowcore plugins add PLUGIN`](#flowcore-plugins-add-plugin)
* [`flowcore plugins:inspect PLUGIN...`](#flowcore-pluginsinspect-plugin)
* [`flowcore plugins install PLUGIN`](#flowcore-plugins-install-plugin)
* [`flowcore plugins link PATH`](#flowcore-plugins-link-path)
* [`flowcore plugins remove [PLUGIN]`](#flowcore-plugins-remove-plugin)
* [`flowcore plugins reset`](#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)
* [`flowcore plugins update check`](#flowcore-plugins-update-check)
* [`flowcore reset adapter ADAPTER`](#flowcore-reset-adapter-adapter)
* [`flowcore scenario apply`](#flowcore-scenario-apply)
* [`flowcore scenario generate transformer`](#flowcore-scenario-generate-transformer)
* [`flowcore scenario init`](#flowcore-scenario-init)
* [`flowcore scenario local`](#flowcore-scenario-local)
* [`flowcore stream STREAM`](#flowcore-stream-stream)
* [`flowcore stream http STREAM`](#flowcore-stream-http-stream)
* [`flowcore update`](#flowcore-update)
* [`flowcore version`](#flowcore-version)
* [`flowcore whoami`](#flowcore-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.yml
```

_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/src/commands/apply.ts)_

## `flowcore auth delete key API_KEY_NAME`

Delete an API key

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

ARGUMENTS
  API_KEY_NAME  Name of the API key to delete

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

DESCRIPTION
  Delete an API key

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

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/delete/key.ts)_

## `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](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/delete/pat.ts)_

## `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](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/delete/secret.ts)_

## `flowcore auth list key`

List all API keys

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

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

DESCRIPTION
  List all API keys

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

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/list/key.ts)_

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

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/list/pat.ts)_

## `flowcore auth list secret`

List all organization secrets

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

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

DESCRIPTION
  List all organization secrets

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

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/list/secret.ts)_

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

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/new/key.ts)_

## `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](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/new/pat.ts)_

## `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=value
```

_See code: [@flowcore/cli-plugin-auth-management](https://github.com/flowcore-io/cli-plugin-auth-management/blob/v1.7.0/src/commands/auth/new/secret.ts)_

## `flowcore autocomplete [SHELL]`

Display autocomplete installation instructions.

```
USAGE
  $ flowcore autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

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

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ flowcore autocomplete

  $ flowcore autocomplete bash

  $ flowcore autocomplete zsh

  $ flowcore autocomplete powershell

  $ flowcore autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.3/src/commands/autocomplete/index.ts)_

## `flowcore config ai`

AI Config

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

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

DESCRIPTION
  AI Config

EXAMPLES
  $ flowcore
```

_See code: [@flowcore/cli-plugin-ai](https://github.com/flowcore-io/cli-plugin-ai/blob/v1.1.2/src/commands/config/ai.ts)_

## `flowcore config set`

Configure the cli

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

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

DESCRIPTION
  Configure the cli

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

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

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

_See code: [@flowcore/cli-plugin-config](https://github.com/flowcore/flowcore-cli-plugin-config/blob/v2.5.0/src/commands/config/set.ts)_

## `flowcore config show`

Show the configured login url

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

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

DESCRIPTION
  Show the configured login url

EXAMPLES
  $ flowcore config show
```

_See code: [@flowcore/cli-plugin-config](https://github.com/flowcore/flowcore-cli-plugin-config/blob/v2.5.0/src/commands/config/show.ts)_

## `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](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.3.0/src/commands/data-core/apply.ts)_

## `flowcore data-core generate event-type FLOWTYPE`

add a event type to a data core manifest

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

FLAGS
  -d, --description=<value>  description of the event type
  -f, --file=<value>         [default: flowcore.yaml] file to modify
  -n, --name=<value>         name of the event type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a event type to a data core manifest

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

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

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

_See code: [@flowcore/cli-plugin-data-core](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.3.0/src/commands/data-core/generate/event-type.ts)_

## `flowcore data-core generate flow-type`

add a flow type to a data core manifest

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

FLAGS
  -d, --description=<value>  description of the flow type
  -f, --file=<value>         [default: flowcore.yaml] file to modify
  -n, --name=<value>         name of the flow type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a flow type to a data core manifest

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

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

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

_See code: [@flowcore/cli-plugin-data-core](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.3.0/src/commands/data-core/generate/flow-type.ts)_

## `flowcore data-core init`

Initialize a data core manifest

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

FLAGS
  -f, --file=<value>     [default: flowcore.yaml] filename it will be created with, defaults to flowcore.yaml
  -o, --overwrite        overwrite the existing data core
  -p, --no-placeholders  use placeholders for the data core
  -t, --tenant=<value>   (required) tenant to apply the data core to, this is the org for your organization, it can be
                         seen in the url when accessing your organization
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Initialize a data core manifest

EXAMPLES
  $ flowcore data-core init -t flowcore

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

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

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

_See code: [@flowcore/cli-plugin-data-core](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.3.0/src/commands/data-core/init.ts)_

## `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](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/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 policy
```

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/delete/policy.ts)_

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

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/delete/role.ts)_

## `flowcore diff`

Diff a resource manifests against the Flowcore Platform

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

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

DESCRIPTION
  Diff a resource manifests against the Flowcore Platform

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

_See code: [src/commands/diff.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/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-tenant
```

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/edit/policy.ts)_

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

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/edit/role.ts)_

## `flowcore generate nextjs-entity NAME`

Create a new NextJS entity using the Flowcore IDD approach

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

ARGUMENTS
  NAME  name of the entity to generate

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

DESCRIPTION
  Create a new NextJS entity using the Flowcore IDD approach

EXAMPLES
  $ flowcore generate nextjs-entity my-entity
```

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/generate/nextjs-entity.ts)_

## `flowcore get adapter [ADAPTER]`

Get adapter

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

ARGUMENTS
  ADAPTER  adapter name or id

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

DESCRIPTION
  Get adapter

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

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

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/get/adapter.ts)_

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

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/get/policy.ts)_

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

_See code: [@flowcore/cli-plugin-iam](https://github.com/flowcore-io/cli-plugin-iam/blob/v1.7.0/src/commands/get/role.ts)_

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

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/get/scenario.ts)_

## `flowcore get tenant [NAME]`

Get tenant

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

ARGUMENTS
  NAME  name

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

DESCRIPTION
  Get tenant

EXAMPLES
  $ flowcore get tenant

  $ flowcore get tenant --tenant=tenant-name

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

_See code: [@flowcore/cli-plugin-tenant-management](https://github.com/flowcore-io/tenant-management/blob/v1.1.1/src/commands/get/tenant.ts)_

## `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](https://github.com/oclif/plugin-help/blob/v6.2.11/src/commands/help.ts)_

## `flowcore info`

Get information about the Flowcore CLI and its configuration

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

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

DESCRIPTION
  Get information about the Flowcore CLI and its configuration

EXAMPLES
  $ flowcore info
```

_See code: [src/commands/info.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/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 8080
```

_See code: [@flowcore/cli-plugin-config](https://github.com/flowcore/flowcore-cli-plugin-config/blob/v2.5.0/src/commands/login.ts)_

## `flowcore logs adapter ADAPTER`

Get adapter logs

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

ARGUMENTS
  ADAPTER  adapter name or id

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

DESCRIPTION
  Get adapter logs

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

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

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

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

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/logs/adapter.ts)_

## `flowcore new bun-service NAME`

Create a new Bun service

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

ARGUMENTS
  NAME  name of the bun service

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

DESCRIPTION
  Create a new Bun service

EXAMPLES
  $ flowcore new bun-service my-service

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

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/new/bun-service.ts)_

## `flowcore new generator NAME`

Create a new generator

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

ARGUMENTS
  NAME  name of the generator

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

DESCRIPTION
  Create a new generator

EXAMPLES
  $ flowcore new generator my-generator
```

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/new/generator.ts)_

## `flowcore new nextjs-app NAME`

Create a new NextJS application using the Flowcore IDD approach

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

ARGUMENTS
  NAME  name of the nextjs app

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

DESCRIPTION
  Create a new NextJS application using the Flowcore IDD approach

EXAMPLES
  $ flowcore new nextjs-app my-app
```

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/new/nextjs-app.ts)_

## `flowcore new plugin NAME`

Create a new plugin

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

ARGUMENTS
  NAME  name of the plugin

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

DESCRIPTION
  Create a new plugin

EXAMPLES
  $ flowcore new plugin my-plugin
```

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/new/plugin.ts)_

## `flowcore new transformer NAME`

Create a new Bun transformer

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

ARGUMENTS
  NAME  name of the bun transformer

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

DESCRIPTION
  Create a new Bun transformer

EXAMPLES
  $ flowcore new transformer my-transformer

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

_See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.6.0/src/commands/new/transformer.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/index.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/inspect.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/install.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/link.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/reset.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/uninstall.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v5.4.7/src/commands/plugins/update.ts)_

## `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](https://github.com/jayree/oclif-plugin-update-notifier/blob/v1.5.84/src/commands/plugins/update/check.ts)_

## `flowcore reset adapter ADAPTER`

Reset a adapter

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

ARGUMENTS
  ADAPTER  adapter name or id

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

DESCRIPTION
  Reset a adapter

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

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

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

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/reset/adapter.ts)_

## `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](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/scenario/apply.ts)_

## `flowcore scenario generate transformer`

add a transformer to a scenario manifest

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

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

DESCRIPTION
  add a transformer to a scenario manifest

EXAMPLES
  $ flowcore scenario generate transformer -n flow-type-name

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

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

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/scenario/generate/transformer.ts)_

## `flowcore scenario init`

Generate a scenario manifest

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

FLAGS
  -f, --file=<value>     [default: flowcore.yaml] file to apply
  -n, --name=<value>     name of the scenario to generate
  -o, --overwrite        overwrite the existing scenario
  -t, --tenant=<value>   (required) tenant to apply the scenario to, this is the org for your organization, it can be
                         seen in the url when accessing your organization
      --placeholder      generate a placeholder manifest
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Generate a scenario manifest

EXAMPLES
  $ flowcore scenario init -t flowcore

  $ flowcore scenario init -t flowcore --placeholder

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

  $ flowcore scenario init -t flowcore -n scenario-name -f example.yaml
```

_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/scenario/init.ts)_

## `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)
  -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](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.5.0/src/commands/scenario/local.ts)_

## `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 stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s first

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

  $ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s first -i

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

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

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

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

_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v5.7.0/src/commands/stream.ts)_

## `flowcore stream http STREAM`

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

```
USAGE
  $ flowcore stream http STREAM [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [-z <value>] [-i] [-x
    <value>] [-b <value>] [--profile <value>] [-d <value>] [-H <value>] [-t <value>]

ARGUMENTS
  STREAM  stream url to connect to

FLAGS
  -H, --header=<value>...     [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN')
  -b, --bufferSize=<value>    Buffer size for event processing
  -c, --scan                  Scan the full time range
  -d, --destination=<value>   [default: http://localhost:3000/transform] Destination to send events to
  -e, --end=<value>           End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
  -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)
  -t, --timeout=<value>       [default: 5000] Timeout in milliseconds to wait for a response from the destination
  -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 stream to a http endpoint

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

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

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

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

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

_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v5.7.0/src/commands/stream/http.ts)_

## `flowcore update`

Update the Flowcore CLI to the latest version

```
USAGE
  $ flowcore update

DESCRIPTION
  Update the Flowcore CLI to the latest version

EXAMPLES
  $ flowcore update
```

_See code: [src/commands/update.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/src/commands/update.ts)_

## `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](https://github.com/oclif/plugin-version/blob/v2.2.12/src/commands/version.ts)_

## `flowcore whoami`

Check what user you are logged in as

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

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

DESCRIPTION
  Check what user you are logged in as
```

_See code: [@flowcore/cli-plugin-config](https://github.com/flowcore/flowcore-cli-plugin-config/blob/v2.5.0/src/commands/whoami.ts)_
<!-- commandsstop -->

### What is this CLI?

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

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

### Requirements

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

### Installation

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

### Quick start

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

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/<org>/<data core>/<flow type>/<event type>.stream" -s 1w --json
```

### Configuration profiles

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

### Included plugins

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

* @flowcore/cli-plugin-config: Configuration and auth utilities. [Repository](https://github.com/flowcore/flowcore-cli-plugin-config)
* @flowcore/cli-plugin-data-core: Data Core authoring commands. [Repository](https://github.com/flowcore/flowcore-cli-data-core)
* @flowcore/cli-plugin-scenario: Scenario authoring, logs and local runners. [Repository](https://github.com/flowcore/flowcore-cli-plugin-scenario)
* @flowcore/cli-plugin-core: Streaming (`stream`, `stream http`). [Repository](https://github.com/flowcore/flowcore-cli-plugin-core)
* @flowcore/cli-plugin-generator: Scaffolding for apps, services, plugins, transformers. [Repository](https://github.com/flowcor