跳到內容

設定:CLIProxyAPI

透過本機Chat Completions代理CLIProxyAPI,將TomoriBot連線至經授權的上游服務。

請依照官方的快速開始。發行版本封存檔包含立即可執行的程式檔;選擇你的作業系統與CPU、解壓縮封存檔並驗證其總和檢查碼。可自行決定是否從Git複製建置。

啟動CLIProxyAPI前請先完成設定。若安裝程式已啟動服務,請先停止它。

在執行檔(Windows上為cli-proxy-api.exe)旁建立config.yaml。獨立的設定資料夾為選用;這些範例將兩個檔案放在一起。請將用戶端金鑰佔位符替換為由密碼管理器產生的至少32個隨機位元組(hex或base64編碼)。

config-version: 8
server:
host: "127.0.0.1"
port: 8317
discovery:
enabled: false
management:
allow-remote: false
secret-key: ""
disable-control-panel: true
access:
api-keys:
- "REPLACE_WITH_RANDOM_CLIENT_KEY"
oauth:
auth-dir: "~/.cli-proxy-api"

access.api-keys底下的用戶端金鑰用於向CLIProxyAPI驗證TomoriBot。請將config.yaml與oauth.auth-dir憑證檔案保持私密並排除在Git之外。請限制只讓你的帳號與處理程序帳號存取。

請勿設定MANAGEMENT_PASSWORD,並避免使用--password與管理TUI:空的管理密鑰會讓管理路由保持停用,包含在通道後方。如果你的版本使用不同的設定格式,請將這些設定套用到隨附的config.example.yaml。

選擇CLIProxyAPI向模型供應商驗證的方式。兩種方式皆使用上方的基礎設定。

從包含執行檔與config.yaml的資料夾執行登入指令。以下範例使用Antigravity;請替換成你供應商的旗標,並在登入前檢視同意畫面:

供應商登入旗標
Antigravity--antigravity-login
Claude--claude-login
Codex--codex-login或--codex-device-login
Terminal window
$configPath = (Resolve-Path .\config.yaml).Path
.\cli-proxy-api.exe --config $configPath --antigravity-login

完成瀏覽器登入並等待終端機回報成功。CLIProxyAPI會將憑證儲存在oauth.auth-dir中;僅使用OAuth的設定不需要上游API金鑰區塊。請讓OAuth回呼接聽程式保持在本機,並在登入與啟動時使用相同的設定路徑。其他登入旗標列於--help與上游供應商指南。

從包含config.yaml的資料夾啟動伺服器。需要時請替換為執行檔的實際路徑或已安裝的指令;請保留--config以載入這份檔案。

Terminal window
$configPath = (Resolve-Path .\config.yaml).Path
.\cli-proxy-api.exe --config $configPath

讓伺服器保持執行並繼續步驟5。請將server.host維持在127.0.0.1;不需要連入防火牆例外規則或路由器連接埠轉發。

  1. 對於與CLIProxyAPI在同一台電腦上執行的非生產環境bot,請在TomoriBot環境中設定ALLOW_PRIVATE_NETWORK=127.0.0.1:8317並重新啟動bot。使用上方設定的本機接聽器即可;不需要通道。
  2. 執行/providers(伺服器管理員)或/personal providers,並使用下列設定新增一個OpenAI 相容自訂端點:
欄位值
端點 URLhttp://127.0.0.1:8317/v1
驗證權杖來自access.api-keys的用戶端金鑰

選取已儲存的連線,使用CLIProxyAPI提供的ID或別名新增一個文字模型,並確認Discord有回覆。

這個URL假設bot直接運行在主機上。在Docker中,127.0.0.1代表容器本身,因此無法透過該位址連線到主機的接聽器。在生產環境模式執行的bot仍需要採用託管生產環境路徑。

如何列出可用模型

在CLIProxyAPI執行時,開啟另一個終端機以列出其模型ID。在載入用戶端金鑰前,請先停用PowerShell文字記錄或shell追蹤功能。完成後請關閉該終端機。

從包含config.yaml的資料夾執行此指令;它會讀取上述設定中的第一組用戶端金鑰。

