Oh My Pi

在 models.yml 中設定 OpenAI 相容 Provider，將 Oh My Pi 接入 CoffeeRouter。

接入前準備

  • 在 CoffeeRouter 控制台建立可用令牌，並記錄令牌允許使用的模型 ID。
  • 準備 CoffeeRouter OpenAI Compatible 地址 https://www.coffeerouter.ai/v1。
  • 如果透過 Bun 安裝，請使用 Bun 1.3.14 或更新版本。

設定步驟

1. 安裝 Oh My Pi

macOS 或 Linux 使用官方安裝腳本：

curl -fsSL https://omp.sh/install | sh

Windows PowerShell 使用：

irm https://omp.sh/install.ps1 | iex

也可以透過 Bun 安裝：

bun install -g @oh-my-pi/pi-coding-agent

安裝完成後執行：

omp --version

2. 設定 CoffeeRouter 令牌

macOS、Linux 或 WSL：

export COFFEEROUTER_API_KEY="sk-your-api-key"

Windows PowerShell：

$env:COFFEEROUTER_API_KEY = "sk-your-api-key"

OMP 會先把 models.yml 中的 apiKey 值作為環境變數名稱解析，因此設定中可以安全引用 COFFEEROUTER_API_KEY。

3. 新增 CoffeeRouter 服務商

開啟 ~/.omp/agent/models.yml；如果檔案不存在，可以建立它。新增以下設定，或將 coffeerouter 節點合併到已有的 providers 中：

providers:
    coffeerouter:
        baseUrl: https://www.coffeerouter.ai/v1
        apiKey: COFFEEROUTER_API_KEY
        api: openai-completions
        authHeader: true
        models:
            - id: your-model-id
              name: Your Model

將 your-model-id 替換為 CoffeeRouter 中顯示的完整模型 ID。openai-completions 會呼叫 /v1/chat/completions，因此 baseUrl 必須保留末尾的 /v1，請勿寫成 /v1/v1。

4. 選擇 CoffeeRouter 模型

直接指定模型啟動 OMP：

omp --model coffeerouter/your-model-id

也可以先執行 omp，然後在工作階段中使用 /model 選擇 coffeerouter/your-model-id。官方目前建議使用 --model；--provider 是舊式參數。

驗證接入

啟動模型後傳送一則簡單測試請求，例如讓模型說明目前專案目錄。若能正常串流回傳，且工作階段中的模型顯示為 coffeerouter/your-model-id，即表示設定成功。

還可以執行以下命令確認模型已載入：

omp models

常見問題

為什麼 Base URL 必須包含 /v1？

OMP 的 openai-completions 傳輸會在基礎地址上呼叫 /chat/completions。CoffeeRouter 的 OpenAI Compatible 基礎地址是 https://www.coffeerouter.ai/v1。

為什麼模型沒有出現在 /model 中？

檢查 models.yml 的 YAML 縮排、模型 id 和 COFFEEROUTER_API_KEY 環境變數。設定驗證失敗時，OMP 會繼續載入內建模型，但自訂服務商不會正常出現。

為什麼回傳 401？

確認啟動 OMP 的程序能讀取 COFFEEROUTER_API_KEY，令牌未過期且有可用額度。authHeader: true 會以 Bearer 方式傳送該令牌。

是否需要複製其他服務商的 compat 設定？

通常不需要。compat 用於特定端點的請求差異，應只在確認某個 CoffeeRouter 模型確實需要時新增，請勿照搬其他服務商的模型專用參數。

安全提示

請勿把令牌直接提交到 models.yml 或程式碼庫。請使用環境變數，並避免分享設定截圖和包含請求標頭的日誌。建議為 OMP 建立獨立令牌並設定模型、額度和 IP 限制。

官方資料