跳至主要內容

設定選項

以下預設值與 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冷卻憑證等待秒數上限,超出即觸發重試。
disable-image-generationboolean | "chat"false控制內建 image_generation 工具的插入與可用性:true 時完全停用(/v1/images/generations/v1/images/edits 也會傳回 404);"chat" 時只停用非 images 端點的插入,images 端點仍可使用。
routing.strategystring"round-robin"多匹配憑證的選擇策略:round-robinfill-first
routing.session-affinitybooleanfalse是否啟用工作階段黏著性路由。工作階段 ID 取自 metadata.user_id(Claude Code)、X-Session-IDSession_id(Codex)、X-Client-Request-Id(PI)、conversation_id 或訊息雜湊。
routing.session-affinity-ttlstring"1h"會話到憑證繫結的保留時長(TTL)。
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-panelbooleanfalse設為 true 時停用內建管理面板資源與路由。
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配額超限時自動切換預覽模型。
quota-exceeded.antigravity-creditsbooleantrueClaude 模型 credits 備援:當所有 free-tier 憑證耗盡(429/503)時,使用帶 Google One AI credits 的憑證進行最後備援重試。

供應商憑證(均為陣列,未設定時預設 []

Gemini

參數型別預設值描述
gemini-api-key.*.api-keystring""API 金鑰。
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 金鑰。
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 金鑰。
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.*.disabledbooleanfalse停用該供應商(無需刪除設定),路由/選鑰會跳過。
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""使用者端別名。

OAuth 模型別名

參數型別預設值描述
oauth-model-aliasobject{}依供應商管道為模型重新命名(vertex、aistudio、antigravity、claude、codex)。
oauth-model-alias.*.*.forkbooleanfalsetrue 時保留原名並同時新增別名作為額外模型。
oauth-excluded-modelsobject{}按管道排除模型,支援萬用字元。

Payload 規則

參數型別預設值描述
payload.default[].models[].namestring""符合的模型名稱(支援萬用字元)。
payload.default[].models[].protocolstring""限定 API 格式: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 授權條款釋出。