Quick Start: Get OmniRoute Running in 3 Minutes (中文 (繁體))

步驟 1：安裝 OmniRoute

選擇您偏好的方式：

選項 A：npm（建議）

npm install -g omniroute

選項 B：Docker

docker run -d --name omniroute -p 20128:20128 diegosouzapw/omniroute:latest

:latest 是已發布且版本號最高的穩定 SemVer。它不會追蹤 git main。若用於 GitOps，請固定使用 diegosouzapw/omniroute:X.Y.Z。請參閱映像標籤／發布通道。

選項 C：從原始碼安裝

git clone https://github.com/diegosouzapw/OmniRoute.git
cd OmniRoute
npm install
npm run dev

---

步驟 2：啟動 OmniRoute

omniroute

OmniRoute 會在 http://localhost:20128 啟動。儀表板將自動開啟。

---

步驟 3：連接免費提供者

您可以連接免費提供者，無須支付任何費用即可使用 OmniRoute。

選項 A：Kiro（免費 Claude — 無須信用卡）

1. 在 http://localhost:20128 開啟儀表板
2. 前往 提供者 → 新增提供者
3. 選取 Kiro AI
4. 按一下 連接（無須 API 金鑰！）
5. 完成！您現在可以免費使用 Claude 模型。

選項 B：OpenCode Free（無須驗證）

1. 在 http://localhost:20128 開啟儀表板
2. 前往 提供者 → 新增提供者
3. 選取 OpenCode Free
4. 按一下 連接（無須 API 金鑰！）
5. 完成！您現在可以免費使用多種模型。

選項 C：Pollinations（無須金鑰）

1. 在 http://localhost:20128 開啟儀表板
2. 前往 提供者 → 新增提供者
3. 選取 Pollinations
4. 按一下 連接（無須 API 金鑰！）
5. 完成！您現在可以免費使用 GPT-5、Claude、Gemini 等模型。

---

步驟 4：確認運作正常

從 API 金鑰建立新的金鑰。請妥善保存此金鑰，因為之後將不會再次顯示。請注意，此金鑰是供工具存取 OmniRoute 使用，並非用於存取上游提供者。

curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"

您應該會看到已連接的模型清單。

---

步驟 5：將您的 IDE 或 CLI 指向 OmniRoute

在您的 IDE 或 CLI 工具中設定：

基礎 URL：http://localhost:20128/v1
API 金鑰：[從儀表板 → 端點複製]
模型：    auto

就是這樣！您的 IDE 現在會使用 OmniRoute，並自動選擇提供者。

IDE 範例：VSCode/Continue.dev

1. 在 VSCode 中安裝 Continue.dev 擴充功能。
2. 更新您的 ~/.continue/config.yaml，加入以下內容：

  - name: OmniRoute - Auto
    provider: openai
    model: auto
    apiBase: http://localhost:20128/v1
    apiKey: <YOUR_KEY>

3. 在 Continue.dev 聊天窗格中選取 OmniRoute - Auto，之後的請求就會傳送至 OmniRoute。
4. （選用）留給讀者的練習：讓您的 IDE 使用所有其他預先建置的組態更新 config.yaml 😊

CLI 範例：Codex CLI

1. 在您的作業系統中永久設定環境變數。 若使用 macOS/Linux（加入您的 ~/.bashrc 或 ~/.zshrc）：

export OMNIROUTE_API_KEY="<YOUR_KEY>"

若使用 Windows（命令提示字元）：

setx OMNIROUTE_API_KEY <YOUR_KEY>

2. 現在讓我們啟動 Codex，並將其設定為使用 OmniRoute。請執行：

omniroute launch-codex --model auto

您也可以透過 codex 和命令列參數手動指定端點與 API 金鑰；不過，使用上述命令時，OmniRoute 會為您處理一切。

透過通用啟動器，其他 CLI 也支援相同的單一命令啟動方式——omniroute run <target> 支援 claude、codex、aider、goose、opencode、qwen 和 gemini（請參閱 CLI 整合）。

3. CLI 現在應該會將請求傳送至 OmniRoute。

確認您的工具正透過 OmniRoute 路由

您可以按一下左側邊欄中的監控／日誌，查看請求的詳細資訊。按進去即可查看更多詳細內容。順帶一提，您也可以查看自己偏好的工具框架傳送了哪些資訊。這對於學習和偵錯很有幫助。

---

接下來呢？

• Auto-Combo 指南 — 讓 OmniRoute 為您選擇最佳 AI
• 提供者指南 — 連接更多提供者（免費及付費）
• 免費方案指南 — 無須信用卡即可免費使用 AI
• 疑難排解 — 修正常見問題

---

常見問題

「我需要 API 金鑰嗎？」

不需要！ 您可以使用免費提供者（Kiro、OpenCode Free、Pollinations），無須任何 API 金鑰。只需在儀表板中連接它們即可。

「auto 是什麼？」

auto 會指示 OmniRoute 為每個請求自動選擇最佳提供者。它會考量速度、成本、品質及可用性。詳細資訊請參閱 Auto-Combo 指南。

「費用是多少？」

OmniRoute 本身是免費且開放原始碼的。您只需為所使用的提供者付費。許多提供者都提供免費方案——請參閱免費方案指南。

「我可以搭配 Claude Code／Cursor／Copilot 使用嗎？」

可以！ OmniRoute 可搭配任何支援 OpenAI 格式的工具使用。只需將基礎 URL 設定為 http://localhost:20128/v1。如需特定設定說明，請參閱 CLI 工具指南。

「如果提供者中斷服務怎麼辦？」

OmniRoute 會自動略過失敗的提供者，並嘗試下一個。您無須進行任何操作。詳細資訊請參閱 Auto-Combo 指南。

---

需要協助嗎？

• 疑難排解 — 常見問題與修正方式
• Discord — 社群支援
• GitHub Issues — 回報錯誤

---

OmniRoute 原始碼 (a58000c7685f)