Back to Claude Code Router

README

README.md

3.0.1622.5 KB
Original Source
<div align="center"> <table width="100%"> <tr> <td align="center"> <a href="https://www.kimi.com/code?aff=ccr">
  </a>
  

  <sub>
    <a href="https://www.kimi.com/code?aff=ccr"><strong>Kimi Code Subscription</strong></a>
    &nbsp;·&nbsp;
    <a href="https://platform.kimi.ai?aff=ccr"><strong>API Global</strong></a>
    &nbsp;·&nbsp;
    <a href="https://platform.kimi.com?aff=ccr">API China</a>
  </sub>
</td>
</tr> <tr> <td align="left"> <p> <strong>Thanks to Kimi for sponsoring this project!</strong> 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. </p> <p align="center"> CCR already includes Kimi provider presets. Visit the Kimi Open Platform (<a href="https://platform.kimi.com?aff=ccr">中文站</a> | <a href="https://platform.kimi.ai?aff=ccr">Global</a>) to try the API, or explore the <a href="https://www.kimi.com/code?aff=ccr">Kimi Code subscription</a>. </p> </td> </tr> </table> </div> <div align="center">

Claude Code Router

Manage every agent and provider from one place.

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

<p> <a href="https://github.com/musistudio/claude-code-router/releases"></a> <a href="#quick-start"></a> <a href="https://ccrdesk.top/"></a> </p> <p> <a href="README_zh.md"></a> <a href="https://discord.gg/rdftVMaUcS"></a> <a href="https://x.com/musistudio2026"></a> <a href="https://github.com/musistudio/claude-code-router/blob/main/LICENSE"></a> </p> </div>

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, OpenCode, Pi, ZCode, 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.

<details open> <summary><strong>Supported Agents</strong></summary> <div align="center"> <table width="100%"> <tr> <td align="center" width="330"> <a href="https://github.com/anthropics/claude-code">
    <strong>Claude Code (CLI & APP)</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://github.com/openai/codex">
    
    

    <strong>Codex (CLI & APP)</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://github.com/xai-org/grok-build">
    
    

    <strong>Grok CLI (CLI)</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://github.com/MoonshotAI/kimi-cli">
    
    

    <strong>Kimi CLI (CLI)</strong>
  </a>
</td>
</tr> <tr> <td align="center" width="330"> <a href="https://github.com/anomalyco/opencode">
    <strong>OpenCode (CLI & APP)</strong>
  </a>
</td>
<td align="center" width="330">
  <span>
    
    

    <strong>Pi (CLI)</strong>
  </span>
</td>
<td align="center" width="330">
  <a href="https://zcode.z.ai/en">
    
    

    <strong>ZCode (APP)</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://claude-design.ccrdesk.top/design">
    
    

    <strong>Claude Design (APP)</strong>
  </a>
</td>
</tr> </table> </div> </details>

Quick Start

  1. <details open> <summary><strong>Download Claude Code Router for macOS, Windows, or Linux, then launch the app.</strong></summary> <div align="center"> <table width="100%"> <tr> <td align="center" width="330"> <a href="https://github.com/musistudio/claude-code-router/releases/download/v3.0.16/Claude-Code-Router_3.0.16.exe">
        <strong>Windows</strong>
      </a>
    </td>
    <td align="center" width="330">
      <a href="https://github.com/musistudio/claude-code-router/releases/download/v3.0.16/Claude-Code-Router_3.0.16.AppImage">
        
        
    
        <strong>Linux</strong>
      </a>
    </td>
    <td align="center" width="330">
      <a href="https://github.com/musistudio/claude-code-router/releases/download/v3.0.16/Claude-Code-Router_3.0.16-mac-Apple-Silicon-arm64.dmg">
        
        
    
        <strong>macOS (Apple Silicon)</strong>
      </a>
    </td>
    <td align="center" width="330">
      <a href="https://github.com/musistudio/claude-code-router/releases/download/v3.0.16/Claude-Code-Router_3.0.16-mac-Intel-x64.dmg">
        
        
    
        <strong>macOS (Intel)</strong>
      </a>
    </td>
    
    </tr> </table> </div> </details>
  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, OpenCode, Pi, or ZCode, 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:

sh
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

sh
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.

How it works

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

Core capabilities

