@soku-ai/cli 0.1.0-alpha.1 → 0.1.0-alpha.11

package/README.md

@@ -1,91 +0,0 @@
-# @soku-ai/cli
-
-Call Soku ads/GA4 data capabilities from any shell or AI agent. It's the
-preferred surface for external agents — equivalent to the hosted MCP server, but
-works without an MCP host.
-
-## Install
-
-```bash
-npm i -g @soku-ai/cli
-```
-
-Development builds can be linked from this repo:
-
-```bash
-pnpm --filter @soku-ai/cli run build
-npm link apps/cli
-```
-
-## Quick start
-
-```bash
-soku auth login              # device-login in the browser
-soku org use <slug|id>       # pick a workspace (id, slug, or name)
-soku brand use <slug|id>
-soku --help                  # discover namespaces (ads, ga4, …)
-soku update-check            # check npm for a newer CLI release
-soku ads --help              # actions in a namespace
-soku ads list-ad-accounts --platform google
-```
-
-Each data capability is a typed sub-command under its namespace; `<command>
---help` shows its flags. `soku call <ns> <action>` is a raw escape hatch for
-actions not yet exposed as a typed sub-command.
-
-## Authentication
-
-`soku` uses an org-agnostic, device-login session token (RFC 8628). You log in
-once; the org and brand are chosen at runtime and sent per request.
-
-- **Human:** `soku auth login` opens the browser and waits for approval.
-- **Agent (non-blocking):** `soku auth login --no-wait` returns the verification
-  URL immediately; resume with `soku auth login --device-code <code>` after the
-  user approves.
-- **CI / headless:** set `SOKU_TOKEN` to a pre-issued token to skip interactive
-  auth (and the OS keychain).
-
-Token storage: OS keychain when available, else `~/.soku/credentials.json`
-(0600). Set `SOKU_NO_KEYCHAIN=1` to always use the file. Behind a proxy, set
-`ALL_PROXY`.
-
-## Output
-
-stdout is JSON (`{"ok":true,"data":...}` when piped; pretty when a TTY).
-Errors go to stderr as `{"ok":false,"error":{type,message,hint}}` with a
-semantic exit code (0 ok / 1 usage / 2 auth / 4 not-found / 5 runtime).
-
-## Use from an AI agent
-
-For a fresh agent, point it at the hosted installer guide:
-
-```text
-Read https://soku.ai/cli/skill.md and install the Soku CLI.
-```
-
-Install the bundled skill so Claude Code / Codex / Cursor know how to drive the
-CLI:
-
-```bash
-soku skill install --global        # all detected agents
-soku skill install --agent claude  # one agent, into the project
-```
-
-## Updates
-
-`soku update-check` queries the npm registry for `@soku-ai/cli@latest` and tells
-the user whether `npm i -g @soku-ai/cli` should be re-run. The CLI also performs a
-TTY-only advisory check at most once every 24 hours, cached in
-`~/.soku/update-check.json`. Set `SOKU_NO_UPDATE_CHECK=1` to disable the
-background notice.
-
-## Environment variables
-
-| Variable | Purpose |
-|----------|---------|
-| `SOKU_TOKEN` | Pre-issued session token (overrides stored credentials) |
-| `SOKU_API_BASE` | API base URL override |
-| `SOKU_ORG_ID` / `SOKU_BRAND_ID` | One-off workspace override |
-| `SOKU_NO_KEYCHAIN` | Skip the OS keychain; use the 0600 file |
-| `SOKU_NO_UPDATE_CHECK` | Disable the TTY-only update notice |
-| `ALL_PROXY` | Proxy for outbound HTTPS |