@ciandt-flow/cli 1.0.3 → 1.0.4

package/README.md

@@ -2,336 +2,175 @@
 
 TUI for browsing and installing Claude Code plugins from the Flow ecosystem.
 
-## Quick Start
+## Installation
 
 ```bash
-bun install
-cp .env.example .env
-bun run dev
+npm install -g @ciandt-flow/cli
 ```
 
-> Copy `.env.example` to `.env` and adjust the values as needed before running the project.
-
-## Development
+## Quick Start
 
 ```bash
-bun run build        # Compile TypeScript
-bun run test         # Run tests
-bun run lint         # Lint check
-bun run format       # Format + lint fix
-```
-
-## CLI Commands
-
-### `setup`
-
-Setup and configuration commands.
-
-#### `setup init`
-
-Initialize Flow CLI configuration.
+# Authenticate with your Flow credentials
+flow auth login
 
-```bash
-bun dev setup init
+# Launch the interactive plugin browser
+flow
 ```
 
----
-
-### `plugin`
-
-Plugin management commands.
-
-#### `plugin list`
-
-List plugins.
+## Commands
 
-```bash
-flow-plugins plugin list [options]
-```
+### `flow` (no arguments)
 
-| Option | Description |
-|---|---|
-| `--available` | Show all plugins from catalog with install status |
-| `--outdated` | Show installed plugins with updates available |
-| `--json` | Output as JSON |
+Launches the interactive TUI to browse and manage plugins.
 
-```bash
-# list installed plugins (default)
-bun dev plugin list
-
-# list all plugins from catalog
-bun dev plugin list --available
+---
 
-# list plugins with updates available
-bun dev plugin list --outdated
+### `auth`
 
-# output as JSON
-bun dev plugin list --json
-bun dev plugin list --available --json
-```
+Authentication commands.
 
-#### `plugin install <name...>`
+#### `auth login`
 
-Install one or more plugins from the Findr catalog.
+Authenticate and save credentials.
 
 ```bash
-flow-plugins plugin install <name...> [options]
+flow auth login [options]
 ```
 
 | Option | Description |
 |---|---|
-| `--force` | Reinstall even if the version is already installed |
-| `--verbose` | Display each step of the installation process |
-| `--silent` | Output in JSON only |
-
-```bash
-# install a single plugin
-bun dev plugin install flow-adr-writer
-
-# install multiple plugins
-bun dev plugin install flow-adr-writer flow-prd-writer startup-pack-ai
-
-# force reinstall
-bun dev plugin install flow-adr-writer --force
-
-# silent (JSON output)
-bun dev plugin install flow-adr-writer --silent
-```
-
-#### `plugin uninstall <id>`
+| `--client-id <id>` | Client ID |
+| `--client-secret <secret>` | Client Secret |
+| `--tenant <tenant>` | Tenant |
 
-Uninstall a plugin by ID.
+When called **without options**, enters interactive mode — prompts for each field in the terminal.
+When called **with all three options**, runs non-interactively and saves credentials directly.
 
 ```bash
-bun dev plugin uninstall <id>
-```
-
-#### `plugin enable <id>`
-
-Enable an installed plugin.
+# interactive mode
+flow auth login
 
-```bash
-bun dev plugin enable <id>
+# non-interactive mode
+flow auth login --client-id <id> --client-secret <secret> --tenant <tenant>
 ```
 
-#### `plugin disable <id>`
+#### `auth logout`
 
-Disable an installed plugin.
+Remove saved credentials.
 
 ```bash
-bun dev plugin disable <id>
+flow auth logout [--force]
 ```
 
-#### `plugin update [name]`
-
-Update plugins to the latest version. Omit the name to update all installed plugins.
-
-```bash
-flow-plugins plugin update [name] [options]
-```
+#### `auth status`
 
-| Option | Description |
-|---|---|
-| `--force` | Force update even if already on latest version |
-| `--dry-run` | Show what would be updated without making changes |
-| `--verbose` | Display each step of the update process |
-| `--silent` | Output in JSON only |
+Show current authentication status.
 
 ```bash
-# update a specific plugin
-bun dev plugin update flow-adr-writer
-
-# force update
-bun dev plugin update flow-adr-writer --force
-
-# dry-run (preview only)
-bun dev plugin update flow-adr-writer --dry-run
-
-# verbose (detailed logs)
-bun dev plugin update flow-adr-writer --verbose
-
-# silent (JSON output)
-bun dev plugin update flow-adr-writer --silent
-
-# update all plugins
-bun dev plugin update
-
-# dry-run all
-bun dev plugin update --dry-run
+flow auth status
 ```
 
 ---
 
-### `auth`
+### `plugin`
 
-Authentication commands.
+Plugin management commands.
 
-#### `auth login`
+#### `plugin list`
 
-Authenticate and save credentials.
+List plugins.
 
 ```bash
-flow-plugins auth login [options]
+flow plugin list [options]
 ```
 
 | Option | Description |
 |---|---|
-| `--client-id <id>` | Client ID |
-| `--client-secret <secret>` | Client Secret |
-| `--tenant <tenant>` | Tenant |
-
-When called **without options**, enters interactive mode — prompts for each field in the terminal. The tenant field is pre-filled if one is detected from the environment.
-
-When called **with all three options**, runs non-interactively and saves credentials directly.
+| `--available` | Show all plugins from catalog with install status |
+| `--outdated` | Show installed plugins with updates available |
+| `--json` | Output as JSON |
 
 ```bash
-# interactive mode
-bun dev auth login
-
-# non-interactive mode
-bun dev auth login --client-id aa --client-secret bbb --tenant cit-dev
+flow plugin list                  # list installed plugins
+flow plugin list --available      # list all plugins from catalog
+flow plugin list --outdated       # list plugins with updates available
+flow plugin list --json           # output as JSON
 ```
 