AreaHighlights
AgentsProfiles for Claude Code, Claude Design, Codex, Grok CLI, Kimi CLI, OpenCode, Pi, and ZCode; model overrides; scopes; environment settings; CLI and app launch entries; multi-instance workflows
ProvidersPresets and custom endpoints; protocol probing; model discovery; connectivity checks; local login import where supported; single keys and credential pools
Models & routingSearchable catalog; model descriptions for task selection; conditions on headers and bodies; prefixes; rewrites; retries; ordered fallbacks
Tools & extensionsFusion models; ToolHub; built-in browser automation; Chrome login-state import; wrapper and core gateway plugins; local routes and virtual models
Access & quotasSeparate CCR client keys with expiration and local request, token, and image limits
ObservabilityRequest and response details; resolved provider, model, and credential; status; latency; tokens; estimated cost; tool calls; agent traces
AgentClawAgent 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

<div align="center"> <p>If you find this project helpful, please consider sponsoring its development. Your support is greatly appreciated.</p> <table> <tr> <td align="center" width="220"> <a href="https://ko-fi.com/F1F31GN2GM">
  </a>
  

  <sub>One-time support via Ko-fi</sub>
</td>
<td align="center" width="220">
  <a href="https://paypal.me/musistudio1999">
    
  </a>
  

  <sub>International sponsorship</sub>
</td>
</tr> </table> <table> <tr> <td align="center" width="220"> <strong>Alipay</strong>
</td>
<td align="center" width="220">
  <strong>WeChat Pay</strong>
  

  
</td>
</tr> </table> </div>

Our Sponsors

<div align="center"> <p>A huge thank you to all our sponsors for their generous support.</p> <table width="100%"> <tr> <td align="center" width="330"> <a href="https://www.bigmodel.cn/claude-code?ic=FPF9IVAGFJ">
    <strong>Z智谱</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://aihubmix.com/">
    
    

    <strong>AIHubmix</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://ai.burncloud.com">
    
    

    <strong>BurnCloud</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://share.302.ai/ZGVF9w">
    
    

    <strong>302.AI</strong>
  </a>
</td>
</tr> <tr> <td align="center" width="330"> <a href="https://runapi.co/register?aff=IX1t">
    <strong>RunAPI</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://teamorouter.com/">
    
    

    <strong>TeamoRouter</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://code0.ai/agent/register/9n9jOsSnYQoemIVL?utm_source=claudecoderouter&amp;utm_medium=partner&amp;utm_campaign=claudecoderouter_2026&amp;utm_content=default">
    
    

    <strong>code0.ai</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://console.claudeapi.com/agent/register/LbmB7Y9kPloyzhwF?utm_source=claudecoderouter&amp;utm_medium=partner&amp;utm_campaign=claudecoderouter_2026&amp;utm_content=default">
    
    

    <strong>claudeapi</strong>
  </a>
</td>
</tr> <tr> <td align="center" width="330"> <a href="https://s.qiniu.com/AVjMVf">
    <strong>Qiniu Cloud AI</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://api.fenno.ai/register?redirect=/purchase?tab=subscription%26group=16&amp;aff=9HHHAB5QLAES">
    
    

    <strong>Fenno.ai</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://unity2.ai/register?source=claudecoderouter">
    
    

    <strong>Unity2.Ai</strong>
  </a>
</td>
<td align="center" width="330">
  <a href="https://infistar.ai">
    
    

    <strong>无限星河</strong>
  </a>
