Skip to content

Commit bee758b

Browse files
committed
Document the provider cleanup and keep repo instructions current
Refreshed the project docs, config example, build script, sponsor asset, and repo instruction files so the tracked guidance matches the current supported providers and build workflow. Constraint: The root ignore rules were changed to allow the workspace instruction files to be versioned alongside the rest of the repo docs. Rejected: Fold these docs into the runtime or admin commits | that would mix narrative-only updates into code changes. Confidence: high Scope-risk: narrow Directive: Keep provider lists in README/config examples synchronized with the actual supported auth paths before landing future syncs. Tested: Not yet Not-tested: Full repo verification still pending
1 parent 8a481f0 commit bee758b

9 files changed

Lines changed: 666 additions & 55 deletions

File tree

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ _bmad/
3131
_bmad-output/
3232

3333
# Documentation & Assets
34-
AGENTS.md
35-
CLAUDE.md
36-
GEMINI.md
3734
logs/
3835

3936
CLIProxyAPI/.git_backup/

AGENTS.md

Lines changed: 568 additions & 0 deletions
Large diffs are not rendered by default.

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# cpab — Docker Build Instructions
2+
3+
## Multi-Platform Image Builds
4+
5+
All Docker images MUST be built for **both** `linux/amd64` and `linux/arm64`.
6+
Never push a single-platform image to a tag that users pull (`:latest`, version tags).
7+
8+
### CI (GitHub Actions)
9+
10+
- **`ci-docker.yml`** (on push to `main`): builds `linux/amd64,linux/arm64` in one `docker buildx` step using QEMU emulation, pushes as `:latest` and `:<sha>`.
11+
- **`docker-image.yml`** (on version tag `v*`): builds each platform on its native runner, then creates a combined multi-arch manifest with `docker buildx imagetools create`.
12+
13+
### Local Development
14+
15+
Build and run locally (no push needed):
16+
17+
```bash
18+
docker buildx build --platform linux/amd64,linux/arm64 -t abwebplode/cpab:local .
19+
```
20+
21+
To push a multi-arch image manually:
22+
23+
```bash
24+
docker buildx build \
25+
--platform linux/amd64,linux/arm64 \
26+
-t abwebplode/cpab:latest \
27+
--push .
28+
```
29+
30+
> Requires `docker buildx` and QEMU. Install QEMU emulation once with:
31+
> `docker run --privileged --rm tonistiigi/binfmt --install all`
32+
33+
### Common Mistakes to Avoid
34+
35+
- Do **not** build with `--platform linux/amd64` only — arm64 users (Apple Silicon) will get `no matching manifest` errors on `docker compose pull`.
36+
- Do **not** add an `image:` field to `docker-compose.yml` pointing to the Hub image while also using `build:` — it causes confusion between local builds and pulled images.

CLIProxyAPI/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Get 10% OFF GLM CODING PLAN:https://z.ai/subscribe?ic=8JVLJQFSKB
4242
<td width="180"><a href="https://poixe.com/i/m8kvep"><img src="./assets/poixeai.png" alt="PoixeAI" width="150"></a></td>
4343
<td>Thanks to Poixe AI for sponsoring this project! Poixe AI provides reliable LLM API services. You can leverage the platform's API endpoints to seamlessly build AI-powered products. Additionally, you can become a vendor by providing AI API resources to the platform and earn revenue. Register through the exclusive CLIProxyAPI <a href="https://poixe.com/i/m8kvep">referral link</a> and receive a bonus of $5 USD on your first top-up.</td>
4444
</tr>
45+
<tr>
46+
<td width="180"><a href="https://coder.visioncoder.cn"><img src="./assets/visioncoder.png" alt="VisionCoder" width="150"></a></td>
47+
<td>Thanks to VisionCoder for supporting this project. <a href="https://coder.visioncoder.cn" target="_blank">VisionCoder Developer Platform</a> is a reliable and efficient API relay service provider, offering access to mainstream AI models such as Claude Code, Codex, and Gemini. It helps developers and teams integrate AI capabilities more easily and improve productivity.
48+
<p></p>
49+
VisionCoder is also offering our users a limited-time <a href="https://coder.visioncoder.cn" target="_blank">Token Plan</a> promotion: buy 1 month and get 1 month free.</td>
50+
</tr>
4551
</tbody>
4652
</table>
4753

@@ -50,20 +56,16 @@ Get 10% OFF GLM CODING PLAN:https://z.ai/subscribe?ic=8JVLJQFSKB
5056
- OpenAI/Gemini/Claude compatible API endpoints for CLI models
5157
- OpenAI Codex support (GPT models) via OAuth login
5258
- Claude Code support via OAuth login
53-
- Qwen Code support via OAuth login
54-
- iFlow support via OAuth login
5559
- Amp CLI and IDE extensions support with provider routing
5660
- Streaming and non-streaming responses
5761
- Function calling/tools support
5862
- Multimodal input support (text and images)
59-
- Multiple accounts with round-robin load balancing (Gemini, OpenAI, Claude, Qwen and iFlow)
60-
- Simple CLI authentication flows (Gemini, OpenAI, Claude, Qwen and iFlow)
63+
- Multiple accounts with round-robin load balancing (Gemini, OpenAI, Claude)
64+
- Simple CLI authentication flows (Gemini, OpenAI, Claude)
6165
- Generative Language API Key support
6266
- AI Studio Build multi-account load balancing
6367
- Gemini CLI multi-account load balancing
6468
- Claude Code multi-account load balancing
65-
- Qwen Code multi-account load balancing
66-
- iFlow multi-account load balancing
6769
- OpenAI Codex multi-account load balancing
6870
- OpenAI-compatible upstream providers via config (e.g., OpenRouter)
6971
- Reusable Go SDK for embedding the proxy (see `docs/sdk-usage.md`)
@@ -132,11 +134,11 @@ CLI wrapper for instant switching between multiple Claude accounts and alternati
132134

133135
### [Quotio](https://github.com/nguyenphutrong/quotio)
134136

135-
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.
137+
Native macOS menu bar app that unifies Claude, Gemini, OpenAI, 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.
136138

137139
### [CodMate](https://github.com/loocor/CodMate)
138140

139-
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.
141+
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, and Antigravity, with built-in and third-party provider rerouting through a single proxy endpoint - no API keys needed for OAuth providers.
140142

141143
### [ProxyPilot](https://github.com/Finesssee/ProxyPilot)
142144

@@ -160,7 +162,7 @@ A Windows tray application implemented using PowerShell scripts, without relying
160162

161163
### [霖君](https://github.com/wangdabaoqq/LinJun)
162164

163-
霖君 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.
165+
霖君 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, and other AI coding tools, with local proxy for multi-account quota tracking and one-click configuration.
164166

165167
### [CLIProxyAPI Dashboard](https://github.com/itsmylife44/cliproxyapi-dashboard)
166168

@@ -179,7 +181,7 @@ helping users to immersively use AI assistants across applications on controlled
179181

180182
### [ProxyPal](https://github.com/buddingnewinsights/proxypal)
181183

182-
Cross-platform desktop app (macOS, Windows, Linux) wrapping CLIProxyAPI with a native GUI. Connects Claude, ChatGPT, Gemini, GitHub Copilot, Qwen, iFlow, and custom OpenAI-compatible endpoints with usage analytics, request monitoring, and auto-configuration for popular coding tools - no API keys needed.
184+
Cross-platform desktop app (macOS, Windows, Linux) wrapping CLIProxyAPI with a native GUI. Connects Claude, ChatGPT, Gemini, GitHub Copilot, and custom OpenAI-compatible endpoints with usage analytics, request monitoring, and auto-configuration for popular coding tools - no API keys needed.
183185

184186
### [CLIProxyAPI Quota Inspector](https://github.com/AllenReder/CLIProxyAPI-Quota-Inspector)
185187

CLIProxyAPI/README_CN.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,29 @@ GLM CODING PLAN 是专为AI编码打造的订阅套餐,每月最低仅需20元
2424
<tbody>
2525
<tr>
2626
<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>感谢 PackyCode 对本项目的赞助!PackyCode 是一家可靠高效的 API 中转服务商,提供 Claude Code、Codex、Gemini 等多种服务的中转。PackyCode 为本软件用户提供了特别优惠:使用<a href="https://www.packyapi.com/register?aff=cliproxyapi">此链接</a>注册,并在充值时输入 "cliproxyapi" 优惠码即可享受九折优惠。</td>
27+
<td>感谢 PackyCode 对本项目的赞助!PackyCode 是一家可靠高效的 API 中转服务商,提供 Claude Code、Codex、Gemini 等多种服务的中转。PackyCode 为本软件用户提供了特别优惠:使用<a href="https://www.packyapi.com/register?aff=cliproxyapi" target="_blank">此链接</a>注册,并在充值时输入 "cliproxyapi" 优惠码即可享受九折优惠。</td>
2828
</tr>
2929
<tr>
3030
<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>感谢 AICodeMirror 赞助了本项目!AICodeMirror 提供 Claude Code / Codex / Gemini CLI 官方高稳定中转服务,支持企业级高并发、极速开票、7×24 专属技术支持。 Claude Code / Codex / Gemini 官方渠道低至 3.8 / 0.2 / 0.9 折,充值更有折上折!AICodeMirror 为 CLIProxyAPI 的用户提供了特别福利,通过<a href="https://www.aicodemirror.com/register?invitecode=TJNAIF">此链接</a>注册的用户,可享受首充8折,企业客户最高可享 7.5 折!</td>
31+
<td>感谢 AICodeMirror 赞助了本项目!AICodeMirror 提供 Claude Code / Codex / Gemini CLI 官方高稳定中转服务,支持企业级高并发、极速开票、7×24 专属技术支持。 Claude Code / Codex / Gemini 官方渠道低至 3.8 / 0.2 / 0.9 折,充值更有折上折!AICodeMirror 为 CLIProxyAPI 的用户提供了特别福利,通过<a href="https://www.aicodemirror.com/register?invitecode=TJNAIF" target="_blank">此链接</a>注册的用户,可享受首充8折,企业客户最高可享 7.5 折!</td>
3232
</tr>
3333
<tr>
3434
<td width="180"><a href="https://shop.bmoplus.com/?utm_source=github"><img src="./assets/bmoplus.png" alt="BmoPlus" width="150"></a></td>
35-
<td>感谢 BmoPlus 赞助了本项目!BmoPlus 是一家专为AI订阅重度用户打造的可靠 AI 账号代充服务商,提供稳定的 ChatGPT Plus / ChatGPT Pro(全程质保) / Claude Pro / Super Grok / Gemini Pro 的官方代充&成品账号。 通过<a href="https://shop.bmoplus.com/?utm_source=github">BmoPlus AI成品号专卖/代充</a>注册下单的用户,可享GPT <b>官网订阅一折</b> 的震撼价格!</td>
35+
<td>感谢 BmoPlus 赞助了本项目!BmoPlus 是一家专为AI订阅重度用户打造的可靠 AI 账号代充服务商,提供稳定的 ChatGPT Plus / ChatGPT Pro(全程质保) / Claude Pro / Super Grok / Gemini Pro 的官方代充&成品账号。 通过<a href="https://shop.bmoplus.com/?utm_source=github" target="_blank">BmoPlus AI成品号专卖/代充</a>注册下单的用户,可享GPT <b>官网订阅一折</b> 的震撼价格!</td>
3636
</tr>
3737
<tr>
3838
<td width="180"><a href="https://www.lingtrue.com/register"><img src="./assets/lingtrue.png" alt="LingtrueAPI" width="150"></a></td>
39-
<td>感谢 LingtrueAPI 对本项目的赞助!LingtrueAPI 是一家全球大模型API中转服务平台,提供Claude Code、Codex、Gemini 等多种顶级模型API调用服务,致力于让用户以低成本、高稳定性链接全球AI能力。LingtrueAPI为本软件用户提供了特别优惠:使用<a href="https://www.lingtrue.com/register">此链接</a>注册,并在首次充值时输入 "LingtrueAPI" 优惠码即可享受9折优惠。</td>
39+
<td>感谢 LingtrueAPI 对本项目的赞助!LingtrueAPI 是一家全球大模型API中转服务平台,提供Claude Code、Codex、Gemini 等多种顶级模型API调用服务,致力于让用户以低成本、高稳定性链接全球AI能力。LingtrueAPI为本软件用户提供了特别优惠:使用<a href="https://www.lingtrue.com/register" target="_blank">此链接</a>注册,并在首次充值时输入 "LingtrueAPI" 优惠码即可享受9折优惠。</td>
4040
</tr>
4141
<tr>
4242
<td width="180"><a href="https://poixe.com/i/m8kvep"><img src="./assets/poixeai.png" alt="PoixeAI" width="150"></a></td>
43-
<td>感谢 Poixe AI 对本项目的赞助!Poixe AI 提供可靠的 AI 模型接口服务,您可以使用平台提供的 LLM API 接口轻松构建 AI 产品,同时也可以成为供应商,为平台提供大模型资源以赚取收益。通过 CLIProxyAPI <a href="https://poixe.com/i/m8kvep">专属链接</a>注册,充值额外赠送 $5 美金</td>
43+
<td>感谢 Poixe AI 对本项目的赞助!Poixe AI 提供可靠的 AI 模型接口服务,您可以使用平台提供的 LLM API 接口轻松构建 AI 产品,同时也可以成为供应商,为平台提供大模型资源以赚取收益。通过 CLIProxyAPI <a href="https://poixe.com/i/m8kvep" target="_blank">专属链接</a>注册,充值额外赠送 $5 美金</td>
44+
</tr>
45+
<tr>
46+
<td width="180"><a href="https://coder.visioncoder.cn"><img src="./assets/visioncoder.png" alt="VisionCoder" width="150"></a></td>
47+
<td>感谢 VisionCoder 对本项目的支持。<a href="https://coder.visioncoder.cn" target="_blank">VisionCoder 开发平台</a> 是一个可靠高效的 API 中继服务提供商,提供 Claude Code、Codex、Gemini 等主流 AI 模型,帮助开发者和团队更轻松地集成 AI 功能,提升工作效率。
48+
<p></p>
49+
VisionCoder 还为我们的用户提供 <a href="https://coder.visioncoder.cn" target="_blank">Token Plan</a> 限时活动:购买 1 个月,赠送 1 个月。</td>
4450
</tr>
4551
</tbody>
4652
</table>
@@ -51,19 +57,15 @@ GLM CODING PLAN 是专为AI编码打造的订阅套餐,每月最低仅需20元
5157
- 为 CLI 模型提供 OpenAI/Gemini/Claude/Codex 兼容的 API 端点
5258
- 新增 OpenAI Codex(GPT 系列)支持(OAuth 登录)
5359
- 新增 Claude Code 支持(OAuth 登录)
54-
- 新增 Qwen Code 支持(OAuth 登录)
55-
- 新增 iFlow 支持(OAuth 登录)
5660
- 支持流式与非流式响应
5761
- 函数调用/工具支持
5862
- 多模态输入(文本、图片)
59-
- 多账户支持与轮询负载均衡(Gemini、OpenAI、Claude、Qwen 与 iFlow
60-
- 简单的 CLI 身份验证流程(Gemini、OpenAI、Claude、Qwen 与 iFlow
63+
- 多账户支持与轮询负载均衡(Gemini、OpenAI、Claude)
64+
- 简单的 CLI 身份验证流程(Gemini、OpenAI、Claude)
6165
- 支持 Gemini AIStudio API 密钥
6266
- 支持 AI Studio Build 多账户轮询
6367
- 支持 Gemini CLI 多账户轮询
6468
- 支持 Claude Code 多账户轮询
65-
- 支持 Qwen Code 多账户轮询
66-
- 支持 iFlow 多账户轮询
6769
- 支持 OpenAI Codex 多账户轮询
6870
- 通过配置接入上游 OpenAI 兼容提供商(例如 OpenRouter)
6971
- 可复用的 Go SDK(见 `docs/sdk-usage_CN.md`
@@ -131,11 +133,11 @@ CLI 封装器,用于通过 CLIProxyAPI OAuth 即时切换多个 Claude 账户
131133

132134
### [Quotio](https://github.com/nguyenphutrong/quotio)
133135

134-
原生 macOS 菜单栏应用,统一管理 Claude、Gemini、OpenAI、Qwen 和 Antigravity 订阅,提供实时配额追踪和智能自动故障转移,支持 Claude Code、OpenCode 和 Droid 等 AI 编程工具,无需 API 密钥。
136+
原生 macOS 菜单栏应用,统一管理 Claude、Gemini、OpenAI 和 Antigravity 订阅,提供实时配额追踪和智能自动故障转移,支持 Claude Code、OpenCode 和 Droid 等 AI 编程工具,无需 API 密钥。
135137

136138
### [CodMate](https://github.com/loocor/CodMate)
137139

138-
原生 macOS SwiftUI 应用,用于管理 CLI AI 会话(Claude Code、Codex、Gemini CLI),提供统一的提供商管理、Git 审查、项目组织、全局搜索和终端集成。集成 CLIProxyAPI 为 Codex、Claude、Gemini、AntigravityQwen Code 提供统一的 OAuth 认证,支持内置和第三方提供商通过单一代理端点重路由 - OAuth 提供商无需 API 密钥。
140+
原生 macOS SwiftUI 应用,用于管理 CLI AI 会话(Claude Code、Codex、Gemini CLI),提供统一的提供商管理、Git 审查、项目组织、全局搜索和终端集成。集成 CLIProxyAPI 为 Codex、Claude、Gemini 和 Antigravity 提供统一的 OAuth 认证,支持内置和第三方提供商通过单一代理端点重路由 - OAuth 提供商无需 API 密钥。
139141

140142
### [ProxyPilot](https://github.com/Finesssee/ProxyPilot)
141143

@@ -159,7 +161,7 @@ Windows 托盘应用,基于 PowerShell 脚本实现,不依赖任何第三方
159161

160162
### [霖君](https://github.com/wangdabaoqq/LinJun)
161163

162-
霖君是一款用于管理AI编程助手的跨平台桌面应用,支持macOS、Windows、Linux系统。统一管理Claude Code、Gemini CLI、OpenAI Codex、Qwen Code等AI编程工具,本地代理实现多账户配额跟踪和一键配置。
164+
霖君是一款用于管理AI编程助手的跨平台桌面应用,支持macOS、Windows、Linux系统。统一管理Claude Code、Gemini CLI、OpenAI Codex等AI编程工具,本地代理实现多账户配额跟踪和一键配置。
163165

164166
### [CLIProxyAPI Dashboard](https://github.com/itsmylife44/cliproxyapi-dashboard)
165167

@@ -175,7 +177,7 @@ Shadow AI 是一款专为受限环境设计的 AI 辅助工具。提供无窗口
175177

176178
### [ProxyPal](https://github.com/buddingnewinsights/proxypal)
177179

178-
跨平台桌面应用(macOS、Windows、Linux),以原生 GUI 封装 CLIProxyAPI。支持连接 Claude、ChatGPT、Gemini、GitHub Copilot、Qwen、iFlow 及自定义 OpenAI 兼容端点,具备使用分析、请求监控和热门编程工具自动配置功能,无需 API 密钥。
180+
跨平台桌面应用(macOS、Windows、Linux),以原生 GUI 封装 CLIProxyAPI。支持连接 Claude、ChatGPT、Gemini、GitHub Copilot 及自定义 OpenAI 兼容端点,具备使用分析、请求监控和热门编程工具自动配置功能,无需 API 密钥。
179181

180182
### [CLIProxyAPI Quota Inspector](https://github.com/AllenReder/CLIProxyAPI-Quota-Inspector)
181183

0 commit comments

Comments
 (0)