Quickstart

Install the CLI, create an API key, log in, and verify — in under two minutes.

Install bizos-cli globally, create an API key in the dashboard, run bizos login, then bizos whoami to confirm. Every step below is copy-paste-ready.

1. Install the CLI

Requires Node.js 18 or newer.

npm i -g bizos-cli

Verify the install:

bizos --version

2. Create an API key

API keys are created in the web dashboard (they require a logged-in browser session — the CLI itself cannot mint keys).

Open app.bizos.lol.
Go to Settings → API keys.
Click Create key, give it a name (e.g. laptop or claude-code).
Copy the secret — it is shown once and starts with bzk_live_.

See Authentication for how keys are scoped and secured.

3. Log in

bizos login stores the key in ~/.config/bizos/config.json with 0600 (owner-only) permissions. The key is never written to your shell history, logs, or the working directory.

bizos login

You will be prompted to paste your bzk_live_… key. To log in non-interactively (CI, scripts), set the environment variable instead and skip login:

export BIZOS_API_KEY="bzk_live_your_key_here"

4. Verify

bizos whoami

Org:     Acme Inc (org_abc123)
Plan:    pro
Credits: 42

Machine-readable:

bizos whoami --json

{
  "org": { "id": "org_abc123", "name": "Acme Inc" },
  "plan": "pro",
  "credits": 42
}

5. Try a free command

Listing is always free. List your tasks:

bizos tasks list --json

You are ready. Next:

Use with Claude Code — paste one prompt and let an agent drive BizOS.
Commands reference — the full command surface.

Configuration reference

Variable	Purpose	Default
`BIZOS_API_KEY`	API key (overrides the stored key; for CI)	—
`BIZOS_API_URL`	Override the API base URL	`https://app.bizos.lol`
`--api-url <url>`	Per-invocation base-URL override	—

The stored config lives at ~/.config/bizos/config.json (XDG path on macOS/Linux).