@flowcore/cli 4.17.0 → 4.17.1

package/CHANGELOG.md

@@ -10,6 +10,13 @@
 
 * added description to start that includes week ([58687a7](https://github.com/flowcore-io/flowcore-cli/commit/58687a7bbb66aaa5d6da26af88e555cbb1e72467))
 
+## [4.17.1](https://github.com/flowcore-io/flowcore-cli/compare/v4.17.0...v4.17.1) (2025-08-19)
+
+
+### Bug Fixes
+
+* **package:** :arrow_up: update @flowcore/cli-plugin-scenario to version 4.5.0 ([f02c587](https://github.com/flowcore-io/flowcore-cli/commit/f02c5870c9dc84c3c731d4cc27716c1b77bf7ba9))
+
 ## [4.17.0](https://github.com/flowcore-io/flowcore-cli/compare/v4.16.0...v4.17.0) (2025-07-10)
 
 

package/README.md

@@ -10,6 +10,11 @@ Flowcore CLI is a command line interface for interacting with the Flowcore Platf
 <!-- 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 -->
@@ -18,7 +23,7 @@ $ npm install -g @flowcore/cli
 $ flowcore COMMAND
 running command...
 $ flowcore (--version)
-@flowcore/cli/4.17.0 linux-x64 node-v20.16.0
+@flowcore/cli/4.17.1 linux-x64 node-v20.16.0
 $ flowcore --help [COMMAND]
 USAGE
   $ flowcore COMMAND
@@ -109,7 +114,7 @@ EXAMPLES
   $ flowcore apply -f ./path/to/manifest.yml
 ```
 
-_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.0/src/commands/apply.ts)_
+_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`
 
@@ -562,7 +567,7 @@ EXAMPLES
   cat ./path/to/manifest.yml | flowcore delete -f -
 ```
 
-_See code: [src/commands/delete.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.0/src/commands/delete.ts)_
+_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`
 
@@ -629,7 +634,7 @@ EXAMPLES
   $ flowcore diff -f ./path/to/manifest.yml
 ```
 
-_See code: [src/commands/diff.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.0/src/commands/diff.ts)_
+_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`
 
@@ -731,7 +736,7 @@ EXAMPLES
   $ 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.4.0/src/commands/get/adapter.ts)_
+_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]`
 
@@ -804,7 +809,7 @@ EXAMPLES
   $ flowcore get scenario scenario-name -t tenant-name
 ```
 
-_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.4.0/src/commands/get/scenario.ts)_
+_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]`
 
@@ -873,7 +878,7 @@ EXAMPLES
   $ flowcore info
 ```
 
-_See code: [src/commands/info.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.0/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/src/commands/info.ts)_
 
 ## `flowcore login`
 
@@ -930,7 +935,7 @@ EXAMPLES
   $ 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.4.0/src/commands/logs/adapter.ts)_
+_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`
 
@@ -1385,7 +1390,7 @@ EXAMPLES
   $ 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.4.0/src/commands/reset/adapter.ts)_
+_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`
 
@@ -1415,7 +1420,7 @@ EXAMPLES
   $ cat <<EOF | flowcore scenario apply -f -
 ```
 
-_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.4.0/src/commands/scenario/apply.ts)_
+_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`
 
@@ -1442,7 +1447,7 @@ EXAMPLES
   $ 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.4.0/src/commands/scenario/generate/transformer.ts)_
+_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`
 
@@ -1474,7 +1479,7 @@ EXAMPLES
   $ 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.4.0/src/commands/scenario/init.ts)_
+_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`
 
@@ -1507,7 +1512,7 @@ EXAMPLES
   $ cat <<EOF | flowcore scenario local -f -
 ```
 
-_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v4.4.0/src/commands/scenario/local.ts)_
+_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`
 
@@ -1621,7 +1626,7 @@ EXAMPLES
   $ flowcore update
 ```
 
-_See code: [src/commands/update.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.0/src/commands/update.ts)_
+_See code: [src/commands/update.ts](https://github.com/flowcore-io/flowcore-cli/blob/v4.17.1/src/commands/update.ts)_
 
 ## `flowcore version`
 
@@ -1660,3 +1665,113 @@ DESCRIPTION
 
 _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/flowcore/flowcore-cli-plugin-generator)
+* @flowcore/cli-plugin-auth-management: API keys and secrets management. [Repository](https://github.com/flowcore-io/cli-plugin-auth-management)
+* @flowcore/cli-plugin-tenant-management: Tenant retrieval and management. [Repository](https://github.com/flowcore-io/tenant-management)
+* @flowcore/cli-plugin-ai: AI configuration helpers. [Repository](https://github.com/flowcore-io/cli-plugin-ai)
+* @flowcore/cli-plugin-iam: Identity and access management helpers. [Repository](https://github.com/flowcore-io/cli-plugin-iam)
+
+Refer to each plugin’s README for complete command references. The autogenerated section above also lists available commands as detected at build time.
+
+### Shell autocompletion
+
+Enable autocompletion for your shell:
+
+```bash
+flowcore autocomplete
+```
+
+### Update checks and first-run behavior
+
+* The CLI periodically checks for updates and will warn if a newer version is available.
+* On first run, a small hook adds the JSR registry mapping to the CLI data directory’s `.npmrc` so JSR-scoped packages resolve correctly.
+
+### Environment variables
+
+| Variable | Type | Description | Default | Required |
+|----------|------|-------------|----------|----------|
+| FLOWCORE_NPM_LOG_LEVEL | string | Log level for npm operations used by plugin management | - | |
+| FLOWCORE_NPM_REGISTRY | string | Custom npm registry for plugin installation and updates | - | |
+
+### Troubleshooting
+
+* Run `flowcore info` to print locations for data, config, and cache directories.
+* Use `--json` on commands that support it for machine-readable output.
+* If you see permission issues with global installs, consider using a Node version manager (nvm) or `corepack`.

package/oclif.manifest.json

@@ -196,5 +196,5 @@
       ]
     }
   },
-  "version": "4.17.0"
+  "version": "4.17.1"
 }

package/package.json

@@ -13,7 +13,7 @@
     "@flowcore/cli-plugin-data-core": "^3.3.0",
     "@flowcore/cli-plugin-generator": "^1.6.0",
     "@flowcore/cli-plugin-iam": "^1.7.0",
-    "@flowcore/cli-plugin-scenario": "^4.4.0",
+    "@flowcore/cli-plugin-scenario": "^4.5.0",
     "@flowcore/cli-plugin-tenant-management": "^1.1.1",
     "@flowcore/sdk": "^1.50.0",
     "@flowcore/time-bucket": "^1.1.0",
@@ -119,7 +119,7 @@
     "prestart": "npm run build",
     "update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
   },
-  "version": "4.17.0",
+  "version": "4.17.1",
   "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
   "keywords": [
     "flowcore",