Introduction
What BizOS is, what the CLI does, and the thin-client-over-a-billing-enforced-API model.
BizOS is an autonomous business operator. The
bizosCLI is a thin, secure client over the BizOS API: every command is a call to/api/cli/*, billing is enforced server-side, and the CLI can never bypass it. Built to be driven by AI agents and copy-paste-friendly for humans.
What BizOS is
BizOS runs the operational layer of a business — tasks, documents, lead capture, ad creatives, landing pages, and Meta ad campaigns — behind a single org-scoped account. The web app at app.bizos.lol is the dashboard. This CLI is the terminal-and-agent interface to the same account.
What the CLI does
The bizos command lets you, from a terminal or an AI agent:
- Run tasks — queue and execute agent tasks (
bizos tasks ...). - Manage documents — read and create org documents (
bizos docs ...). - Read leads — list captured prospects (
bizos leads ...). - Generate creatives — produce ad images (
bizos creative generate ...). - Manage landing pages — list and create pages (
bizos landing ...). - Read Meta data — campaigns and insights, read-only (
bizos meta ...). - Inspect billing — wallet balance and plan/credits (
bizos wallet,bizos billing). - Read notifications — list and mark read (
bizos notifications ...).
Every command supports --json for machine-readable output, which is what makes the CLI ideal for agents.
The model: a thin client over a billing-enforced API
The CLI holds no business logic. It authenticates with an API key and forwards your intent to the BizOS API. The server:
- Resolves your org from the key — every request is scoped to exactly one organization.
- Enforces rate limits per key.
- Enforces billing: credit-spending actions reserve a credit before running and refund it on failure, reusing the exact same billing library the web app uses.
Because billing lives on the server, there is no way for the CLI (or an agent driving it) to run a paid action for free.
Credits
Paid actions consume credits. The rule is simple:
1 credit = 1 task run, or 1 creative generated.
Everything else — listing, reading, creating documents, reading leads, reading wallet/billing — is free. Only two commands spend credits:
| Command | Cost |
|---|---|
bizos tasks run <id> | ⚠️ 1 credit |
bizos creative generate | ⚠️ 1 credit |
Credit-spending commands require an explicit --yes flag (or an interactive confirmation) so neither you nor an agent spends a credit by accident. See Billing & credits for how the wallet and top-ups work.
Next steps
- Quickstart — install, create a key, log in.
- Use with Claude Code — the headline use case: drive BizOS from an AI agent.
- Commands reference — every command, flag, and JSON output.
- API reference — call
/api/cli/*directly.