Install
- npm
- pnpm
- yarn
- bun
Sign in
outkit login runs a device-code flow: it opens your browser to the dashboard, you approve
the device, and a token is saved to ~/.outkit/credentials.json (mode 0600).
Confirm your setup:
What the CLI Does
Project setup
outkit init detects your framework, picks a profile, installs the SDK, and writes the
backend proxy.API keys
outkit keys create / rotate / revoke / stats — manage every key without leaving the
terminal.Theme sync
outkit theme detect / apply / sync — pull design tokens from your codebase straight
into your Outkit profile.Local development
outkit dev, outkit logs tail, outkit doctor — run alongside your dev server.Full reference
Every command, flag, env var, and config file the CLI reads or writes.
Files the CLI Manages
| Path | Purpose | Commit? |
|---|---|---|
outkit.json | Repo-local config: version, mode, teamId, profileId, backendUrl?, themeMap? | yes |
outkit.theme.json | Local copy of the active profile’s design tokens | yes |
~/.outkit/credentials.json | Auth token (mode 0600) | never |
~/.outkit/undo.json | Append-only journal feeding outkit undo | never |
~/.outkit/telemetry.log | Local NDJSON log of analytics events | never |
Environment Overrides
| Variable | Default | When to set |
|---|---|---|
OUTKIT_API_BASE_URL | https://api.outkit.dev | Staging or self-hosted backends |
OUTKIT_DASHBOARD_BASE_URL | https://app.outkit.dev | Match an API override |
OUTKIT_DEBUG | unset | Set to 1 to print stack traces on errors |
Next Steps
Quickstart
Five minutes from
outkit init to your first enhanced response.Project setup
What
outkit init writes, framework support, and the outkit.json schema.