跳转到内容

配置选项

以下默认值与 config.example.yaml 保持同步。

基础

参数类型默认值描述
hoststring""绑定地址;"" 监听所有 IPv4/IPv6;用 127.0.0.1 仅限本机。
portinteger8317服务器监听端口。
tls.enablebooleanfalse是否启用 HTTPS。
tls.certstring""TLS 证书路径。
tls.keystring""TLS 私钥路径。
auth-dirstring"~/.cli-proxy-api"身份凭据目录,支持 ~
api-keysstring[][]内置 API 密钥列表。
debugbooleanfalse调试日志。
commercial-modebooleanfalse关闭高开销中间件以降低内存。
logging-to-filebooleanfalse写入滚动日志文件而非 stdout。
logs-max-total-size-mbinteger0日志目录大小上限,0 表示不限制。
usage-statistics-enabledbooleanfalse是否启用内存用量统计。
proxy-urlstring""全局代理,支持 socks5/http/https。
force-model-prefixbooleanfalse无前缀的模型请求仅使用无前缀凭据。
request-retryinteger3403/408/500/502/503/504 时的重试次数。
max-retry-intervalinteger30冷却凭据等待秒数上限,超出即触发重试。
routing.strategystring"round-robin"多匹配凭据的选择策略:round-robinfill-first
ws-authbooleanfalse是否为 /v1/ws 启用认证。
nonstream-keepalive-intervalinteger0非 SSE 流每隔 N 秒发送空行防止空闲超时;0 禁用。
codex-instructions-enabledbooleanfalse是否为 Codex API 请求启用官方 Codex 指令注入。
streaming.keepalive-secondsinteger0SSE 保活间隔,≤0 禁用。
streaming.bootstrap-retriesinteger0首字节前的安全重试次数。

管理 API

参数类型默认值描述
remote-management.allow-remotebooleanfalse是否允许非 localhost 访问管理接口。
remote-management.secret-keystring""管理密钥;明文将启动时哈希;为空则整体 404。
remote-management.disable-control-panelbooleanfalsetrue 时禁用内置管理面板资源与路由。
remote-management.panel-github-repositorystring"https://github.com/router-for-me/Cli-Proxy-API-Management-Center"管理面板资源仓库或 releases API 地址。

配额与路由

参数类型默认值描述
quota-exceeded.switch-projectbooleantrue配额超限时自动切换项目。
quota-exceeded.switch-preview-modelbooleantrue配额超限时自动切换预览模型。

