README.md
Stacking free tiers by hand is painful — dozens of SDKs, dozens of rate limits, and no idea how much you actually have. OmniRoute aggregates the documented free tiers of 42 provider pools / 495 models into one honest number and shows it live on the dashboard (
/dashboard/free-tiers).
<div align="center"> <h3>Animated summary of the live
/dashboard/free-tierspage. Full methodology (pool dedupe, credit tiers, provider terms): docs/reference/FREE_TIERS.md.<sub>These figures are re-audited every two weeks against the live catalog and move both ways — a provider ends a free tier and the number drops; a new one lands and it climbs. We publish what the catalog actually computes, never a rounded-up best case.</sub>
⭐ Star the repo if OMNIROUTE helped you save money and make your work easier.
</h3><a href="https://trendshift.io/repositories/23589" target="_blank"></a>
👋 Follow the maintainer — get new providers, releases & tips first:
Questions, provider tips, roadmap & support → Discord · Telegram · WhatsApp 🌍 Global / 🇧🇷 Brasil
| v3.8.49 | v3.8.50 | v3.8.51+ | |
|---|---|---|---|
| 🌐 Providers | 291 | 339 | more queued |
| 🧠 Documented models | 500+ | 1200+ | — |
| 🖼️ Modality Bridge | — | 🆕 vision | video |
| 📡 Radar free catalog | — | — | 🔭 next |
| ⚖️ Quota-aware scheduling | — | — | 🔭 next |
| 📊 Quota telemetry | — | — | 🔭 next |
→ Roadmap — riding the rail to v3.9.0 LTS
<a href="README.md"></a> <a href="docs/i18n/pt-BR/README.md"></a> <a href="docs/i18n/pt/README.md"></a> <a href="docs/i18n/es/README.md"></a> <a href="docs/i18n/fr/README.md"></a> <a href="docs/i18n/it/README.md"></a> <a href="docs/i18n/de/README.md"></a> <a href="docs/i18n/nl/README.md"></a> <a href="docs/i18n/ru/README.md"></a> <a href="docs/i18n/uk-UA/README.md"></a> <a href="docs/i18n/pl/README.md"></a> <a href="docs/i18n/cs/README.md"></a> <a href="docs/i18n/sk/README.md"></a> <a href="docs/i18n/ro/README.md"></a> <a href="docs/i18n/hu/README.md"></a> <a href="docs/i18n/bg/README.md"></a> <a href="docs/i18n/da/README.md"></a> <a href="docs/i18n/fi/README.md"></a> <a href="docs/i18n/no/README.md"></a> <a href="docs/i18n/sv/README.md"></a> <a href="docs/i18n/zh-CN/README.md"></a> <a href="docs/i18n/zh-TW/README.md"></a> <a href="docs/i18n/ja/README.md"></a> <a href="docs/i18n/ko/README.md"></a> <a href="docs/i18n/th/README.md"></a> <a href="docs/i18n/vi/README.md"></a> <a href="docs/i18n/id/README.md"></a> <a href="docs/i18n/ms/README.md"></a> <a href="docs/i18n/phi/README.md"></a> <a href="docs/i18n/in/README.md"></a> <a href="docs/i18n/hi/README.md"></a> <a href="docs/i18n/gu/README.md"></a> <a href="docs/i18n/mr/README.md"></a> <a href="docs/i18n/ta/README.md"></a> <a href="docs/i18n/te/README.md"></a> <a href="docs/i18n/bn/README.md"></a> <a href="docs/i18n/ur/README.md"></a> <a href="docs/i18n/fa/README.md"></a> <a href="docs/i18n/ar/README.md"></a> <a href="docs/i18n/he/README.md"></a> <a href="docs/i18n/tr/README.md"></a> <a href="docs/i18n/az/README.md"></a> <a href="docs/i18n/sw/README.md"></a>
</div> <div align="center"># Fresh install, zero credentials — `auto` already works:
curl http://localhost:20128/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{"model":"auto","messages":[{"role":"user","content":"Hello!"}]}'
<sub>Prefer a specific free backend? Call it directly, e.g. oc/… (OpenCode Free) or felo/… (Felo). Then graduate to auto and let OmniRoute pick.</sub>
<sub>📦 Copy-paste quickstart scripts for Python, Node.js, PHP, and cURL → examples/quickstart/</sub>
<table> <tr> <td align="center" width="150"> <a href="https://platform.kimi.ai?track_id=track-8197581fdd7d4139a0f562e4a03c3798&aff=omniroute"> <picture> <source media="(prefers-color-scheme: dark)" srcset="public/providers/kimi-logomark-dark.svg">Want to join as an Open Source Friend? These are the companies that back open source and help keep OmniRoute moving — and we say publicly where every token they give us goes. Reach out: [email protected]
</picture>
</a>
<b>Kimi</b> <sub>Moonshot AI</sub>
</td>
<td>
Thanks to <b>Kimi (Moonshot AI)</b>, our founding Open Source Friend, for backing this project! Kimi is the AI lab behind the open-weight K2 and K3 model families — <b>Kimi K3</b> delivers a 1M-token context window, native vision and frontier-level coding at a fraction of closed-model prices, and works out of the box with Claude Code, Codex and every coding tool OmniRoute serves.
<b>What Kimi's support powers:</b> Kimi's API credits power OmniRoute's AI-validated release pipeline — the <i>merge validation powered by Kimi K3</i> stage that reviews every pull request before it ships — plus day-to-day feature development. First-class Kimi support ships on both rails: the direct <a href="https://platform.kimi.ai?track_id=track-8197581fdd7d4139a0f562e4a03c3798&aff=omniroute">Kimi API</a> (<code>kimi-k3</code>) and the <a href="https://www.kimi.com/code?aff=omniroute">Kimi Code coding plan</a> (OAuth and API key). OmniRoute is also the first Brazilian open-source project in Kimi's support program. <a href="https://platform.kimi.ai?track_id=track-8197581fdd7d4139a0f562e4a03c3798&aff=omniroute"><b>Get a Kimi API key with 15% extra credits →</b></a>
</td>
</a>
<b>Cheaper Inference</b> <sub>cheaperinference.com</sub>
</td>
<td>
Thanks to <b>Cheaper Inference</b>, an OmniRoute Open Source Friend, for backing this project! Cheaper Inference is a cost-ranked gateway that resells 42 frontier models — Claude, GPT-5.x, Gemini, Kimi K3, GLM, DeepSeek, Grok and MiniMax — behind one OpenAI-compatible endpoint, routing each request to the cheapest eligible provider without ever charging above the model maker's list price.
<b>First-class support in OmniRoute:</b> Chat Completions, the native <code>/v1/responses</code> endpoint, vision, tool calling and 3 image models (<code>grok-imagine</code>, <code>nano-banana-pro</code>, <code>nano-banana-2</code>, reachable as <code>cheaperinference/<model></code>). <a href="https://cheaperinference.com/?utm_source=omniroute"><b>Get an API key →</b></a>
</td>
<sub>Links tagged <code>aff=omniroute</code> are partner links. They fund the project at no extra cost to you.</sub>
<details open> <summary><sub><b>🎟️ Affiliates Promo</b> — free signup coupons from providers we don't sponsor (click to expand)</sub></summary><sub><i>This section is for referral/coupon codes only. Sponsored partnerships live in <b>🤝 Supported by our Open Source Friends</b> above. OmniRoute has no sponsorship or partnership with the providers listed here — these are public coupons anyone can use.</i></sub>
<table> <tr> <td align="center" width="120"> <a href="https://agentrouter.org/register?aff=70LM"> </a>
<sub><b>AgentRouter</b></sub> <sub>agentrouter.org</sub> </td> <td> <sub><b><a href="https://agentrouter.org/register?aff=70LM">AgentRouter</a></b> — affiliate signup · <b>$100 free credits</b> on signup (free server, expect higher latency — best for testing, not production). First-class support in OmniRoute since <b>v3.8.50</b>: Chat Completions, the Anthropic-compatible wire format and the OpenAI-compatible path. Available models include <code>claude-opus-4-8</code>, <code>claude-opus-5</code>, <code>gpt-5.6-sol</code> and more. <b><a href="https://agentrouter.org/register?aff=70LM">Grab your $100 →</a></b></sub>
<sub>⚠️ <i>Affiliate link — OmniRoute has no sponsorship or partnership with this provider.</i></sub>
</td>
<sub>Know another provider with a generous free signup coupon that benefits OmniRoute users? Open an issue and we'll add it here.</sub>
</details> <div align="center">A combo is a chain of models OmniRoute routes across automatically. Quota runs out, a provider fails, or costs spike — the combo silently slides to the next model. This is what makes OmniRoute unbreakable. 🛡️
autoNo combo to create. Set your model to auto (or a variant) and OmniRoute builds a virtual combo from your connected providers, scored live:
All 19 strategies — mix & match per combo step:
<table> <tr> <th>#</th> <th align="left">Strategy</th> <th align="left">What it does</th> </tr> <tr> <td align="center">1</td> <td nowrap><code>priority</code></td> <td>First-target ordered list — drain each before the next 🥇</td> </tr> <tr> <td align="center">2</td> <td nowrap><code>fill-first</code></td> <td>Fill each target's quota fully before moving on</td> </tr> <tr> <td align="center">3</td> <td nowrap><code>weighted</code></td> <td>Weighted random by per-target weight</td> </tr> <tr> <td align="center">4</td> <td nowrap><code>round-robin</code></td> <td>Cycle through targets in order</td> </tr> <tr> <td align="center">5</td> <td nowrap><code>p2c</code></td> <td>Power-of-two-choices random load balancing</td> </tr> <tr> <td align="center">6</td> <td nowrap><code>least-used</code></td> <td>Pick the target with the lowest current load</td> </tr> <tr> <td align="center">7</td> <td nowrap><code>random</code></td> <td>Uniform random pick (deduplicated)</td> </tr> <tr> <td align="center">8</td> <td nowrap><code>strict-random</code></td> <td>Random without de-duplicating repeats 🎲</td> </tr> <tr> <td align="center">9</td> <td nowrap><code>cost-optimized</code></td> <td>Minimize $ per request from live catalog pricing 💸</td> </tr> <tr> <td align="center">10</td> <td nowrap><code>headroom</code></td> <td>Pick the target with the most remaining quota</td> </tr> <tr> <td align="center">11</td> <td nowrap><code>reset-window</code></td> <td>Prefer the target whose quota window resets soonest</td> </tr> <tr> <td align="center">12</td> <td nowrap><code>reset-aware</code></td> <td>Rank by quota reset time — short windows first 📊</td> </tr> <tr> <td align="center">13</td> <td nowrap><code>context-relay</code></td> <td>Hand off context across targets for long conversations 🧠</td> </tr> <tr> <td align="center">14</td> <td nowrap><code>context-optimized</code></td> <td>Pick the best fit for the current context size</td> </tr> <tr> <td align="center">15</td> <td nowrap><code>cache-optimized</code></td> <td>Pin each reusable prompt prefix to the same account — maximize prompt-cache hits 🎯</td> </tr> <tr> <td align="center">16</td> <td nowrap><code>lkgp</code></td> <td>Last-Known-Good Path — sticky to the last successful target</td> </tr> <tr> <td align="center">17</td> <td nowrap><code>auto</code></td> <td>14-factor live scoring across every connection 🤖</td> </tr> <tr> <td align="center">18</td> <td nowrap><code>fusion</code></td> <td>Fan out to a panel of models + a judge synthesizes one answer 🧬</td> </tr> <tr> <td align="center">19</td> <td nowrap><code>pipeline</code></td> <td>Chain steps — each target's output feeds the next one 🔗</td> </tr> </table><sub>The Auto-Combo engine scores every candidate on 14 factors (health, quota, cost, latency, success rate, freshness…) — see docs/routing/AUTO-COMBO.md.</sub>
<sub>📖 Auto-Combo Engine · Resilience Guide</sub>
<div align="center"><sub>📊 Full methodology & per-feature detail vs 9router, OpenRouter, CLIProxyAPI & LiteLLM → docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md</sub>
OmniRoute is MIT-licensed and maintained in the open. If it saves you time or money, here's how to keep it independent — pick whatever fits you. Sponsorship never affects routing priority; it buys visibility, not ranking.
<table> <tr><td nowrap>⭐ <b>Star the repo</b></td><td>Free — genuinely helps visibility</td><td><a href="https://github.com/diegosouzapw/OmniRoute">Star OmniRoute</a></td></tr> <tr><td nowrap>🐙 <b>GitHub Sponsors</b></td><td>One-off or monthly · zero platform fee</td><td><a href="https://github.com/sponsors/diegosouzapw">github.com/sponsors/diegosouzapw</a></td></tr> <tr><td nowrap>☕ <b>Ko-fi</b></td><td>Quick one-off tip, no signup for the donor</td><td><a href="https://ko-fi.com/diegosouzapw">ko-fi.com/diegosouzapw</a></td></tr> <tr><td nowrap>🧋 <b>Buy Me a Coffee</b></td><td>Small, informal gesture</td><td><a href="https://www.buymeacoffee.com/diegosouzapw">buymeacoffee.com/diegosouzapw</a></td></tr> <tr><td nowrap>🖐 <b>Liberapay</b></td><td>Recurring · non-profit · open source</td><td><a href="https://liberapay.com/diegosouzapw">liberapay.com/diegosouzapw</a></td></tr> <tr><td nowrap>🇧🇷 <b>PIX</b> (Brazil)</td><td>Instant, no fees</td><td>key & QR below</td></tr> <tr><td nowrap>₿ <b>Crypto</b></td><td>BTC · ETH · USDT-TRC20 · USDC-Solana</td><td>addresses below</td></tr> </table>🇧🇷 PIX — instant, no fees (Brazil)
Key (random): 5d865059-bc44-483a-962d-43ceb80126eb
Pix copia-e-cola:
00020101021126580014br.gov.bcb.pix01365d865059-bc44-483a-962d-43ceb80126eb5204000053039865802BR5922OMNIROUTE CONTRIBUICAO6006BRASIL62070503***630475DD
<sub>⚠️ Send each coin only on the network shown — sending on the wrong network can lose the funds.</sub>
</details>🐛 Found a bug or have feedback? Open a Discussion.
<div align="center">Recent highlights from v3.8.20 → v3.8.50. Full history in
CHANGELOG.md.
/v1/models ordering — one contiguous provider-grouped block per provider (combos pinned first), stable across every catalog source. → API Referencesetup-* configures 12+ coding tools; omniroute launch / launch-codex are zero-config. → CLI Integrationsconnect / contexts / tokens) + an antigravity OAuth helper for VPS installs. → Remote Modeauto/<category>:<tier> combos, Fusion (model panel + judge), task-aware routing, per-request model / mode / USD-budget overrides. → Auto-ComboX-OmniRoute-* cost/usage headers on every endpoint, cache-HIT savings header, per-key USD spend quotas. → API Referencex-omniroute-no-memory. → Memory/v1/ocr (Mistral OCR) and /v1/audio/translations (Whisper-style) round out the media surface. → API ReferencebasePath, browser-language auto-detect, per-key device tracking, root-less MITM trust, zh-TW localization. → EnvironmentX-OmniRoute-Decision header naming the strategy/provider/latency that served it, a new cache-optimized combo strategy + Auto-Combo cacheAffinity factor route repeat requests back to the connection holding the cached prefix, and a read-only /v1/auto-combo/{channel}/candidates endpoint exposes an auto/* channel's live candidate pool. → Auto-Combo<div align="center"> <table> <tr> <td align="center" width="76"><a href="https://github.com/anthropics/claude-code"> <sub><b>Claude Code</b></sub> <sub> </sub></a></td> <td align="center" width="76"><a href="https://github.com/openai/codex"> <sub><b>Codex CLI</b></sub> <sub> </sub></a></td> <td align="center" width="76"><picture><source media="(prefers-color-scheme:dark)" srcset="https://cdn.jsdelivr.net/npm/@lobehub/[email protected]/dark/cline.png"/></picture> <sub><b>Cline</b></sub> <sub> </sub></td> <td align="center" width="76"><a href="https://github.com/Kilo-Org/kilocode"> <sub><b>Kilo Code</b></sub> <sub> </sub></a></td> <td align="center" width="76"><a href="https://github.com/Zoo-Code-Org/Zoo-Code"> <sub><b>Zoo Code</b></sub> <sub> </sub></a></td> <td align="center" width="76"> <sub><b>Continue</b></sub> <sub> </sub></td> </tr> <tr> <td align="center" width="76"> <sub><b>Aider</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>ForgeCode</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>jcode</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>DeepSeek TUI</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>CodeWhale</b></sub> <sub> </sub></td> <td align="center" width="76"><a href="https://github.com/anomalyco/opencode"><picture><source media="(prefers-color-scheme:dark)" srcset="https://cdn.jsdelivr.net/npm/@lobehub/[email protected]/dark/opencode.png"/></picture> <sub><b>OpenCode</b></sub> <sub> </sub></a></td> </tr> <tr> <td align="center" width="76"> <sub><b>Factory Droid</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Copilot CLI</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Cursor CLI</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Smelt</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Pi</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Grok Build</b></sub> <sub> </sub></td> </tr> <tr> <td align="center" width="76"><picture><source media="(prefers-color-scheme:dark)" srcset="https://cdn.jsdelivr.net/npm/@lobehub/[email protected]/dark/nousresearch.png"/></picture> <sub><b>Hermes Agent</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>OpenClaw</b></sub> <sub> </sub></td> <td align="center" width="76"><picture><source media="(prefers-color-scheme:dark)" srcset="https://cdn.jsdelivr.net/npm/@lobehub/[email protected]/dark/goose.png"/></picture> <sub><b>Goose</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Open Interpreter</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Warp AI</b></sub> <sub> </sub></td> <td align="center" width="76"> <sub><b>Agent Deck</b></sub> <sub> </sub></td> </tr> </table> </div> <div align="center"> <b>+ also works with</b> · Kiro · Command Code · Antigravity · Windsurf · AMP · <b>any OpenAI-compatible tool</b> </div>One config —
http://localhost:20128/v1— and every AI IDE or CLI runs on free & low-cost models.
<sub>📖 Per-tool setup for all 33 tools (25 CLI Code's + 8 CLI Agents) → docs/reference/CLI-TOOLS.md · 🧩 OpenCode plugin → @omniroute/opencode-provider</sub>
<div align="center">The most complete catalog of any open-source router: 339 providers, 90+ with a free tier, 40+ free forever.
<sub>…and 220+ more — every icon resolves live from the dashboard's provider catalog. 📖 Provider Reference</sub>
📖 Full machine-readable catalog → docs/reference/PROVIDER_REFERENCE.md
<table> <tr><th align="left">Platform</th><th align="left">Install</th><th align="left">Highlights</th></tr> <tr><td align="left" nowrap>📦 <b>npm (global)</b></td><td align="left" nowrap><code>npm install -g omniroute</code></td><td align="left">One command, any OS</td></tr> <tr><td align="left" nowrap>🐳 <b>Docker</b></td><td align="left" nowrap><code>docker run … diegosouzapw/omniroute</code></td><td align="left">Multi-arch <b>AMD64 + ARM64</b></td></tr> <tr><td align="left" nowrap>🖥️ <b>Desktop (Electron)</b></td><td align="left" nowrap><code>npm run electron:build</code></td><td align="left">Native window + system tray — <b>Windows / macOS / Linux</b></td></tr> <tr><td align="left" nowrap>💪 <b>ARM</b></td><td align="left" nowrap>native <code>arm64</code></td><td align="left">Raspberry Pi, ARM servers, Apple Silicon</td></tr> <tr><td align="left" nowrap>📱 <b>Android (Termux)</b></td><td align="left" nowrap><code>pkg install nodejs && npx -y omniroute</code></td><td align="left">Runs <b>on your phone</b>, 24/7, no root</td></tr> <tr><td align="left" nowrap>📲 <b>PWA</b></td><td align="left" nowrap>"Add to Home Screen"</td><td align="left">Fullscreen, offline, installable from browser</td></tr> <tr><td align="left" nowrap>🧩 <b>OpenCode plugin</b></td><td align="left" nowrap><code>@omniroute/opencode-provider</code></td><td align="left">Native OpenCode integration</td></tr> <tr><td align="left" nowrap>🛠️ <b>From source</b></td><td align="left" nowrap><code>npm install && npm run dev</code></td><td align="left">Hack on it, contribute</td></tr> </table>Same app, your machine, your rules. From a global npm install to your phone via Termux.
<sub>📖 Docker Guide · Desktop · Termux · PWA · OpenCode</sub>
<div align="center"><sub>📖 Authorization · Guardrails · Compliance</sub>
<div align="center">Beyond the server, OmniRoute is a full command-line cockpit with 80+ commands, plus open agent protocols so an AI agent can drive it on its own.
start)omniroute # serve gateway + dashboard (port 20128)
omniroute chat # interactive TUI chat client (slash: /model /combo /skill /memory)
omniroute setup # guided first-run wizard
omniroute doctor # diagnose providers, ports, native deps
OmniRoute on a server? Drive it from your laptop with the same CLI. Log in once with a scoped access token; every command then targets the remote.
omniroute connect 192.168.0.15 # password → scoped token, saved as a context
omniroute models list # ← runs against the REMOTE server
omniroute configure codex # ← picks a remote model, writes a local Codex profile
omniroute tokens create --name ci --scope read # mint narrower tokens for other machines
omniroute contexts use default # ← switch back to the local server
Tokens are scoped read / write / admin; process-spawning routes stay loopback-only.
<sub>📖 Remote Mode</sub>
Expose OmniRoute over MCP, A2A, a REST API, webhooks or a remote CLI — any capable agent (or your own code) gets the keys to the whole gateway: routing, providers, combos, cache, compression, memory — autonomously. HTTP endpoints below are served under http://localhost:20128.
# Give Claude Code the full OmniRoute toolset over MCP:
claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp/stream
<sub>📖 MCP Server · A2A Server · Agent Protocols</sub>
<div align="center">Default stacked combo runs RTK → Caveman. When both act on the same tool/context payload, savings compound:
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
Code blocks, URLs, JSON and structured data are always protected by the preservation engine.
Why use many tokens when few tokens do the trick? Every request passes through OmniRoute's compression pipeline transparently — no client changes. It's now a stack of 12 composable engines that run in order and mix & match per routing combo — building on ideas from RTK, Caveman (⭐ 90K+), LLMLingua-2, and Troglodita (PT-BR).
Engines run in pipeline order; each is independently toggleable and configurable per combo:
<table> <tr><th align="center">#</th><th align="left">Engine</th><th align="left">What it does</th></tr> <tr><td align="center" nowrap>1</td><td align="left" nowrap><b>Session-Dedup</b></td><td align="left">Drops content repeated across turns (content-addressed, cross-turn)</td></tr> <tr><td align="center" nowrap>2</td><td align="left" nowrap><b>CCR</b></td><td align="left">Archives large blocks behind retrieve markers, fetched on demand</td></tr> <tr><td align="center" nowrap>3</td><td align="left" nowrap><b>Lite</b></td><td align="left">Whitespace + image-URL trimming (latency-light baseline)</td></tr> <tr><td align="center" nowrap>4</td><td align="left" nowrap><b>RTK</b></td><td align="left">Smart tool-result filtering, dedup & truncation (command-aware)</td></tr> <tr><td align="center" nowrap>5</td><td align="left" nowrap><b>Responses Tool Output</b></td><td align="left">Lossless-first JSON + bounded diagnostic compression for shell/patch/search/build outputs (Responses API)</td></tr> <tr><td align="center" nowrap>6</td><td align="left" nowrap><b>Headroom</b></td><td align="left">Lossless tabular compaction of JSON arrays (~30%) via a vendored <b>GCF</b> codec</td></tr> <tr><td align="center" nowrap>7</td><td align="left" nowrap><b>Relevance</b></td><td align="left">Extractive sentence scoring against the last user query</td></tr> <tr><td align="center" nowrap>8</td><td align="left" nowrap><b>Caveman</b></td><td align="left">Rule-based prose compression (~65–75% on output)</td></tr> <tr><td align="center" nowrap>9</td><td align="left" nowrap><b>Aggressive</b></td><td align="left">Summarization + progressive aging of old turns</td></tr> <tr><td align="center" nowrap>10</td><td align="left" nowrap><b>LLMLingua-2</b></td><td align="left">ML semantic pruning via MobileBERT ONNX — code-safe, async</td></tr> <tr><td align="center" nowrap>11</td><td align="left" nowrap><b>Ultra</b></td><td align="left">Heuristic token pruning with an optional small-model (SLM) tier</td></tr> <tr><td align="center" nowrap>12</td><td align="left" nowrap><b>OmniGlyph</b></td><td align="left">Experimental context-as-image encoding routed to Claude Fable 5 (most aggressive; opt-in)</td></tr> </table>Code blocks, URLs and structured data are always preserved byte-perfect. One-click presets combine the engines:
<table> <tr><th align="left">Mode</th><th align="left">Savings</th><th align="left">Best for</th></tr> <tr><td align="left" nowrap>🪶 <b>Lite</b></td><td align="left" nowrap>~15%</td><td align="left">Always-on safe default</td></tr> <tr><td align="left" nowrap>🪨 <b>Standard (Caveman)</b></td><td align="left" nowrap>~30%</td><td align="left">Daily coding</td></tr> <tr><td align="left" nowrap>⚡ <b>Aggressive</b></td><td align="left" nowrap>~50%</td><td align="left">Long tool-heavy sessions</td></tr> <tr><td align="left" nowrap>🔥 <b>Ultra</b></td><td align="left" nowrap>~75%</td><td align="left">Maximum savings</td></tr> <tr><td align="left" nowrap>🧰 <b>RTK</b></td><td align="left" nowrap>60–90%</td><td align="left">Shell/test/build/git output</td></tr> <tr><td align="left" nowrap>🔗 <b>Stacked (RTK → Caveman)</b></td><td align="left" nowrap><b>78–95%</b></td><td align="left">Mixed prompts + tool logs</td></tr> </table>Real example — Standard mode:
Before (69 tokens): "The reason your React component is re-rendering is likely because you're creating a new object reference on each render cycle. When you pass an inline object as a prop, React's shallow comparison sees it as a different object every time, which triggers a re-render. I would recommend using useMemo to memoize the object."
After (19 tokens): "New object ref each render. Inline object prop = new ref = re-render. Wrap in useMemo."
Same answer. 72% fewer tokens. Zero accuracy loss. ✅
PT-BR example — Troglodita mode:
Antes (42 tokens): "O problema é que o componente está re-renderizando porque uma nova referência de objeto está sendo criada em cada ciclo de renderização. Eu recomendaria usar useMemo."
Depois (12 tokens): "Re-render: ref nova cada ciclo (objeto inline recriado). Usar
useMemo."Mesma resposta. ~70% menos tokens. Precisão técnica intacta. ✅
The 12 engines above shrink what goes in. Three more layers shape how, when, and what comes out:
lite / full / ultra intensity. Adding a style is a one-line registry entry:
zh).reserve-output (default, model-aware) · percentage · absolute. Mode: floor (guarantee fit) · replace-autotrigger (your explicit choice wins) · off (legacy threshold).x-omniroute-compression header › routing-combo override › active named profile › adaptive / auto-trigger › panel default › off. The applied plan echoes back in the X-OmniRoute-Compression: <mode>; source=<source> response header.Auto-trigger by token threshold, flip on the adaptive dial, pin a named profile, set a one-off per request, or assign a pipeline per routing combo — whichever fits the workload. An opt-in offline eval harness (npm run eval:compression) scores fidelity vs. savings on a pinned corpus before you promote a change.
📖 COMPRESSION_GUIDE.md · RTK_COMPRESSION.md · COMPRESSION_ENGINES.md
1) Install & run
npm install -g omniroute
omniroute
💡 See
npm warn ERESOLVEor peer-dep warnings? They're harmless.
Dashboard at http://localhost:20128 · API at http://localhost:20128/v1.
2) Connect a FREE provider (no signup)
Dashboard → Providers → connect Kiro AI (free Claude, ~50 credits/month per account) or OpenCode Free (no auth) → done.
3) Point your coding tool
Base URL: http://localhost:20128/v1
API Key: [copy from Dashboard → Endpoints]
Model: auto (zero-config smart routing — or any provider/model)
4) Verify it's working
curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"
You should see your connected models listed. 🎉 That's it — start coding, and OmniRoute auto-routes & falls back for you.
If your client cannot send custom headers, OmniRoute also exposes tokenized compatibility aliases:
OpenAI catalog: http://localhost:20128/vscode/YOUR_KEY/
OpenAI models: http://localhost:20128/vscode/YOUR_KEY/models
OpenAI chat: http://localhost:20128/vscode/YOUR_KEY/chat/completions
OpenAI responses: http://localhost:20128/vscode/YOUR_KEY/responses
Ollama chat: http://localhost:20128/vscode/YOUR_KEY/api/chat
Ollama tags: http://localhost:20128/vscode/YOUR_KEY/api/tags
Use these only for clients that cannot attach Authorization: Bearer .... Header auth remains the preferred mode.
🐳 Docker
docker run -d --name omniroute --restart unless-stopped --stop-timeout 40 \
-p 127.0.0.1:20128:20128 -v omniroute-data:/app/data diegosouzapw/omniroute:latest
Pre-release Docker channel:
diegosouzapw/omniroute:nextanddiegosouzapw/omniroute:next-webfollow the current defaultrelease/v*branch. These mutable tags are intended only for testing unreleased fixes and are not supported for production. See Docker Release Channels.
🛠️ From source
cp .env.example .env && npm install
PORT=20128 npm run dev
📦 pnpm
pnpm add -g omniroute@latest --allow-build=better-sqlite3 --allow-build=@swc/core && omniroute
🐧 Arch Linux (AUR)
yay -S omniroute-bin && systemctl --user enable --now omniroute.service
🔧 Nix (Flake)
# Using Nix flakes
nix develop
npm run dev
# Or using devbox
devbox run npm run dev
📖 Docker Guide — Compose profiles, Caddy HTTPS, Cloudflare tunnels.
🦭 Podman
# 1. Prepare the bind-mounted data directory
mkdir -p data
# 2. Linux + local rootless Podman only (never a remote Podman Machine client):
podman unshare chown 1000:1000 ./data
# 3. Set the runtime hint, build the local Compose image, and start
echo "CONTAINER_HOST=podman" >> .env
podman compose --profile base up -d --build
On macOS or Windows, Podman uses a remote Podman Machine: skip podman unshare and
follow the topology-specific data directory guidance.
📖 Podman Guide — Compose builds, Podman Machine, and Linux/systemd Quadlet setup.
⚡ Faster / leaner install (skip the native build)
The native SQLite engine (better-sqlite3) is an optional dependency, so a global
install never blocks on compiling from source: it uses a prebuilt binary when one matches
your platform/Node, and otherwise falls back transparently to a pure-JS engine
(node:sqlite on Node 22+, else the bundled sql.js WASM) — no build tools required.
To skip the post-install native warm-up entirely (CI, headless, or slow machines):
OMNIROUTE_SKIP_POSTINSTALL=1 npm install -g omniroute # CI=1 also skips it
For the fastest installs prefer pnpm (content-addressed store + hard links — see above).
For a dashboard-free, headless runtime use the Docker base profile (above) or the
Termux guide. The CLI and the web dashboard are served by the
same process on one port, so there is no separate CLI-only package today.
<b>🇧🇷 Português</b>
<sub>Guia completo</sub> </td> <td align="center" width="264"> <a href="https://www.youtube.com/watch?v=CMzyOiUyEVc"></a>
<b>🇺🇸 English</b>
<sub>Complete walkthrough</sub> </td> <td align="center" width="264"> <a href="https://www.youtube.com/watch?v=il_5Ii6v4-Y"></a>
<b>🇷🇺 Русский</b>
<sub>Полное руководство</sub> </td>
</tr> </table> </div> <div align="center"></div> <div align="center">🎬 Made a video about OmniRoute? Open an issue or discussion with the link — we'll feature it here.
Everything in one place — follow the maintainer, chat with the community, or open an issue.
| Channel | Where / how |
|---|---|
| 💼 LinkedIn — follow the maintainer | linkedin.com/in/diegosouzapw |
| 🐙 GitHub — follow for releases & tips | @diegosouzapw |
| 💬 Discord | discord.gg/U47eFqAXCn |
| ✈️ Telegram | t.me/omnirouteOficial |
| 🟢 WhatsApp — 🌍 Global | join the group |
| 🟢 WhatsApp — 🇧🇷 Brasil | entrar no grupo |
| 🌍 Website | omniroute.online |
| 📦 Source code | github.com/diegosouzapw/OmniRoute |
| 🐛 Report a bug | open an issue — attach npm run system-info output |
| 🤝 Contribute | CONTRIBUTING.md · Branching & Release Model · pick a good first issue |
| 💚 Support the project | Ways to support ↑ · GitHub Sponsors |
<table> <tr> <td align="center" width="160"> <a href="https://github.com/oyi77">OmniRoute is shaped by a passionate open-source community. These individuals have made exceptional contributions that directly impact the quality, stability, and reach of the project. Thank you.
<b>oyi77</b>
</a>
<sub>🥇 213 commits • +114K lines</sub>
<sub>Analytics engine, SQL aggregations,
proxy marketplace, test coverage</sub> </td> <td align="center" width="160"> <a href="https://github.com/rdself">
<b>R.D. & Randi</b>
</a>
<sub>🥈 108 commits • +38K lines</sub>
<sub>Endpoints page, tunnel integrations,
Docker workflows, A2A status, compression UI</sub> </td> <td align="center" width="160"> <a href="https://github.com/christopher-s">
<b>Chris Staley</b>
</a>
<sub>🥉 70 commits • +1.8K lines</sub>
<sub>SSE stream hardening, Responses API,
Gemini pagination, test regression fixes</sub> </td> <td align="center" width="160"> <a href="https://github.com/zen0bit">
<b>zenobit</b>
</a>
<sub>🏅 62 commits • +22K lines</sub>
<sub>CI/CD pipeline, i18n for 33 languages,
Void Linux package, platform fixes</sub> </td> <td align="center" width="160"> <a href="https://github.com/JxnLexn">
<b>Jan Leon</b>
</a>
<sub>🏅 58 commits • +22K lines</sub>
<sub>Reasoning-effort routing, proxy controls,
quota visibility, Live Zone compression</sub> </td>
</tr> <tr> <td align="center" width="160"> <a href="https://github.com/backryun"> <b>backryun</b>
</a>
<sub>🏅 53 commits • +70K lines</sub>
<sub>Provider catalog curation — Perplexity, Kimi,
Cerebras, Copilot, LMArena refreshes</sub> </td> <td align="center" width="160"> <a href="https://github.com/chirag127">
<b>Chirag Singhal</b>
</a>
<sub>🏅 46 commits • +4.8K lines</sub>
<sub>Error sanitization, MITM prefill fix,
fusion judge, breaker/429 correctness</sub> </td> <td align="center" width="160"> <a href="https://github.com/kfiramar">
<b>kfiramar</b>
</a>
<sub>🏅 38 commits • +1.7K lines</sub>
<sub>Codex websocket + passthrough, auth/onboarding,
Electron hardening, DB migrations</sub> </td> <td align="center" width="160"> <a href="https://github.com/benzntech">
<b>Benson K B</b>
</a>
<sub>🏅 28 commits • +9.2K lines</sub>
<sub>Electron desktop app, auto-updater,
release build workflows, cross-platform CI</sub> </td> <td align="center" width="160"> <a href="https://github.com/herjarsa">
<b>Hernan J. Ardila</b>
</a>
<sub>🏅 25 commits • +174K lines</sub>
<sub>Zero-latency combos, vision-bridge auto-routing,
catalog context-length, resilience 429 hints</sub> </td>
</tr> </table></div>🙏 These contributors' features, bug fixes, and infrastructure improvements are a core part of what makes OmniRoute reliable and feature-rich. Every pull request, every test case, and every i18n translation file matters. Open source is built by people like them.
A heartfelt thank-you to the people who fund OmniRoute out of their own pocket — every contribution keeps the project free, independent and moving.
<table> <tr> <td align="center" width="180"> <a href="https://github.com/igormorais123"> <b>Prof. Igor Morais</b>
</a>
<sub>💛 Sponsor</sub>
</td>
<td align="center" width="180">
<a href="https://github.com/longtao77">
<b>longtao</b>
</a>
<sub>💛 Sponsor</sub>
</td>
<sub>… and others who prefer to stay private 💛</sub>
<b><a href="https://github.com/sponsors/diegosouzapw">💖 Become a sponsor →</a></b> — every dollar keeps OmniRoute free and independent.
</div> <div align="center">release/vX.Y.Z tip (not main) — see Branching & Release Modelgit checkout -b feat/amazing-feature)git commit -m 'feat: add amazing feature')git push origin feat/amazing-feature)release/vX.Y.Z branchSee CONTRIBUTING.md for detailed guidelines.
# Create a release — npm publish happens automatically
gh release create v3.8.2 --title "v3.8.2" --generate-notes
OmniRoute stands on the shoulders of giants. It started as a fork of 9router and a TypeScript port of the Go project CLIProxyAPI — and from there, every subsystem below was inspired by an open-source project that got there first. Each one shaped a concrete piece of OmniRoute. This is our thank-you to all of them. 🙏
⭐ star counts as of July 2026 — go give these projects a star.
MIT License - see LICENSE for details.
⬆ Back to top · Built with ❤️ for the open-source AI community.
<sub>OmniRoute v3.8.49 · Node ≥22.22.2 · MIT License · <a href="https://omniroute.online">omniroute.online</a></sub>
</div> <!-- GitHub Discussions enabled for community Q&A -->