</td>
</tr> </table> <h4>Community Sponsors</h4> <table width="100%"> <tr> <td align="center" width="220">@Simon Leischnig</td> <td align="center" width="220"><a href="https://github.com/duanshuaimin">@duanshuaimin</a></td> <td align="center" width="220"><a href="https://github.com/vrgitadmin">@vrgitadmin</a></td> <td align="center" width="220">@*o</td> <td align="center" width="220"><a href="https://github.com/ceilwoo">@ceilwoo</a></td> <td align="center" width="220">@*说</td> </tr> <tr> <td align="center" width="220">@*更</td> <td align="center" width="220">@K*g</td> <td align="center" width="220">@R*R</td> <td align="center" width="220"><a href="https://github.com/bobleer">@bobleer</a></td> <td align="center" width="220">@*苗</td> <td align="center" width="220">@*划</td> </tr> <tr> <td align="center" width="220"><a href="https://github.com/Clarence-pan">@Clarence-pan</a></td> <td align="center" width="220"><a href="https://github.com/carter003">@carter003</a></td> <td align="center" width="220">@S*r</td> <td align="center" width="220">@*晖</td> <td align="center" width="220">@*敏</td> <td align="center" width="220">@Z*z</td> </tr> <tr> <td align="center" width="220">@*然</td> <td align="center" width="220"><a href="https://github.com/cluic">@cluic</a></td> <td align="center" width="220">@*苗</td> <td align="center" width="220"><a href="https://github.com/PromptExpert">@PromptExpert</a></td> <td align="center" width="220">@*应</td> <td align="center" width="220"><a href="https://github.com/yusnake">@yusnake</a></td> </tr> <tr> <td align="center" width="220">@*飞</td> <td align="center" width="220">@董*</td> <td align="center" width="220">@*汀</td> <td align="center" width="220">@*涯</td> <td align="center" width="220">@*:-)</td> <td align="center" width="220">@**磊</td> </tr> <tr> <td align="center" width="220">@*琢</td> <td align="center" width="220">@*成</td> <td align="center" width="220">@Z*o</td> <td align="center" width="220">@*琨</td> <td align="center" width="220"><a href="https://github.com/congzhangzh">@congzhangzh</a></td> <td align="center" width="220">@*_</td> </tr> <tr> <td align="center" width="220">@Z*m</td> <td align="center" width="220">@*鑫</td> <td align="center" width="220">@c*y</td> <td align="center" width="220">@*昕</td> <td align="center" width="220"><a href="https://github.com/witsice">@witsice</a></td> <td align="center" width="220">@b*g</td> </tr> <tr> <td align="center" width="220">@*亿</td> <td align="center" width="220">@*辉</td> <td align="center" width="220">@JACK</td> <td align="center" width="220">@*光</td> <td align="center" width="220">@W*l</td> <td align="center" width="220"><a href="https://github.com/kesku">@kesku</a></td> </tr> <tr> <td align="center" width="220"><a href="https://github.com/biguncle">@biguncle</a></td> <td align="center" width="220">@二吉吉</td> <td align="center" width="220">@a*g</td> <td align="center" width="220">@*林</td> <td align="center" width="220">@*咸</td> <td align="center" width="220">@*明</td> </tr> <tr> <td align="center" width="220">@S*y</td> <td align="center" width="220">@f*o</td> <td align="center" width="220">@*智</td> <td align="center" width="220">@F*t</td> <td align="center" width="220">@r*c</td> <td align="center" width="220"><a href="https://github.com/qierkang">@qierkang</a></td> </tr> <tr> <td align="center" width="220">@*军</td> <td align="center" width="220"><a href="https://github.com/snrise-z">@snrise-z</a></td> <td align="center" width="220">@*王</td> <td align="center" width="220"><a href="https://github.com/greatheart1000">@greatheart1000</a></td> <td align="center" width="220">@*王</td> <td align="center" width="220">@zcutlip</td> </tr> <tr> <td align="center" width="220"><a href="https://github.com/Peng-YM">@Peng-YM</a></td> <td align="center" width="220">@*更</td> <td align="center" width="220">@*.</td> <td align="center" width="220">@F*t</td> <td align="center" width="220">@*政</td> <td align="center" width="220">@*铭</td> </tr> <tr> <td align="center" width="220">@*叶</td> <td align="center" width="220">@七*o</td> <td align="center" width="220">@*青</td> <td align="center" width="220">@**晨</td> <td align="center" width="220">@*远</td> <td align="center" width="220">@*霄</td> </tr> <tr> <td align="center" width="220">@**吉</td> <td align="center" width="220">@**飞</td> <td align="center" width="220">@**驰</td> <td align="center" width="220">@x*g</td> <td align="center" width="220">@**东</td> <td align="center" width="220">@*落</td> </tr> <tr> <td align="center" width="220">@哆*k</td> <td align="center" width="220">@*涛</td> <td align="center" width="220"><a href="https://github.com/WitMiao">@苗大</a></td> <td align="center" width="220">@*呢</td> <td align="center" width="220">@d*u</td> <td align="center" width="220">@crizcraig</td> </tr> <tr> <td align="center" width="220">s*s</td> <td align="center" width="220">*火</td> <td align="center" width="220">*勤</td> <td align="center" width="220">**锟</td> <td align="center" width="220">*涛</td> <td align="center" width="220">**明</td> </tr> <tr> <td align="center" width="220">*知</td> <td align="center" width="220">*语</td> <td align="center" width="220">*瓜</td> <td align="center" width="220"></td> <td align="center" width="220"></td> <td align="center" width="220"></td> </tr> </table>

<sub>If your name is masked, please contact me via my homepage email to update it with your GitHub username.</sub>

</div>

License

This project is licensed under the MIT License.