docs: reposition Amp CLI as integrated feature for upstream PR
- Update README.md to present Amp CLI as standard feature, not fork differentiator - Remove USING_WITH_FACTORY_AND_AMP.md (fork-specific, Factory docs live upstream) - Add comprehensive docs/amp-cli-integration.md with setup, config, troubleshooting - Eliminate fork justification messaging throughout documentation - Prepare Amp CLI integration for upstream merge consideration This positions Amp CLI support as a natural extension of CLIProxyAPI's multi-client architecture rather than a fork-specific feature.
This commit is contained in:
Ben Vargas
@@ -1,37 +1,5 @@
|
||||
# CLI Proxy API
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Important: Amp CLI Support Fork
|
||||
|
||||
**This is a specialized fork of [router-for-me/CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) that adds support for the Amp CLI tool.**
|
||||
|
||||
### Why This Fork Exists
|
||||
|
||||
The **Amp CLI** requires custom routing patterns to function properly. The upstream CLIProxyAPI project maintainers opted not to merge Amp-specific routing support into the main codebase.
|
||||
|
||||
### Which Version Should You Use?
|
||||
|
||||
- **Use this fork** if you want to run **both Factory CLI and Amp CLI** with the same proxy server
|
||||
- **Use upstream** ([router-for-me/CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)) if you only need Factory CLI support
|
||||
|
||||
### 📖 Complete Setup Guide
|
||||
|
||||
**→ [USING_WITH_FACTORY_AND_AMP.md](USING_WITH_FACTORY_AND_AMP.md)** - Comprehensive guide for using this proxy with both Factory CLI (Droid) and Amp CLI and IDE extensions, including OAuth setup, configuration examples, and troubleshooting.
|
||||
|
||||
### Key Differences
|
||||
|
||||
This fork includes:
|
||||
- ✅ **Amp CLI route aliases** (`/api/provider/{provider}/v1...`)
|
||||
- ✅ **Amp upstream proxy support** for OAuth and management routes
|
||||
- ✅ **Automatic gzip decompression** for Amp upstream responses
|
||||
- ✅ **Smart secret management** with precedence: config > env > file
|
||||
- ✅ **All Factory CLI features** from upstream (fully compatible)
|
||||
|
||||
All Amp-specific code is isolated in the `internal/api/modules/amp` module, making it easy to sync upstream changes with minimal conflicts.
|
||||
|
||||
---
|
||||
|
||||
English | [中文](README_CN.md)
|
||||
|
||||
A proxy server that provides OpenAI/Gemini/Claude/Codex compatible API interfaces for CLI.
|
||||
@@ -57,6 +25,7 @@ Get 10% OFF GLM CODING PLAN：https://z.ai/subscribe?ic=8JVLJQFSKB
|
||||
- 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)
|
||||
@@ -72,15 +41,6 @@ Get 10% OFF GLM CODING PLAN：https://z.ai/subscribe?ic=8JVLJQFSKB
|
||||
- OpenAI-compatible upstream providers via config (e.g., OpenRouter)
|
||||
- Reusable Go SDK for embedding the proxy (see `docs/sdk-usage.md`)
|
||||
|
||||
### Fork-Specific: Amp CLI Support 🔥
|
||||
- **Full Amp CLI integration** via provider route aliases (`/api/provider/{provider}/v1...`)
|
||||
- **Amp upstream proxy** for OAuth authentication and management routes
|
||||
- **Smart secret management** with configurable precedence (config > env > file)
|
||||
- **Automatic gzip decompression** for Amp upstream responses
|
||||
- **5-minute secret caching** to reduce file I/O overhead
|
||||
- **Zero conflict** with Factory CLI - use both tools simultaneously
|
||||
- **Modular architecture** for easy upstream sync (90% reduction in merge conflicts)
|
||||
|
||||
## Getting Started
|
||||
|
||||
CLIProxyAPI Guides: [https://help.router-for.me/](https://help.router-for.me/)
|
||||
@@ -89,6 +49,17 @@ CLIProxyAPI Guides: [https://help.router-for.me/](https://help.router-for.me/)
|
||||
|
||||
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
|
||||
- Security-first design with localhost-only management endpoints
|
||||
|
||||
**→ [Complete Amp CLI Integration Guide](docs/amp-cli-integration.md)**
|
||||
|
||||
## SDK Docs
|
||||
|
||||
- Usage: [docs/sdk-usage.md](docs/sdk-usage.md)
|
||||
@@ -119,7 +90,7 @@ Native macOS menu bar app to use your Claude Code & ChatGPT subscriptions with A
|
||||
|
||||
Browser-based tool to translate SRT subtitles using your Gemini subscription via CLIProxyAPI with automatic validation/error correction - no API keys needed
|
||||
|
||||
> [!NOTE]
|
||||
> [!NOTE]
|
||||
> If you developed a project based on CLIProxyAPI, please open a PR to add it to this list.
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user