mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-02-03 21:10:51 +08:00
16b0a561d7
- Deleted `MANAGEMENT_API.md` and `MANAGEMENT_API_CN.md` as they are no longer necessary. - Streamlined project documentation by removing redundant API details already covered elsewhere.
77 lines
2.8 KiB
Markdown
77 lines
2.8 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.
|
|
|
|
## 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
|
|
- 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)
|
|
|
|
## 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
|
|
|
|
> [!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.
|