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. 现在，让我们启动为 OmniRoute 配置好的 Codex。运行：

omniroute launch-codex --model auto

你可以通过 codex 及其命令行参数手动指定端点和 API 密钥，但使用上述命令时，OmniRoute 会为你处理好一切。

其他 CLI 也可以通过通用启动器使用同样的一条命令启动——omniroute run <target> 支持 claude、codex、aider、goose、opencode、qwen 和 gemini（请参阅 CLI 集成）。

3. 现在，CLI 应该会将请求发送到 OmniRoute。

确认你的工具正在将请求路由到 OmniRoute

你可以点击左侧边栏中的监控/日志，查看请求的详细信息。继续点击即可查看更多详情。顺带一提，你还可以看到自己常用的工具框架向上游发送了哪些信息。这对学习和调试都很有帮助。

---

接下来做什么？

• 自动组合指南 — 让 OmniRoute 为你选择最佳 AI
• 提供者指南 — 连接更多提供者（免费和付费）
• 免费套餐指南 — 无需信用卡即可免费使用 AI
• 故障排除 — 解决常见问题

---

常见问题

“我需要 API 密钥吗？”

不需要！ 你可以使用免费提供者（Kiro、OpenCode Free、Pollinations），无需任何 API 密钥。只需在仪表板中连接它们即可。

“auto 是什么？”

auto 会让 OmniRoute 自动为每个请求选择最佳提供者。它会综合考虑速度、成本、质量和可用性。有关详细信息，请参阅自动组合指南。

“费用是多少？”

OmniRoute 本身是免费且开源的。你只需为所使用的提供者付费。许多提供者都有免费套餐——请参阅免费套餐指南。

“可以与 Claude Code / Cursor / Copilot 一起使用吗？”

可以！ OmniRoute 可与任何支持 OpenAI 格式的工具配合使用。只需将基础 URL 设置为 http://localhost:20128/v1。有关具体设置说明，请参阅 CLI 工具指南。

“如果某个提供者出现故障怎么办？”

OmniRoute 会自动跳过出现故障的提供者，并尝试下一个。你无需执行任何操作。有关详细信息，请参阅自动组合指南。

---

需要帮助？

• 故障排除 — 常见问题及解决方法
• Discord — 社区支持
• GitHub Issues — 报告错误

---

OmniRoute 源码 (a58000c7685f)