Terminal window
$keyMatch = [regex]::Match((Get-Content -LiteralPath .\config.yaml -Raw), '(?m)^access:\r?\n api-keys:\r?\n - "([A-Za-z0-9+/=_-]+)"[ \t]*\r?$')
if (!$keyMatch.Success) { throw 'Expected a quoted client key under access.api-keys in config.yaml.' }
$engineKey = $keyMatch.Groups[1].Value
$headers = @{ Authorization = "Bearer $engineKey" }
$base = 'http://127.0.0.1:8317/v1'
$models = Invoke-RestMethod "$base/models" -Headers $headers
$models.data | Select-Object id
Remove-Variable engineKey, keyMatch, headers

空清單代表需要完成上游設定。HTTP 401表示伺服器有回應但拒絕了該用戶端金鑰。

症狀處理方式
401檢查用戶端金鑰,這與上游金鑰分開設定。
404請使用/v1基礎路徑,不要加上/chat/completions;並檢查模型ID。
參數遭拒絕將脈絡覆寫留空,並將思考等級設為自動;TomoriBot在輸出開始前已會重試符合條件的參數拒絕。請在啟用工具或依賴取樣控制前,先檢查紀錄中是否有降級的請求。
403、HTML登入頁面或通道錯誤請檢查通道設定。如果你啟用了Cloudflare Access,則需要完成選用的Access與Caddy設定;Discord面板無法直接提供Access標頭。
串流中斷檢查電腦休眠、上游配額、通道健康狀況,以及Cloudflare指南中的串流限制。

除非正在診斷經隱私遮罩的本機重現問題,否則請保持關閉請求與除錯紀錄。若用戶端金鑰外洩,請在CLIProxyAPI與TomoriBot已儲存的端點(以及任何使用它的選用中繼)輪替該金鑰。外洩的上游憑證請另外撤銷。

停用帳號登入

在上游帳號設定中撤銷存取權限、停止代理,並移除其本機憑證檔案。僅刪除檔案並不會撤銷權杖。

檢查本機繫結位址

若無法連線至本機API,請在CLIProxyAPI執行時從另一個終端機檢查其繫結位址:

Terminal window
Get-NetTCPConnection -LocalPort 8317 |
Select-Object LocalAddress, LocalPort, State, OwningProcess

預期只應看到127.0.0.1;若看到0.0.0.0、::、*或區域網路位址,請立即停止。請檢視現有防火牆規則(Windows上為wf.msc);不要開啟連入連接埠或新增路由器連接埠轉發。Windows的TCP狀態回報有時會漏掉可連線的端點,因此查詢包含所有狀態;選用的模型查詢會測試API可連線性。

測試本機回覆

如果模型在Discord中無法回覆,請在CLIProxyAPI執行時直接測試它。在載入用戶端金鑰前,請先停用PowerShell文字記錄或shell追蹤功能。

從包含config.yaml的資料夾執行此指令;它會讀取上述設定中的第一組用戶端金鑰。

Terminal window
$keyMatch = [regex]::Match((Get-Content -LiteralPath .\config.yaml -Raw), '(?m)^access:\r?\n api-keys:\r?\n - "([A-Za-z0-9+/=_-]+)"[ \t]*\r?$')
if (!$keyMatch.Success) { throw 'Expected a quoted client key under access.api-keys in config.yaml.' }
$engineKey = $keyMatch.Groups[1].Value
$headers = @{ Authorization = "Bearer $engineKey" }
$base = 'http://127.0.0.1:8317/v1'
$body = @{
model = Read-Host 'Model ID to test'
messages = @(@{ role = 'user'; content = 'Reply with hello.' })
stream = $false
} | ConvertTo-Json -Depth 4
$reply = Invoke-RestMethod "$base/chat/completions" -Method Post -Headers $headers -ContentType 'application/json' -Body $body
$reply.choices.message.content
Remove-Variable engineKey, keyMatch, headers

收到生成的回覆即確認上游存取正常。單純沒有socket查詢結果並不能證明API無法連線。