mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-02-03 13:00:52 +08:00
108 lines
4.4 KiB
Markdown
108 lines
4.4 KiB
Markdown
# CLI Proxy API
|
||
|
||
English | [中文](README_CN.md)
|
||
|
||
A proxy server that provides OpenAI/Gemini/Claude/Codex compatible API interfaces for CLI.
|
||
|
||
It now also supports OpenAI Codex (GPT models) and Claude Code via OAuth.
|
||
|
||
So you can use local or multi-account CLI access with OpenAI(include Responses)/Gemini/Claude-compatible clients and SDKs.
|
||
|
||
## Sponsor
|
||
|
||
[](https://z.ai/subscribe?ic=8JVLJQFSKB)
|
||
|
||
This project is sponsored by Z.ai, supporting us with their GLM CODING PLAN.
|
||
|
||
GLM CODING PLAN is a subscription service designed for AI coding, starting at just $3/month. It provides access to their flagship GLM-4.6 model across 10+ popular AI coding tools (Claude Code, Cline, Roo Code, etc.), offering developers top-tier, fast, and stable coding experiences.
|
||
|
||
Get 10% OFF GLM CODING PLAN：https://z.ai/subscribe?ic=8JVLJQFSKB
|
||
|
||
## Overview
|
||
|
||
- OpenAI/Gemini/Claude compatible API endpoints for CLI models
|
||
- OpenAI Codex support (GPT models) via OAuth login
|
||
- Claude Code support via OAuth login
|
||
- Qwen Code support via OAuth login
|
||
- iFlow support via OAuth login
|
||
- Amp CLI and IDE extensions support with provider routing
|
||
- Streaming and non-streaming responses
|
||
- Function calling/tools support
|
||
- Multimodal input support (text and images)
|
||
- Multiple accounts with round-robin load balancing (Gemini, OpenAI, Claude, Qwen and iFlow)
|
||
- Simple CLI authentication flows (Gemini, OpenAI, Claude, Qwen and iFlow)
|
||
- Generative Language API Key support
|
||
- AI Studio Build multi-account load balancing
|
||
- Gemini CLI multi-account load balancing
|
||
- Claude Code multi-account load balancing
|
||
- Qwen Code multi-account load balancing
|
||
- iFlow multi-account load balancing
|
||
- OpenAI Codex multi-account load balancing
|
||
- OpenAI-compatible upstream providers via config (e.g., OpenRouter)
|
||
- Reusable Go SDK for embedding the proxy (see `docs/sdk-usage.md`)
|
||
|
||
## Getting Started
|
||
|
||
CLIProxyAPI Guides: [https://help.router-for.me/](https://help.router-for.me/)
|
||
|
||
## Management API
|
||
|
||
see [MANAGEMENT_API.md](https://help.router-for.me/management/api)
|
||
|
||
## Amp CLI Support
|
||
|
||
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:
|
||
|
||
- Provider route aliases for Amp's API patterns (`/api/provider/{provider}/v1...`)
|
||
- Management proxy for OAuth authentication and account features
|
||
- Smart model fallback with automatic routing
|
||
- **Model mapping** to route unavailable models to alternatives (e.g., `claude-opus-4.5` → `claude-sonnet-4`)
|
||
- Security-first design with localhost-only management endpoints
|
||
|
||
**→ [Complete Amp CLI Integration Guide](https://help.router-for.me/agent-client/amp-cli.html)**
|
||
|
||
## SDK Docs
|
||
|
||
- Usage: [docs/sdk-usage.md](docs/sdk-usage.md)
|
||
- Advanced (executors & translators): [docs/sdk-advanced.md](docs/sdk-advanced.md)
|
||
- Access: [docs/sdk-access.md](docs/sdk-access.md)
|
||
- Watcher: [docs/sdk-watcher.md](docs/sdk-watcher.md)
|
||
- Custom Provider Example: `examples/custom-provider`
|
||
|
||
## Contributing
|
||
|
||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||
|
||
1. Fork the repository
|
||
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
||
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||
5. Open a Pull Request
|
||
|
||
## Who is with us?
|
||
|
||
Those projects are based on CLIProxyAPI:
|
||
|
||
### [vibeproxy](https://github.com/automazeio/vibeproxy)
|
||
|
||
Native macOS menu bar app to use your Claude Code & ChatGPT subscriptions with AI coding tools - no API keys needed
|
||
|
||
### [Subtitle Translator](https://github.com/VjayC/SRT-Subtitle-Translator-Validator)
|
||
|
||
Browser-based tool to translate SRT subtitles using your Gemini subscription via CLIProxyAPI with automatic validation/error correction - no API keys needed
|
||
|
||
### [CCS (Claude Code Switch)](https://github.com/kaitranntt/ccs)
|
||
|
||
CLI wrapper for instant switching between multiple Claude accounts and alternative models (Gemini, Codex, Antigravity) via CLIProxyAPI OAuth - no API keys needed
|
||
|
||
### [ProxyPal](https://github.com/heyhuynhgiabuu/proxypal)
|
||
|
||
Native macOS GUI for managing CLIProxyAPI: configure providers, model mappings, and endpoints via OAuth - no API keys needed.
|
||
|
||
> [!NOTE]
|
||
> If you developed a project based on CLIProxyAPI, please open a PR to add it to this list.
|
||
|
||
## License
|
||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|