@wevion/cli 1.0.2

package/README.md

@@ -0,0 +1,46 @@
+# @wevion/cli — Wevion CLI
+
+Generic, spec-driven command-line interface for the Wevion API. Every command
+is derived at runtime from the public OpenAPI spec — no generated code. CI
+refreshes the bundled `openapi.json` snapshot on every production release.
+The CLI exposes operations that the public spec marks as `apiKeyAuth`.
+
+## Install
+
+```bash
+npm i -g @wevion/cli   # or: npx @wevion/cli list
+```
+
+## Use
+
+```bash
+wevion login                         # prompts for the API key, saves it
+printf '%s' "$WEVION_API_KEY" | wevion login  # non-interactive; avoids shell history
+wevion logout                        # forget the saved key
+wevion list                          # list all commands, grouped by tag
+wevion help <command>                # show a command's flags
+wevion get-api-v1-ad-accounts --limit 10 --search brand
+wevion post-api-v1-ad-accounts-assign-all --connected true
+wevion post-api-v1-ad-accounts-assign-all --json '{"connected":true}'
+```
+
+Credentials & base URL are resolved in this order:
+
+- API key: `WEVION_API_KEY` env → `wevion login` config (`~/.config/wevion/config.json`).
+- Base URL: `--base-url` → `WEVION_BASE_URL` env → config → default `https://api.wevion.ai`
+  (stage: `https://api-stage.wevion.ai`).
+
+## Release
+
+The `publish-cli` job in `.github/workflows/deploy.yml` runs on every push to
+`main` that touches `apps/backend/**` or `packages/cli/**`. It regenerates the
+snapshot from the released source (`dump:openapi`), so the published CLI always
+matches the API at that commit, then `npm publish`es.
+
+Version: `MAJOR.MINOR` comes from this `package.json` (human-owned); the patch
+is the GitHub Actions run number, so every release is unique and monotonic
+(e.g. `1.0.523`). Bump the minor here when there's a meaningful change.
+
+Requires the `NPM_TOKEN` repository secret (automation token with publish
+rights for the `@wevion` scope). If the bundled snapshot is ever absent the CLI
+falls back to fetching `${baseUrl}/docs/json`.