|
1 | | -# CLI Proxy API - Aoao |
2 | | -自用Fork，请支持原仓库 [CLIProxyAPI](https://github.com/AoaoMe/CLIProxyAPI) |
| 1 | +# CLI Proxy API |
| 2 | + |
| 3 | +English | [中文](README_CN.md) |
| 4 | + |
| 5 | +A proxy server that provides OpenAI/Gemini/Claude/Codex compatible API interfaces for CLI. |
| 6 | + |
| 7 | +It now also supports OpenAI Codex (GPT models) and Claude Code via OAuth. |
| 8 | + |
| 9 | +So you can use local or multi-account CLI access with OpenAI(include Responses)/Gemini/Claude-compatible clients and SDKs. |
| 10 | + |
| 11 | +## Sponsor |
| 12 | + |
| 13 | +[](https://z.ai/subscribe?ic=8JVLJQFSKB) |
| 14 | + |
| 15 | +This project is sponsored by Z.ai, supporting us with their GLM CODING PLAN. |
| 16 | + |
| 17 | +GLM CODING PLAN is a subscription service designed for AI coding, starting at just $10/month. It provides access to their flagship GLM-4.7 & （GLM-5 Only Available for Pro Users）model across 10+ popular AI coding tools (Claude Code, Cline, Roo Code, etc.), offering developers top-tier, fast, and stable coding experiences. |
| 18 | + |
| 19 | +Get 10% OFF GLM CODING PLAN：https://z.ai/subscribe?ic=8JVLJQFSKB |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +<table> |
| 24 | +<tbody> |
| 25 | +<tr> |
| 26 | +<td width="180"><a href="https://www.packyapi.com/register?aff=cliproxyapi"><img src="./assets/packycode.png" alt="PackyCode" width="150"></a></td> |
| 27 | +<td>Thanks to PackyCode for sponsoring this project! PackyCode is a reliable and efficient API relay service provider, offering relay services for Claude Code, Codex, Gemini, and more. PackyCode provides special discounts for our software users: register using <a href="https://www.packyapi.com/register?aff=cliproxyapi">this link</a> and enter the "cliproxyapi" promo code during recharge to get 10% off.</td> |
| 28 | +</tr> |
| 29 | +<tr> |
| 30 | +<td width="180"><a href="https://www.aicodemirror.com/register?invitecode=TJNAIF"><img src="./assets/aicodemirror.png" alt="AICodeMirror" width="150"></a></td> |
| 31 | +<td>Thanks to AICodeMirror for sponsoring this project! AICodeMirror provides official high-stability relay services for Claude Code / Codex / Gemini CLI, with enterprise-grade concurrency, fast invoicing, and 24/7 dedicated technical support. Claude Code / Codex / Gemini official channels at 38% / 2% / 9% of original price, with extra discounts on top-ups! AICodeMirror offers special benefits for CLIProxyAPI users: register via <a href="https://www.aicodemirror.com/register?invitecode=TJNAIF">this link</a> to enjoy 20% off your first top-up, and enterprise customers can get up to 25% off!</td> |
| 32 | +</tr> |
| 33 | +</tbody> |
| 34 | +</table> |
| 35 | + |
| 36 | +## Overview |
| 37 | + |
| 38 | +- OpenAI/Gemini/Claude compatible API endpoints for CLI models |
| 39 | +- OpenAI Codex support (GPT models) via OAuth login |
| 40 | +- Claude Code support via OAuth login |
| 41 | +- Qwen Code support via OAuth login |
| 42 | +- iFlow support via OAuth login |
| 43 | +- Amp CLI and IDE extensions support with provider routing |
| 44 | +- Streaming and non-streaming responses |
| 45 | +- Function calling/tools support |
| 46 | +- Multimodal input support (text and images) |
| 47 | +- Multiple accounts with round-robin load balancing (Gemini, OpenAI, Claude, Qwen and iFlow) |
| 48 | +- Simple CLI authentication flows (Gemini, OpenAI, Claude, Qwen and iFlow) |
| 49 | +- Generative Language API Key support |
| 50 | +- AI Studio Build multi-account load balancing |
| 51 | +- Gemini CLI multi-account load balancing |
| 52 | +- Claude Code multi-account load balancing |
| 53 | +- Qwen Code multi-account load balancing |
| 54 | +- iFlow multi-account load balancing |
| 55 | +- OpenAI Codex multi-account load balancing |
| 56 | +- OpenAI-compatible upstream providers via config (e.g., OpenRouter) |
| 57 | +- Reusable Go SDK for embedding the proxy (see `docs/sdk-usage.md`) |
| 58 | + |
| 59 | +## Getting Started |
3 | 60 |
|
4 | | -## 使用说明 |
5 | 61 | CLIProxyAPI Guides: [https://help.router-for.me/](https://help.router-for.me/) |
6 | 62 |
|
7 | | -## Docker |
8 | | -``` |
9 | | -docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.yaml -v /path/to/your/auth-dir:/root/.cli-proxy-api aoaomh/cli-proxy-api:latest |
10 | | -``` |
| 63 | +## Management API |
| 64 | + |
| 65 | +see [MANAGEMENT_API.md](https://help.router-for.me/management/api) |
| 66 | + |
| 67 | +## Amp CLI Support |
| 68 | + |
| 69 | +CLIProxyAPI includes integrated support for [Amp CLI](https://ampcode.com) and Amp IDE extensions, enabling you to use your Google/ChatGPT/Claude OAuth subscriptions with Amp's coding tools: |
| 70 | + |
| 71 | +- Provider route aliases for Amp's API patterns (`/api/provider/{provider}/v1...`) |
| 72 | +- Management proxy for OAuth authentication and account features |
| 73 | +- Smart model fallback with automatic routing |
| 74 | +- **Model mapping** to route unavailable models to alternatives (e.g., `claude-opus-4.5` → `claude-sonnet-4`) |
| 75 | +- Security-first design with localhost-only management endpoints |
| 76 | + |
| 77 | +**→ [Complete Amp CLI Integration Guide](https://help.router-for.me/agent-client/amp-cli.html)** |
| 78 | + |
| 79 | +## SDK Docs |
| 80 | + |
| 81 | +- Usage: [docs/sdk-usage.md](docs/sdk-usage.md) |
| 82 | +- Advanced (executors & translators): [docs/sdk-advanced.md](docs/sdk-advanced.md) |
| 83 | +- Access: [docs/sdk-access.md](docs/sdk-access.md) |
| 84 | +- Watcher: [docs/sdk-watcher.md](docs/sdk-watcher.md) |
| 85 | +- Custom Provider Example: `examples/custom-provider` |
| 86 | + |
| 87 | +## Contributing |
| 88 | + |
| 89 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 90 | + |
| 91 | +1. Fork the repository |
| 92 | +2. Create your feature branch (`git checkout -b feature/amazing-feature`) |
| 93 | +3. Commit your changes (`git commit -m 'Add some amazing feature'`) |
| 94 | +4. Push to the branch (`git push origin feature/amazing-feature`) |
| 95 | +5. Open a Pull Request |
| 96 | + |
| 97 | +## Who is with us? |
| 98 | + |
| 99 | +Those projects are based on CLIProxyAPI: |
| 100 | + |
| 101 | +### [vibeproxy](https://github.com/automazeio/vibeproxy) |
| 102 | + |
| 103 | +Native macOS menu bar app to use your Claude Code & ChatGPT subscriptions with AI coding tools - no API keys needed |
| 104 | + |
| 105 | +### [Subtitle Translator](https://github.com/VjayC/SRT-Subtitle-Translator-Validator) |
| 106 | + |
| 107 | +Browser-based tool to translate SRT subtitles using your Gemini subscription via CLIProxyAPI with automatic validation/error correction - no API keys needed |
| 108 | + |
| 109 | +### [CCS (Claude Code Switch)](https://github.com/kaitranntt/ccs) |
| 110 | + |
| 111 | +CLI wrapper for instant switching between multiple Claude accounts and alternative models (Gemini, Codex, Antigravity) via CLIProxyAPI OAuth - no API keys needed |
| 112 | + |
| 113 | +### [ProxyPal](https://github.com/heyhuynhgiabuu/proxypal) |
| 114 | + |
| 115 | +Native macOS GUI for managing CLIProxyAPI: configure providers, model mappings, and endpoints via OAuth - no API keys needed. |
| 116 | + |
| 117 | +### [Quotio](https://github.com/nguyenphutrong/quotio) |
| 118 | + |
| 119 | +Native macOS menu bar app that unifies Claude, Gemini, OpenAI, Qwen, and Antigravity subscriptions with real-time quota tracking and smart auto-failover for AI coding tools like Claude Code, OpenCode, and Droid - no API keys needed. |
| 120 | + |
| 121 | +### [CodMate](https://github.com/loocor/CodMate) |
| 122 | + |
| 123 | +Native macOS SwiftUI app for managing CLI AI sessions (Codex, Claude Code, Gemini CLI) with unified provider management, Git review, project organization, global search, and terminal integration. Integrates CLIProxyAPI to provide OAuth authentication for Codex, Claude, Gemini, Antigravity, and Qwen Code, with built-in and third-party provider rerouting through a single proxy endpoint - no API keys needed for OAuth providers. |
| 124 | + |
| 125 | +### [ProxyPilot](https://github.com/Finesssee/ProxyPilot) |
| 126 | + |
| 127 | +Windows-native CLIProxyAPI fork with TUI, system tray, and multi-provider OAuth for AI coding tools - no API keys needed. |
| 128 | + |
| 129 | +### [Claude Proxy VSCode](https://github.com/uzhao/claude-proxy-vscode) |
| 130 | + |
| 131 | +VSCode extension for quick switching between Claude Code models, featuring integrated CLIProxyAPI as its backend with automatic background lifecycle management. |
| 132 | + |
| 133 | +### [ZeroLimit](https://github.com/0xtbug/zero-limit) |
| 134 | + |
| 135 | +Windows desktop app built with Tauri + React for monitoring AI coding assistant quotas via CLIProxyAPI. Track usage across Gemini, Claude, OpenAI Codex, and Antigravity accounts with real-time dashboard, system tray integration, and one-click proxy control - no API keys needed. |
| 136 | + |
| 137 | +### [CPA-XXX Panel](https://github.com/ferretgeek/CPA-X) |
| 138 | + |
| 139 | +A lightweight web admin panel for CLIProxyAPI with health checks, resource monitoring, real-time logs, auto-update, request statistics and pricing display. Supports one-click installation and systemd service. |
| 140 | + |
| 141 | +### [CLIProxyAPI Tray](https://github.com/kitephp/CLIProxyAPI_Tray) |
| 142 | + |
| 143 | +A Windows tray application implemented using PowerShell scripts, without relying on any third-party libraries. The main features include: automatic creation of shortcuts, silent running, password management, channel switching (Main / Plus), and automatic downloading and updating. |
| 144 | + |
| 145 | +### [霖君](https://github.com/wangdabaoqq/LinJun) |
| 146 | + |
| 147 | +霖君 is a cross-platform desktop application for managing AI programming assistants, supporting macOS, Windows, and Linux systems. Unified management of Claude Code, Gemini CLI, OpenAI Codex, Qwen Code, and other AI coding tools, with local proxy for multi-account quota tracking and one-click configuration. |
| 148 | + |
| 149 | +### [CLIProxyAPI Dashboard](https://github.com/itsmylife44/cliproxyapi-dashboard) |
| 150 | + |
| 151 | +A modern web-based management dashboard for CLIProxyAPI built with Next.js, React, and PostgreSQL. Features real-time log streaming, structured configuration editing, API key management, OAuth provider integration for Claude/Gemini/Codex, usage analytics, container management, and config sync with OpenCode via companion plugin - no manual YAML editing needed. |
| 152 | + |
| 153 | +> [!NOTE] |
| 154 | +> If you developed a project based on CLIProxyAPI, please open a PR to add it to this list. |
| 155 | +
|
| 156 | +## More choices |
| 157 | + |
| 158 | +Those projects are ports of CLIProxyAPI or inspired by it: |
| 159 | + |
| 160 | +### [9Router](https://github.com/decolua/9router) |
| 161 | + |
| 162 | +A Next.js implementation inspired by CLIProxyAPI, easy to install and use, built from scratch with format translation (OpenAI/Claude/Gemini/Ollama), combo system with auto-fallback, multi-account management with exponential backoff, a Next.js web dashboard, and support for CLI tools (Cursor, Claude Code, Cline, RooCode) - no API keys needed. |
| 163 | + |
| 164 | +### [OmniRoute](https://github.com/diegosouzapw/OmniRoute) |
| 165 | + |
| 166 | +Never stop coding. Smart routing to FREE & low-cost AI models with automatic fallback. |
| 167 | + |
| 168 | +OmniRoute is an AI gateway for multi-provider LLMs: an OpenAI-compatible endpoint with smart routing, load balancing, retries, and fallbacks. Add policies, rate limits, caching, and observability for reliable, cost-aware inference. |
| 169 | + |
| 170 | +> [!NOTE] |
| 171 | +> If you have developed a port of CLIProxyAPI or a project inspired by it, please open a PR to add it to this list. |
11 | 172 |
|
| 173 | +## License |
12 | 174 |
|
13 | | -## WebUI |
14 | | -[CLIProxyAPIPanel](https://github.com/AoaoMH/CLIProxyAPIPanel) |
| 175 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments