proxy
| Name | Last commit date |
|---|---|
| .github | 1 year ago |
| auths | 1 year ago |
| cmd | 1 year ago |
| docs | 1 year ago |
| examples | 1 year ago |
| internal | 1 year ago |
| sdk | 1 year ago |
| .dockerignore | 1 year ago |
| .gitignore | 1 year ago |
| .goreleaser.yml | 1 year ago |
| config.example.yaml | 1 year ago |
| docker-build.ps1 | 1 year ago |
| docker-build.sh | 1 year ago |
| docker-compose.yml | 1 year ago |
| Dockerfile | 1 year ago |
| go.mod | 1 year ago |
| go.sum | 1 year ago |
| LICENSE | 1 year ago |
| MANAGEMENT_API.md | 1 year ago |
| MANAGEMENT_API_CN.md | 1 year ago |
| README.md | 1 year ago |
| README_CN.md | 1 year ago |
CLI Proxy API
English | 中文
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.
Chinese providers have now been added: Qwen Code, iFlow.
Features
- 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
- Gemini Web support via cookie-based 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
- 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)
Installation
Prerequisites
- Go 1.24 or higher
- A Google account with access to Gemini CLI models (optional)
- An OpenAI account for Codex/GPT access (optional)
- An Anthropic account for Claude Code access (optional)
- A Qwen Chat account for Qwen Code access (optional)
- An iFlow account for iFlow access (optional)
Building from Source
-
Clone the repository:
git clone https://github.com/luispater/CLIProxyAPI.git cd CLIProxyAPI -
Build the application:
Linux, macOS:
go build -o cli-proxy-api ./cmd/serverWindows:
go build -o cli-proxy-api.exe ./cmd/server
Usage
GUI Client & Official WebUI
EasyCLI
A cross-platform desktop GUI client for CLIProxyAPI.
Cli-Proxy-API-Management-Center
A web-based management center for CLIProxyAPI.
Set remote-management.disable-control-panel to true if you prefer to host the management UI elsewhere; the server will skip downloading management.html and /management.html will return 404.
Authentication
You can authenticate for Gemini, OpenAI, Claude, Qwen, and/or iFlow. All can coexist in the same auth-dir and will be load balanced.
-
Gemini (Google):
./cli-proxy-api --loginIf you are an existing Gemini Code user, you may need to specify a project ID:
./cli-proxy-api --login --project_id <your_project_id>The local OAuth callback uses port
8085.Options: add
--no-browserto print the login URL instead of opening a browser. The local OAuth callback uses port8085. -
Gemini Web (via Cookies): This method authenticates by simulating a browser, using cookies obtained from the Gemini website.
./cli-proxy-api --gemini-web-authYou will be prompted to enter your
__Secure-1PSIDand__Secure-1PSIDTSvalues. Please retrieve these cookies from your browser's developer tools. -
OpenAI (Codex/GPT via OAuth):
./cli-proxy-api --codex-loginOptions: add
--no-browserto print the login URL instead of opening a browser. The local OAuth callback uses port1455. -
Claude (Anthropic via OAuth):
./cli-proxy-api --claude-loginOptions: add
--no-browserto print the login URL instead of opening a browser. The local OAuth callback uses port54545. -
Qwen (Qwen Chat via OAuth):
./cli-proxy-api --qwen-loginOptions: add
--no-browserto print the login URL instead of opening a browser. Use the Qwen Chat's OAuth device flow. -
iFlow (iFlow via OAuth):
./cli-proxy-api --iflow-loginOptions: add
--no-browserto print the login URL instead of opening a browser. The local OAuth callback uses port11451.
Starting the Server
Once authenticated, start the server:
./cli-proxy-api
By default, the server runs on port 8317.
API Endpoints
List Models
GET http://localhost:8317/v1/models
Chat Completions
POST http://localhost:8317/v1/chat/completions
Request body example:
{
"model": "gemini-2.5-pro",
"messages": [
{
"role": "user",
"content": "Hello, how are you?"
}
],
"stream": true
}
Notes:
- Use a
gemini-*model for Gemini (e.g., "gemini-2.5-pro"), agpt-*model for OpenAI (e.g., "gpt-5"), aclaude-*model for Claude (e.g., "claude-3-5-sonnet-20241022"), aqwen-*model for Qwen (e.g., "qwen3-coder-plus"), or an iFlow-supported model (e.g., "tstars2.0", "deepseek-v3.1", "kimi-k2", etc.). The proxy will route to the correct provider automatically.
Claude Messages (SSE-compatible)
POST http://localhost:8317/v1/messages
Using with OpenAI Libraries
You can use this proxy with any OpenAI-compatible library by setting the base URL to your local server:
Python (with OpenAI library)
from openai import OpenAI
client = OpenAI(
api_key="dummy", # Not used but required
base_url="http://localhost:8317/v1"
)
# Gemini example
gemini = client.chat.completions.create(
model="gemini-2.5-pro",
messages=[{"role": "user", "content": "Hello, how are you?"}]
)
# Codex/GPT example
gpt = client.chat.completions.create(
model="gpt-5",
messages=[{"role": "user", "content": "Summarize this project in one sentence."}]
)
# Claude example (using messages endpoint)
import requests
claude_response = requests.post(
"http://localhost:8317/v1/messages",
json={
"model": "claude-3-5-sonnet-20241022",
"messages": [{"role": "user", "content": "Summarize this project in one sentence."}],
"max_tokens": 1000
}
)
print(gemini.choices[0].message.content)
print(gpt.choices[0].message.content)
print(claude_response.json())
JavaScript/TypeScript
import OpenAI from 'openai';
const openai = new OpenAI({
apiKey: 'dummy', // Not used but required
baseURL: 'http://localhost:8317/v1',
});
// Gemini
const gemini = await openai.chat.completions.create({
model: 'gemini-2.5-pro',
messages: [{ role: 'user', content: 'Hello, how are you?' }],
});
// Codex/GPT
const gpt = await openai.chat.completions.create({
model: 'gpt-5',
messages: [{ role: 'user', content: 'Summarize this project in one sentence.' }],
});
// Claude example (using messages endpoint)
const claudeResponse = await fetch('http://localhost:8317/v1/messages', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
model: 'claude-3-5-sonnet-20241022',
messages: [{ role: 'user', content: 'Summarize this project in one sentence.' }],
max_tokens: 1000
})
});
console.log(gemini.choices[0].message.content);
console.log(gpt.choices[0].message.content);
console.log(await claudeResponse.json());
Supported Models
- gemini-2.5-pro
- gemini-2.5-flash
- gemini-2.5-flash-lite
- gemini-2.5-flash-image-preview
- gpt-5
- gpt-5-codex
- claude-opus-4-1-20250805
- claude-opus-4-20250514
- claude-sonnet-4-20250514
- claude-sonnet-4-5-20250929
- claude-3-7-sonnet-20250219
- claude-3-5-haiku-20241022
- qwen3-coder-plus
- qwen3-coder-flash
- qwen3-max
- qwen3-vl-plus
- deepseek-v3.2
- deepseek-v3.1
- deepseek-r1
- deepseek-v3
- kimi-k2
- glm-4.5
- tstars2.0
- And other iFlow-supported models
- Gemini models auto-switch to preview variants when needed
Configuration
The server uses a YAML configuration file (config.yaml) located in the project root directory by default. You can specify a different configuration file path using the --config flag:
./cli-proxy-api --config /path/to/your/config.yaml
Configuration Options
| Parameter | Type | Default | Description |
|---|---|---|---|
port |
integer | 8317 | The port number on which the server will listen. |
auth-dir |
string | "~/.cli-proxy-api" | Directory where authentication tokens are stored. Supports using ~ for the home directory. If you use Windows, please set the directory like this: C:/cli-proxy-api/ |
proxy-url |
string | "" | Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/ |
request-retry |
integer | 0 | Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504. |
remote-management.allow-remote |
boolean | false | Whether to allow remote (non-localhost) access to the management API. If false, only localhost can access. A management key is still required for localhost. |
remote-management.secret-key |
string | "" | Management key. If a plaintext value is provided, it will be hashed on startup using bcrypt and persisted back to the config file. If empty, the entire management API is disabled (404). |
remote-management.disable-control-panel |
boolean | false | When true, skip downloading management.html and return 404 for /management.html, effectively disabling the bundled management UI. |
quota-exceeded |
object | {} | Configuration for handling quota exceeded. |
quota-exceeded.switch-project |
boolean | true | Whether to automatically switch to another project when a quota is exceeded. |
quota-exceeded.switch-preview-model |
boolean | true | Whether to automatically switch to a preview model when a quota is exceeded. |
debug |
boolean | false | Enable debug mode for verbose logging. |
logging-to-file |
boolean | true | Write application logs to rotating files instead of stdout. Set to false to log to stdout/stderr. |
usage-statistics-enabled |
boolean | true | Enable in-memory usage aggregation for management APIs. Disable to drop all collected usage metrics. |
api-keys |
string[] | [] | Legacy shorthand for inline API keys. Values are mirrored into the config-api-key provider for backwards compatibility. |
generative-language-api-key |
string[] | [] | List of Generative Language API keys. |
codex-api-key |
object | {} | List of Codex API keys. |
codex-api-key.api-key |
string | "" | Codex API key. |
codex-api-key.base-url |
string | "" | Custom Codex API endpoint, if you use a third-party API endpoint. |
codex-api-key.proxy-url |
string | "" | Proxy URL for this specific API key. Overrides the global proxy-url setting. Supports socks5/http/https protocols. |
claude-api-key |
object | {} | List of Claude API keys. |
claude-api-key.api-key |
string | "" | Claude API key. |
claude-api-key.base-url |
string | "" | Custom Claude API endpoint, if you use a third-party API endpoint. |
claude-api-key.proxy-url |
string | "" | Proxy URL for this specific API key. Overrides the global proxy-url setting. Supports socks5/http/https protocols. |
openai-compatibility |
object[] | [] | Upstream OpenAI-compatible providers configuration (name, base-url, api-keys, models). |
openai-compatibility.*.name |
string | "" | The name of the provider. It will be used in the user agent and other places. |
openai-compatibility.*.base-url |
string | "" | The base URL of the provider. |
openai-compatibility.*.api-keys |
string[] | [] | (Deprecated) The API keys for the provider. Use api-key-entries instead for per-key proxy support. |
openai-compatibility.*.api-key-entries |
object[] | [] | API key entries with optional per-key proxy configuration. Preferred over api-keys. |
openai-compatibility.*.api-key-entries.*.api-key |
string | "" | The API key for this entry. |
openai-compatibility.*.api-key-entries.*.proxy-url |
string | "" | Proxy URL for this specific API key. Overrides the global proxy-url setting. Supports socks5/http/https protocols. |
openai-compatibility.*.models |
object[] | [] | The actual model name. |
openai-compatibility.*.models.*.name |
string | "" | The models supported by the provider. |
openai-compatibility.*.models.*.alias |
string | "" | The alias used in the API. |
gemini-web |
object | {} | Configuration specific to the Gemini Web client. |
gemini-web.context |
boolean | true | Enables conversation context reuse for continuous dialogue. |
gemini-web.gem-mode |
string | "" | Selects a predefined Gem to attach for Gemini Web requests; allowed values: coding-partner, writing-editor. When empty, no Gem is attached. |
gemini-web.max-chars-per-request |
integer | 1,000,000 | The maximum number of characters to send to Gemini Web in a single request. |
gemini-web.disable-continuation-hint |
boolean | false | Disables the continuation hint for split prompts. |
Example Configuration File
# Server port
port: 8317
# Management API settings
remote-management:
# Whether to allow remote (non-localhost) management access.
# When false, only localhost can access management endpoints (a key is still required).
allow-remote: false
# Management key. If a plaintext value is provided here, it will be hashed on startup.
# All management requests (even from localhost) require this key.
# Leave empty to disable the Management API entirely (404 for all /v0/management routes).
secret-key: ""
# Disable the bundled management control panel asset download and HTTP route when true.
disable-control-panel: false
# Authentication directory (supports ~ for home directory). If you use Windows, please set the directory like this: `C:/cli-proxy-api/`
auth-dir: "~/.cli-proxy-api"
# Enable debug logging
debug: false
# When true, write application logs to rotating files instead of stdout
logging-to-file: true
# When false, disable in-memory usage statistics aggregation
usage-statistics-enabled: true
# Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/
proxy-url: ""
# Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504.
request-retry: 3
# Quota exceeded behavior
quota-exceeded:
switch-project: true # Whether to automatically switch to another project when a quota is exceeded
switch-preview-model: true # Whether to automatically switch to a preview model when a quota is exceeded
# Gemini Web client configuration
gemini-web:
context: true # Enable conversation context reuse
gem-mode: "" # Select Gem: "coding-partner" or "writing-editor"; empty means no Gem
max-chars-per-request: 1000000 # Max characters per request
# API keys for official Generative Language API
generative-language-api-key:
- "AIzaSy...01"
- "AIzaSy...02"
- "AIzaSy...03"
- "AIzaSy...04"
# Codex API keys
codex-api-key:
- api-key: "sk-atSM..."
base-url: "https://www.example.com" # use the custom codex API endpoint
proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
# Claude API keys
claude-api-key:
- api-key: "sk-atSM..." # use the official claude API key, no need to set the base url
- api-key: "sk-atSM..."
base-url: "https://www.example.com" # use the custom claude API endpoint
proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
# OpenAI compatibility providers
openai-compatibility:
- name: "openrouter" # The name of the provider; it will be used in the user agent and other places.
base-url: "https://openrouter.ai/api/v1" # The base URL of the provider.
# New format with per-key proxy support (recommended):
api-key-entries:
- api-key: "sk-or-v1-...b780"
proxy-url: "socks5://proxy.example.com:1080" # optional: per-key proxy override
- api-key: "sk-or-v1-...b781" # without proxy-url
# Legacy format (still supported, but cannot specify proxy per key):
# api-keys:
# - "sk-or-v1-...b780"
# - "sk-or-v1-...b781"
models: # The models supported by the provider.
- name: "moonshotai/kimi-k2:free" # The actual model name.
alias: "kimi-k2" # The alias used in the API.
OpenAI Compatibility Providers
Configure upstream OpenAI-compatible providers (e.g., OpenRouter) via openai-compatibility.
- name: provider identifier used internally
- base-url: provider base URL
- api-key-entries: list of API key entries with optional per-key proxy configuration (recommended)
- api-keys: (deprecated) simple list of API keys without proxy support
- models: list of mappings from upstream model
nameto localalias
Example with per-key proxy support:
openai-compatibility:
- name: "openrouter"
base-url: "https://openrouter.ai/api/v1"
api-key-entries:
- api-key: "sk-or-v1-...b780"
proxy-url: "socks5://proxy.example.com:1080"
- api-key: "sk-or-v1-...b781"
models:
- name: "moonshotai/kimi-k2:free"
alias: "kimi-k2"
Legacy format (still supported):
openai-compatibility:
- name: "openrouter"
base-url: "https://openrouter.ai/api/v1"
api-keys:
- "sk-or-v1-...b780"
- "sk-or-v1-...b781"
models:
- name: "moonshotai/kimi-k2:free"
alias: "kimi-k2"
Usage:
Call OpenAI's endpoint /v1/chat/completions with model set to the alias (e.g., kimi-k2). The proxy routes to the configured provider/model automatically.
Also, you may call Claude's endpoint /v1/messages, Gemini's /v1beta/models/model-name:streamGenerateContent or /v1beta/models/model-name:generateContent.
And you can always use Gemini CLI with CODE_ASSIST_ENDPOINT set to http://127.0.0.1:8317 for these OpenAI-compatible provider's models.
Authentication Directory
The auth-dir parameter specifies where authentication tokens are stored. When you run the login command, the application will create JSON files in this directory containing the authentication tokens for your Google accounts. Multiple accounts can be used for load balancing.
Request Authentication Providers
Configure inbound authentication through the auth.providers section. The built-in config-api-key provider works with inline keys:
auth:
providers:
- name: default
type: config-api-key
api-keys:
- your-api-key-1
Clients should send requests with an Authorization: Bearer your-api-key-1 header (or X-Goog-Api-Key, X-Api-Key, or ?key= as before). The legacy top-level api-keys array is still accepted and automatically synced to the default provider for backwards compatibility.
Official Generative Language API
The generative-language-api-key parameter allows you to define a list of API keys that can be used to authenticate requests to the official Generative Language API.
Hot Reloading
The server watches the config file and the auth-dir for changes and reloads clients and settings automatically. You can add or remove Gemini/OpenAI token JSON files while the server is running; no restart is required.
Gemini CLI with multiple account load balancing
Start CLI Proxy API server, and then set the CODE_ASSIST_ENDPOINT environment variable to the URL of the CLI Proxy API server.
Document preview limited. Open the file to continue