claude-code-router Documentation

Why use Claude Code Router? Copy Chapter

Claude Code Router (CCR) is a local model gateway and control plane for coding agents. It gives Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, WorkBuddy, and compatible API clients one stable local endpoint, while you manage the providers, models, accounts, routing rules, and tools behind it from one place.

Use CCR to:

• Manage all agents and providers together instead of maintaining a separate model configuration for every client.
• Switch providers or models without changing your workflow or repeatedly editing agent configuration files.
• Keep requests running with retries, credential pools, key rotation, and ordered fallback models.
• Add capabilities to existing models with Fusion vision, web search, MCP tools, and ToolHub.
• See what actually happened through request logs, resolved routes, latency, token usage, cost estimates, and account status.

CCR supports OpenAI Chat / Responses, Anthropic Messages, Gemini Generate Content / Interactions, OpenRouter, DeepSeek, SiliconFlow, Moonshot, Kimi Code, Mistral, Z.AI, Bailian, and custom compatible providers.

Supported Agents

Quick Start Copy Chapter

Desktop app (recommended) Copy Section

1. Download Claude Code Router for macOS, Windows, or Linux, then launch the app.

2. Open Providers → Add Provider. Choose a built-in preset or a custom endpoint, enter the API key, select the protocol and models, then save.

3. Open Server and click Start. The local model gateway listens on http://127.0.0.1:3456 by default.

4. Open Agent Config, choose Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, or WorkBuddy, select a model, and apply the profile.

5. Start using your agent. Open Logs to confirm the resolved provider, model, status, tokens, latency, and errors.

Your agent is now connected to CCR. To add conditions, retries, request rewrites, or fallback models, open Routing.

CLI Copy Section

The npm CLI requires Node.js 22 or newer. It starts the same gateway and a browser-based management UI without Electron:

npm install @musistudio/claude-code-router
ccr ui

Open http://127.0.0.1:3458, then follow the same Providers → Server → Agent Profiles flow above. The model gateway remains at http://127.0.0.1:3456. See the CLI reference for service modes, authentication, and profile commands.

Docker Copy Section

docker compose up -d --build

Docker exposes the management UI and gateway routes through http://127.0.0.1:3458 by default. Read the Docker deployment guide before exposing CCR remotely.

Build desktop apps Copy Chapter

Install Node.js 22+, then run npm ci.

Windows app packaging must run on Windows x64 because better-sqlite3 ships a native Electron module. The release workflow builds macOS on macOS runners and Windows on windows-latest when a v* tag is pushed.

How it works Copy Chapter

Claude Code · Claude Design · Codex · Grok CLI · Kimi CLI · Kilo Code · OpenCode · Pi · ZCode · WorkBuddy · Compatible API clients
                              │
                              ▼
                 Claude Code Router :3456
          Profiles · Routing · Credentials · Tools · Logs
                              │
                              ▼
             Selected provider, model, and account

Core capabilities Copy Chapter

Go deeper when you are ready Copy Chapter

The complete documentation lives at ccrdesk.top.

• Install and launch CCR
• Configure providers
• Explore routing and configuration
• Use the CLI
• Deploy with Docker
• Troubleshoot common issues

Support & Sponsoring Copy Chapter

Our Sponsors Copy Section

License Copy Chapter

This project is licensed under the MIT License.