-#### `auth logout`
+#### `plugin install <name...>`
 
-Remove saved credentials.
+Install one or more plugins.
 
 ```bash
-flow-plugins auth logout [options]
+flow plugin install <name...> [options]
 ```
 
 | Option | Description |
 |---|---|
-| `--force` | Skip confirmation prompt |
+| `--force` | Reinstall even if already installed |
+| `--verbose` | Display each installation step |
+| `--silent` | Output as JSON only |
 
 ```bash
-# with confirmation prompt
-bun dev auth logout
-
-# skip confirmation
-bun dev auth logout --force
+flow plugin install flow-adr-writer
+flow plugin install flow-adr-writer flow-prd-writer
+flow plugin install flow-adr-writer --force
 ```
 
-#### `auth status`
+#### `plugin uninstall <id>`
 
-Show authentication status.
+Uninstall a plugin by ID.
 
 ```bash
-bun dev auth status
+flow plugin uninstall <id>
 ```
 
----
+#### `plugin enable <id>` / `plugin disable <id>`
 
-### `health`
-
-Run diagnostic checks.
+Enable or disable an installed plugin.
 
 ```bash
-bun dev health
+flow plugin enable <id>
+flow plugin disable <id>
 ```
 
-## Logging
-
-The CLI uses a dual-mode logger that adapts to the execution context.
-
-### TUI mode (interactive)
-
-When running without arguments (`flow`), Ink owns stdout. All logs go to **stderr** and a **log file** at `~/.flow/logs/flowsetup.log`.
+#### `plugin update [name]`
 
-- Default level: **warn** (only warnings and errors)
-- Use the `DEBUG` env var to enable debug output:
+Update plugins to the latest version. Omit the name to update all installed plugins.
 
 ```bash
-# all modules
-DEBUG=flow:* bun run dev
-
-# specific module only (others stay at warn+)
-DEBUG=flow:installer bun run dev
+flow plugin update [name] [options]
 ```
 
-### CLI mode (subcommands)
-
-When running a subcommand (e.g. `flow plugin install`), the logger writes to **stdout** by default.
-
-| Flag | Behavior |
+| Option | Description |
 |---|---|
-| _(none)_ | Plain text to stdout, **info** level and above |
-| `--verbose` | Timestamped output to stderr, **debug** level and above |
-| `--silent` | JSON to stdout (info/debug) or stderr (warn/error) |
+| `--force` | Force update even if already on latest version |
+| `--dry-run` | Preview what would be updated without making changes |
+| `--verbose` | Display each update step |
+| `--silent` | Output as JSON only |
 
 ```bash
-flow plugin install my-plugin --verbose
-flow plugin install my-plugin --silent
-flow plugin update my-plugin --verbose
-flow plugin update my-plugin --silent
+flow plugin update flow-adr-writer
+flow plugin update                  # update all
+flow plugin update --dry-run        # preview only
 ```
 
-### Credential sanitization
-
-Every log message is automatically sanitized before being written. The following patterns are masked:
-
-- Bearer tokens
-- JWT tokens (`eyJ...` three-segment format)
-- Long base64 strings (>40 chars)
-
-### Log file rotation
-
-The log file at `~/.flow/logs/flowsetup.log` is truncated when it exceeds **5 MB** at startup.
-
 ---
 
-## Versioning & Releases
-
-This project uses [Changesets](https://github.com/changesets/changesets) for version management and automated releases.
-
-### How it works
-
-1. Developers add a **changeset** describing their changes before opening a PR
-2. On merge to `main`, a GitHub Action detects pending changesets and opens a **"Version Packages"** PR
-3. That PR bumps the version in `package.json`, updates `CHANGELOG.md`, and removes consumed changesets
-4. Merging the Version Packages PR triggers an automated **npm publish** with provenance
-
-The version is read at runtime from `package.json` — there is no hardcoded version constant to keep in sync.
-
-### Adding a changeset
-
-After making your changes and before opening a PR, run:
-
-```bash
-bunx changeset
-```
-
-You'll be prompted to:
-- Select the semver bump type (`patch`, `minor`, or `major`)
-- Write a summary of the change (this goes into the CHANGELOG)
-
-This creates a markdown file in `.changeset/`. Commit it with your PR.
-
-> **When to use each bump type:**
-> - `patch` — bug fixes, docs, internal refactors
-> - `minor` — new features, non-breaking additions
-> - `major` — breaking changes
+### `health`
 
-### Release scripts
+Run diagnostic checks.
 
 ```bash
-bun run changeset          # Add a new changeset
-bun run version-packages   # Apply pending changesets (bump version + CHANGELOG)
-bun run release            # Build + publish to npm
+flow health
 ```
 
-These are used by CI — you typically only need `bunx changeset` locally.
-
-### CI/CD
+---
 
-| Workflow | Trigger | What it does |
-|---|---|---|
-| `ci.yml` | Pull requests to `main` | Runs lint, test, and build |
-| `release.yml` | Push to `main` | Runs CI checks, then creates a Version Packages PR or publishes to npm |
+## Versioning
 
-The release workflow requires two secrets configured in the repository:
-- `GITHUB_TOKEN` — provided automatically by GitHub Actions
-- `NPM_TOKEN` — npm access token with publish permissions
+This project follows [Semantic Versioning](https://semver.org/). See [CHANGELOG.md](https://github.com/CI-T-HyperX/flow-plugins-cli/blob/main/CHANGELOG.md) for release history.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ciandt-flow/cli",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "TUI for browsing and installing Claude Code plugins from the Flow ecosystem",
   "type": "module",
   "main": "dist/index.js",