提供商凭据(均为数组,未配置时默认 []

Gemini

参数类型默认值描述
gemini-api-key.*.api-keystring""API Key。
gemini-api-key.*.prefixstring""可选前缀,需以 prefix/model 访问。
gemini-api-key.*.base-urlstring"https://generativelanguage.googleapis.com"自定义端点。
gemini-api-key.*.headersobject{}仅对该端点附加的自定义请求头。
gemini-api-key.*.proxy-urlstring""覆盖全局代理。
gemini-api-key.*.models.*.namestring""上游模型名。
gemini-api-key.*.models.*.aliasstring""客户端别名。
gemini-api-key.*.excluded-modelsstring[][]排除匹配的模型(支持通配符)。

Codex

参数类型默认值描述
codex-api-key.*.api-keystring""API Key。
codex-api-key.*.prefixstring""可选前缀。
codex-api-key.*.base-urlstring""自定义 Codex 端点。
codex-api-key.*.headersobject{}自定义请求头。
codex-api-key.*.proxy-urlstring""覆盖全局代理。
codex-api-key.*.models.*.namestring""上游模型名。
codex-api-key.*.models.*.aliasstring""客户端别名。
codex-api-key.*.excluded-modelsstring[][]排除模型(支持通配符)。

Claude

参数类型默认值描述
claude-api-key.*.api-keystring""API Key。
claude-api-key.*.prefixstring""可选前缀。
claude-api-key.*.base-urlstring""自定义 Claude 端点。
claude-api-key.*.headersobject{}自定义请求头。
claude-api-key.*.proxy-urlstring""覆盖全局代理。
claude-api-key.*.models.*.namestring""上游模型名。
claude-api-key.*.models.*.aliasstring""客户端别名。
claude-api-key.*.excluded-modelsstring[][]排除模型(支持通配符)。
claude-api-key.*.cloak.modestring"auto"伪装模式:auto(仅非 Claude Code)、alwaysnever
claude-api-key.*.cloak.strict-modebooleanfalsetrue 时删除用户系统消息,仅保留 Claude Code 提示。
claude-api-key.*.cloak.sensitive-wordsstring[][]需用零宽字符混淆的敏感词。

OpenAI 兼容提供商

参数类型默认值描述
openai-compatibility.*.namestring""提供商名称(用于 UA 等)。
openai-compatibility.*.prefixstring""可选前缀。
openai-compatibility.*.base-urlstring""提供商基础 URL。
openai-compatibility.*.headersobject{}额外请求头。
openai-compatibility.*.api-key-entries.*.api-keystring""API Key。
openai-compatibility.*.api-key-entries.*.proxy-urlstring""针对该密钥的代理。
openai-compatibility.*.models.*.namestring""上游模型名。
openai-compatibility.*.models.*.aliasstring""客户端别名。

Vertex

参数类型默认值描述
vertex-api-key.*.api-keystring""x-goog-api-key 值。
vertex-api-key.*.prefixstring""可选前缀。
vertex-api-key.*.base-urlstring""Vertex 兼容端点。
vertex-api-key.*.proxy-urlstring""针对该密钥的代理。
vertex-api-key.*.headersobject{}额外请求头。
vertex-api-key.*.models.*.namestring""上游模型名。
vertex-api-key.*.models.*.aliasstring""客户端别名。

Amp 集成 (ampcode)

参数类型默认值描述
ampcode.upstream-urlstring""Amp CLI OAuth/管理上游地址。
ampcode.upstream-api-keystring""覆盖用的 Amp 上游 API Key。
ampcode.upstream-api-keys[].upstream-api-keystring""为特定客户端映射的上游 Key。
ampcode.upstream-api-keys[].api-keysstring[][]需要映射到该上游 Key 的客户端密钥。
ampcode.restrict-management-to-localhostbooleanfalse是否将 Amp 管理路由限制为 localhost。
ampcode.force-model-mappingsbooleanfalse是否在检查本地 API 密钥前强制执行模型映射。
ampcode.model-mappings[].fromstring""Amp 请求的模型名。
ampcode.model-mappings[].tostring""本地可用模型名。

OAuth 模型别名

参数类型默认值描述
oauth-model-aliasobject{}按渠道为模型重命名(gemini-cli、vertex、aistudio、antigravity、claude、codex、qwen、iflow)。
oauth-model-alias.*.*.forkbooleanfalsetrue 时保留原名并同时添加别名作为额外模型。
oauth-excluded-modelsobject{}按渠道排除模型,支持通配符。

Payload 规则

参数类型默认值描述
payload.default[].models[].namestring""匹配的模型名(可通配)。
payload.default[].models[].protocolstring""限定协议:openai/gemini/claude/codex/antigravity
payload.default[].paramsobject{}缺省时写入的 JSON 路径 → 值。
payload.default-raw[].models[].namestring""匹配的模型名(可通配)。
payload.default-raw[].models[].protocolstring""限定协议。
payload.default-raw[].paramsobject{}缺省时写入的原始 JSON 路径 → 值(必须是有效 JSON)。
payload.override[].models[].namestring""匹配的模型名(可通配)。
payload.override[].models[].protocolstring""限定协议。
payload.override[].paramsobject{}总是覆盖的 JSON 路径 → 值。
payload.override-raw[].models[].namestring""匹配的模型名(可通配)。
payload.override-raw[].models[].protocolstring""限定协议。
payload.override-raw[].paramsobject{}总是覆盖的原始 JSON 路径 → 值(必须是有效 JSON)。
payload.filter[].models[].namestring""匹配的模型名(可通配)。
payload.filter[].models[].protocolstring""限定协议。
payload.filter[].paramsstring[][]要删除的 JSON 路径列表。

基于 MIT 协议发布