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. Providers → Add Provider に移動します
3. Kiro AI を選択します
4. Connect をクリックします（API キーは不要です！）
5. 完了です！これで Claude モデルに無料でアクセスできます。

オプション B: OpenCode Free（認証不要）

1. http://localhost:20128 でダッシュボードを開きます
2. Providers → Add Provider に移動します
3. OpenCode Free を選択します
4. Connect をクリックします（API キーは不要です！）
5. 完了です！これで複数のモデルに無料でアクセスできます。

オプション C: Pollinations（キー不要）

1. http://localhost:20128 でダッシュボードを開きます
2. Providers → Add Provider に移動します
3. Pollinations を選択します
4. Connect をクリックします（API キーは不要です！）
5. 完了です！これで GPT-5、Claude、Gemini などに無料でアクセスできます。

---

ステップ 4: 動作を確認する

API Keys で新しいキーを作成します。このキーは再表示されないため、安全に保管してください。このキーはツールから OmniRoute にアクセスするためのものであり、上流プロバイダーにアクセスするためのものではない点に注意してください。

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

接続済みのモデルが一覧表示されます。

---

ステップ 5: IDE または CLI の接続先を OmniRoute に設定する

IDE または CLI ツールで、次のように設定します。

ベース URL: http://localhost:20128/v1
API キー:   [Dashboard → Endpoints からコピー]
モデル:     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 も同様に 1 つのコマンドで起動できます。omniroute run <target> は claude、codex、aider、goose、opencode、qwen、gemini をサポートしています（CLI 連携を参照してください）。

3. これで CLI から OmniRoute にリクエストが送信されます。

ツールが OmniRoute にルーティングされていることを確認する

左側のサイドバーから Monitoring/Logs をクリックすると、リクエストの詳細を確認できます。さらにクリックしていくと、より詳しい情報が表示されます。なお、お気に入りのハーネスからどのような情報が送信されているかも確認できます。これは学習やデバッグの観点で役立ちます。

---

次のステップ

• 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 — バグを報告する

---

undefined (a58000c7685f)