claude-code-router README

The project's README from github.com/musistudio/claude-code-router. As one markdown file: README.md.

Kimi K2.7 Code sponsor banner
Kimi Code Subscription  ·  API Global  ·  API China

Thanks to Kimi for sponsoring this project! Kimi K3 is Moonshot AI's most capable model and the world's first open 3T-class model. With 2.8 trillion parameters, native vision, and a 1-million-token context window, K3 delivers frontier performance across long-horizon coding, knowledge work, and reasoning. Inside CCR, Kimi ships as a built-in provider preset: import the pay-as-you-go API or Kimi Code subscription in one click and route your coding agent's requests to Kimi. The subscription endpoint passes through natively without protocol conversion, API endpoints are adapted automatically, and account balance and subscription usage are visible in the CCR dashboard.

CCR already includes Kimi provider presets. Visit the Kimi Open Platform (中文站 | Global) to try the API, or explore the Kimi Code subscription.

Claude Code Router

Manage every agent and provider from one place.

Connect Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, WorkBuddy, and compatible API clients to the providers you choose—then route, fail over, extend, and observe every request from one app.

Download Desktop Quick Start Read the Docs

Chinese README Discord X License


Claude Code Router Desktop dashboard

Why use Claude Code Router?

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:

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
Claude Code logo
Claude Code (CLI & APP) 		Codex logo
Codex (CLI & APP) 		Grok CLI logo
Grok CLI (CLI) 		Kimi CLI logo
Kimi CLI (CLI) 		Kilo Code logo
Kilo Code (CLI)
OpenCode logo
OpenCode (CLI & APP) 		Pi logo
Pi (CLI) 		ZCode logo
ZCode (APP) 		Claude Design logo
Claude Design (APP) 		WorkBuddy logo
WorkBuddy (APP)

Quick Start

  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

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

npm install -g @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

npm run docker:compose:up

Docker exposes the management UI and gateway routes through http://127.0.0.1:3458 by default. The npm script prepares the local plugin-capable ai-gateway runtime before building the image when ../../next-ai/gateway exists. Read the Docker deployment guide before exposing CCR remotely.

Build desktop apps

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

Target Command Output
macOS local DMG/ZIP npm run build:app:mac release-local/
Windows local NSIS installer npm run build:app:win release-local/

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

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

Area Highlights
Agents Profiles for Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, Kilo Code, OpenCode, Pi, ZCode, and WorkBuddy; model overrides; scopes; environment settings; CLI and app launch entries; multi-instance workflows
Providers Presets and custom endpoints; protocol probing; model discovery; connectivity checks; local login import where supported; single keys and credential pools
Models & routing Searchable catalog; model descriptions for task selection; conditions on headers and bodies; prefixes; rewrites; retries; ordered fallbacks
Tools & extensions Fusion models; ToolHub; built-in browser automation; Chrome login-state import; wrapper and core gateway plugins; local routes and virtual models
Access & quotas Separate CCR client keys with expiration and local request, token, and image limits
Observability Request and response details; resolved provider, model, and credential; status; latency; tokens; estimated cost; tool calls; agent traces
AgentClaw Agent relay through Weixin iLink, WeCom, Slack, Discord, Telegram, LINE, Feishu, and DingTalk

Go deeper when you are ready

The complete documentation lives at ccrdesk.top.

Support & Sponsoring

If you find this project helpful, please consider sponsoring its development. Your support is greatly appreciated.

Support on Ko-fi
One-time support via Ko-fi 		Sponsor with PayPal
International sponsorship
Alipay
Alipay QR code 		WeChat Pay
WeChat Pay QR code

Our Sponsors

A huge thank you to all our sponsors for their generous support.

Zhipu icon
Z智谱 		AIHubmix icon
AIHubmix 		BurnCloud icon
BurnCloud 		302.AI icon
302.AI
RunAPI icon
RunAPI 		TeamoRouter icon
TeamoRouter 		code0.ai icon
code0.ai 		claudeapi icon
claudeapi
Qiniu Cloud AI icon
Qiniu Cloud AI 		Fenno.ai icon
Fenno.ai 		Unity2.Ai icon
Unity2.Ai 		无限星河 icon
无限星河

Community Sponsors

@Simon Leischnig @duanshuaimin @vrgitadmin @*o @ceilwoo @*说
@*更 @K*g @R*R @bobleer @*苗 @*划
@Clarence-pan @carter003 @S*r @*晖 @*敏 @Z*z
@*然 @cluic @*苗 @PromptExpert @*应 @yusnake

claude-code-router (musistudio/claude-code-router)

Searching Database…

37.7K ·GitHub
Claude-code-router
What is this?Claude Code Router (CCR) is a local model gateway and control plane for coding agents: your agents get one stable local endpoint while you manage providers, models, routing rules, and tools from one app.
Is this a desktop app or a CLI tool?Both. The recommended path is a desktop app for macOS, Windows, and Linux; an npm CLI runs the same gateway with a browser-based management UI instead of Electron, and there is a Docker image too.
How do I get it running?Launch the app, add a provider (pick a preset, paste the API key, select models), click Start on the Server page, then in Agent Config pick your agent and a model and apply the profile.
Which coding agents can I point at it?Claude Code and Codex in CLI and app form, Grok CLI, Kimi CLI, Kilo Code, and Pi as CLIs, OpenCode in both, and ZCode, Claude Design, and WorkBuddy as apps — plus any compatible API client.
Any install pitfalls to know about?The CLI needs Node.js 22 or newer, and building the Windows installer must happen on Windows x64 because better-sqlite3 ships a native Electron module; Docker deployments should follow the deployment guide first.
Does my traffic stay on my machine?Yes — CCR is a local gateway that runs on your machine and forwards requests to the providers you configure; the docs only warn to read the Docker deployment guide before exposing it remotely.
Why use one control plane instead of configuring each agent separately?Without CCR you maintain a separate model configuration for every client. With CCR, agents and providers are managed together: switching models or providers means applying a profile in one app instead of repeatedly editing each agent's config files.
Can I control who is allowed to use my gateway?Yes — you can issue separate CCR client keys with expiration and set local limits on requests, tokens, and images, so shared access stays under your control.
What is AgentClaw?A built-in relay that connects your agents to chat platforms: Weixin iLink, WeCom, Slack, Discord, Telegram, LINE, Feishu, and DingTalk — so agents can be driven from messengers you already use.
What are similar projects?gateway, bifrost, casbin-gateway, ThinkWatch-Lite, litellm, OmniRoute, PilotDeck, evenfire
Which topics is it in?model-router, gateway, api-gateway, observability, electron, proxy, desktop, codex, claude-code, mcp, ai-agents, server
Creator
musistudio
Size
45.7 MB
Stars
37.7K
Updated
CommitOct 10Releasev3.1.3Oct 09
Age
1y
Commits · 90 Days