Quick Start

This guide gets BitRouter routing for your agent in under a minute. There are two deployment modes — and two ways to onboard either mode:

• BitRouter Cloud (default). Hosted endpoint at cloud.bitrouter.ai. No keys to manage; agent-native x402/MPP pay-per-use, or BYOK on top.
• Local proxy. Single binary on your machine, BYOK with your own provider keys. Zero infrastructure dependencies.

Both modes onboard through Agent Skills (let your agent install and configure itself) or the BitRouter CLI / TUI (interactive wizard). Both default to Cloud; switch to local with a single keypress.

Agent Skills

For agent runtimes that support skills (Claude Code, Cursor, Codex, Copilot, etc.). Install once:

npx skills add bitrouter/bitrouter

Then ask your agent: "Set up BitRouter for me." — the agent runs the wizard, picks Cloud by default, and verifies the connection autonomously.

BitRouter CLI

For terminal-first setup. Install the binary:

curl -fsSL https://bitrouter.ai/install.sh | sh

npm install -g bitrouter

brew install bitrouter/tap/bitrouter

cargo install bitrouter

Launch the TUI wizard:

bitrouter

The wizard asks Cloud or local? (default Cloud), prompts for keys if you choose local, then starts the proxy at http://127.0.0.1:4356.

Verify with a request:

curl http://127.0.0.1:4356/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Point any OpenAI-compatible runtime at http://127.0.0.1:4356/v1 to route through BitRouter.

Next Steps

Recipes for connecting specific agent runtimes — Claude Code, OpenClaw, Codex CLI, OpenCode, Kilo Code, and more — live in the Cookbook.