Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

alanzou/OmniRoute

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

3,320 Commits

Repository files navigation

OmniRoute Dashboard

๐Ÿš€ OmniRoute โ€” The Free AI Gateway

Never stop coding. Connect every AI tool to 177 providers โ€” 50+ free โ€” through one endpoint.

Plug Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude / GPT / Gemini. Auto-fallback.

RTK + Caveman compression saves 15โ€“95% tokens. Never hit limits.


177 AI Providers 50+ Free Token Savings 14 Strategies 0ใƒ‰ใƒซ to start

diegosouzapw%2FOmniRoute | Trendshift

npm License: MIT Node Stars


๐Ÿš€ Quick Start โ€ข ๐ŸŽฏ Combos โ€ข ๐ŸŒ Providers โ€ข ๐Ÿ”Œ CLI & MCP โ€ข ๐Ÿ—œ๏ธ Compression โ€ข ๐ŸŒ Website โ€ข ๐Ÿ’ฌ WhatsApp ๐ŸŒ โ€ข ๐Ÿ’ฌ WhatsApp ๐Ÿ‡ง๐Ÿ‡ท

๐Ÿ’ฅ The Promise โ€ข ๐Ÿค” Why โ€ข ๐Ÿ† What Sets Apart โ€ข ๐Ÿค– Compatible CLIs โ€ข ๐Ÿ–ฅ๏ธ Where It Runs โ€ข ๐Ÿ”’ Private โ€ข ๐ŸŽฌ In Action โ€ข ๐Ÿ“š Explore More โ€ข ๐Ÿ“ง Support


๐Ÿ’ฅ The Promise

One endpoint. 177 providers. Never stop building โ€” and let OmniRoute pick the cheapest one that works.

๐Ÿšซ Never hit limits
Auto-fallback across 177 providers in milliseconds. Quota out? Next provider takes over โ€” zero downtime. ๐Ÿ’ธ Save up to 95% tokens
RTK + Caveman stacked compression cuts 15โ€“95% of eligible tokens (~89% avg on tool-heavy sessions). ๐Ÿ†“ 0ใƒ‰ใƒซ to start
50+ providers with a free tier, 11 free forever (Kiro, Qoder, Pollinations, LongCat...). No card needed.
๐Ÿ”Œ Every tool works
16+ coding agents โ€” Claude Code, Codex, Cursor, Cline, Copilot, Antigravity โ€” through one config. ๐Ÿงฉ One endpoint
OpenAI โ†” Claude โ†” Gemini โ†” Responses API translation. Point any tool at /v1 and it just works. ๐Ÿ›ก๏ธ Production-grade
Circuit breakers, TLS stealth, MCP (37 tools), A2A, memory, guardrails, evals. 4,690+ tests.


๐Ÿค” Why OmniRoute?

Stop juggling 10 dashboards, dead API keys, and surprise bills.

โŒ The daily pain โœ… How OmniRoute fixes it
๐Ÿ“‰ Subscription quota expires unused every month Maximize subscriptions โ€” track quota, use every token before reset
๐Ÿ›‘ Rate limits stop you mid-coding 4-tier auto-fallback โ€” Subscription โ†’ API โ†’ Cheap โ†’ Free, in milliseconds
๐Ÿ”ฅ Tool outputs (git diff, grep, logs) burn tokens RTK + Caveman compression โ€” save 15โ€“95% eligible tokens per request
๐Ÿ’ธ Expensive APIs (20ใƒ‰ใƒซโ€“50/mo per provider) Cost-optimized routing โ€” auto-route to the cheapest viable model
๐Ÿงฐ Each AI tool wants its own setup One endpoint, every tool, one dashboard
๐ŸŒ AI blocked in your country 3-level proxy + TLS fingerprint stealth โ€” use AI from anywhere
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Your IDE / CLI (Claude Code, Cursor, Cline...) โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
 โ”‚ http://localhost:20128/v1
 โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ OmniRoute โ€” Smart Router โ”‚
โ”‚ RTK + Caveman compression ยท 14 routing strategies โ”‚
โ”‚ Circuit breakers ยท TLS stealth ยท MCP ยท A2A ยท Guardrails โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
 โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
 โ–ผ Tier 1 โ–ผ Tier 2 โ–ผ Tier 3 โ–ผ Tier 4
 SUBSCRIPTION API KEY CHEAP FREE
 Claude Code, DeepSeek, GLM 0ใƒ‰ใƒซ.5, Kiro, Qoder,
 Codex, Copilot Groq, xAI MiniMax 0ใƒ‰ใƒซ.2 Pollinations
 quota out? โ”€โ”€โ”€โ–ถ budget hit? โ”€โ–ถ budget hit? โ”€โ–ถ always on

๐ŸŽฏ Combos โ€” The Flagship

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. ๐Ÿ›ก๏ธ

โšก Zero-config โ€” just use auto

No combo to create. Set your model to auto (or a variant) and OmniRoute builds a virtual combo from your connected providers, scored live:

Model ID What it optimizes for
auto ๐ŸŽฏ Balanced default (LKGP โ€” sticks to your last good provider)
auto/coding ๐Ÿง‘โ€๐Ÿ’ป Quality-first weights for code generation
auto/fast โšก Lowest latency first
auto/cheap ๐Ÿ’ฐ Cheapest per token first
auto/offline ๐Ÿ”‹ Most quota / rate-limit headroom first
auto/smart ๐Ÿ”ญ Quality-first + 10% exploration to discover better models

๐Ÿ”€ Or build your own โ€” 14 routing strategies

Goal Strategy / combo
๐Ÿฅ‡ Drain my subscription before paying priority / fill-first
โš–๏ธ Spread load across accounts round-robin ยท weighted ยท p2c ยท least-used
๐Ÿ’ธ Always cheapest viable model cost-optimized ยท auto/cheap
๐Ÿง  Hand off long context between models context-relay ยท context-optimized
๐ŸŽฒ Randomized / privacy routing random ยท strict-random
๐Ÿค– Just make it smart auto (9-factor scoring) ยท lkgp ยท reset-aware

The Auto-Combo engine scores every candidate on 9 factors (health, quota, cost, latency, success rate, freshness...) โ€” see docs/routing/AUTO-COMBO.md.

๐Ÿงฑ Resilience is built in (3 independent layers)

Layer Scope What it does
๐Ÿ”Œ Circuit breaker whole provider Stops hammering a provider that's failing upstream; auto-probes to recover
๐Ÿ’ค Connection cooldown one account / key Skips a rate-limited key while other keys keep serving
๐ŸŽฏ Model lockout provider + model Quarantines just one quota-limited model, not the whole connection
Combo: "always-on" Strategy: priority
 1. cc/claude-opus-4-7 โ† subscription (use it fully)
 2. cx/gpt-5.5 โ† second subscription
 3. glm/glm-5.1 โ† cheap backup (0ใƒ‰ใƒซ.5/1M)
 4. kr/claude-sonnet-4.5 โ† FREE, unlimited (never fails)
Result: 4 layers of fallback = zero downtime

๐Ÿ“– Auto-Combo Engine ยท Resilience Guide


๐Ÿ† What Sets OmniRoute Apart

Feature OmniRoute Other routers
๐ŸŒ Providers 177 20โ€“100
๐Ÿ†“ Free providers 50+ (11 free forever) 1โ€“5
๐Ÿ”€ Routing strategies 14 (priority, weighted, cost-optimized, context-relay...) 1โ€“3
๐Ÿ—œ๏ธ Token compression RTK + Caveman stacked (15โ€“95%) None / 20โ€“40%
๐Ÿงฐ Built-in MCP server 37 tools, 3 transports, 13 scopes Rare
๐Ÿค A2A agent protocol 5 skills, JSON-RPC 2.0 None
๐Ÿง  Memory (FTS5 + vector) Yes Rare
๐Ÿ›ก๏ธ Guardrails (PII, injection, vision) Yes Rare
โ˜๏ธ Cloud agents Codex, Devin, Jules None
๐Ÿฅท TLS fingerprint stealth JA3/JA4 via wreq-js None
๐Ÿ–ฅ๏ธ Multi-platform Web ยท Desktop ยท Termux ยท PWA Web only
๐ŸŒ i18n 40+ locales 0โ€“4

๐Ÿ“Š Detailed comparison vs LiteLLM, OpenRouter & Portkey โ†’ docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md


๐Ÿค– Compatible CLIs & Coding Agents

One config โ€” http://localhost:20128/v1 โ€” and every AI IDE or CLI runs on free & low-cost models.

+ also works with ยท Cline ยท Antigravity ยท Windsurf ยท AMP ยท Hermes ยท Qwen CLI ยท Roo ยท Continue ยท any OpenAI-compatible tool

๐Ÿ“– Per-tool setup for all 16+ tools โ†’ docs/reference/CLI-TOOLS.md ยท ๐Ÿงฉ OpenCode plugin โ†’ @omniroute/opencode-provider


๐ŸŒ 177 AI Providers โ€” 50+ Free

The most complete catalog of any open-source router: 177 providers, 50+ with a free tier, 11 free forever.

๐Ÿ†“ Free Forever โ€” 0,ใƒ‰ใƒซ no card

AgentRouter
GPT-5, Claude, Gemini
100ใƒ‰ใƒซ free credits
Qoder AI
Kimi-K2, DeepSeek-R1
Unlimited FREE
Pollinations
GPT-5, Claude, Llama 4
No key needed
LongCat
Flash-Lite
50M tokens/day ๐Ÿ”ฅ
Cloudflare AI
50+ models
10K neurons/day
Gemini CLI
gemini-3-flash
180K/mo free
NVIDIA NIM
129 models
~40 RPM free
Cerebras
Qwen3 235B
1M tokens/day

๐Ÿ“– Full machine-readable catalog โ†’ docs/reference/PROVIDER_REFERENCE.md


๐Ÿ–ฅ๏ธ Where OmniRoute Runs โ€” Anywhere

Same app, your machine, your rules. From a global npm install to your phone via Termux.

Platform Install Highlights
๐Ÿ“ฆ npm (global) npm install -g omniroute One command, any OS
๐Ÿณ Docker docker run ... diegosouzapw/omniroute Multi-arch AMD64 + ARM64
๐Ÿ–ฅ๏ธ Desktop (Electron) npm run electron:build Native window + system tray โ€” Windows / macOS / Linux
๐Ÿ’ช ARM native arm64 Raspberry Pi, ARM servers, Apple Silicon
๐Ÿ“ฑ Android (Termux) pkg install nodejs-lts && npx -y omniroute Runs on your phone, 24/7, no root
๐Ÿ“ฒ PWA "Add to Home Screen" Fullscreen, offline, installable from browser
๐Ÿงฉ OpenCode plugin @omniroute/opencode-provider Native OpenCode integration
๐Ÿ› ๏ธ From source npm install && npm run dev Hack on it, contribute

๐Ÿ“– Docker Guide ยท Desktop ยท Termux ยท PWA ยท OpenCode


๐Ÿ”’ Private & Local-First

Your keys, your machine, your data. OmniRoute is a local proxy โ€” it never phones home.

  • ๐Ÿ  Runs 100% on your hardware โ€” npm, Docker, desktop, or your phone. No OmniRoute cloud sits in the request path.
  • ๐Ÿ” Credentials encrypted at rest โ€” API keys & OAuth tokens sealed with AES-256-GCM.
  • ๐Ÿšซ Zero telemetry by default โ€” your prompts go only to the providers you choose, nowhere else.
  • ๐Ÿ›ก๏ธ Hardened gateway โ€” API-key scoping, IP filtering, rate limits, prompt-injection guard, loopback-only process routes.
  • ๐Ÿ“œ MIT licensed & fully open-source โ€” audit every line, self-host forever.

๐Ÿ“– Authorization ยท Guardrails ยท Compliance


๐Ÿ”Œ Full CLI + A2A & MCP

OmniRoute isn't just a server โ€” it's a full command-line cockpit with 60+ commands, plus open agent protocols so an AI agent can drive OmniRoute by itself.

โŒจ๏ธ A real CLI (not just 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

providers ยท oauth ยท keys ยท combo ยท nodes ยท models ยท cache ยท compression ยท cost ยท usage ยท quota ยท health ยท resilience ยท telemetry ยท logs ยท audit ยท mcp ยท a2a ยท cloud ยท memory ยท skills ยท eval ยท tunnel ยท backup ยท sync ยท webhooks ยท policy ยท pricing ยท translator ยท simulate ...

๐Ÿค Connect an agent โ€” and it controls OmniRoute itself

Expose OmniRoute over MCP or A2A and any capable agent gets the keys to the whole gateway โ€” routing, providers, combos, cache, compression, memory โ€” autonomously.

Protocol Endpoint Use it for
๐Ÿงฐ MCP (stdio) omniroute --mcp Plug into Claude Desktop, Cursor, any MCP client
๐ŸŒŠ MCP (HTTP) http://localhost:20128/api/mcp/stream Remote MCP โ€” 37 tools, 13 scopes, full audit trail
๐Ÿ“ก MCP (SSE) http://localhost:20128/api/mcp/sse Streaming MCP transport
๐Ÿค A2A http://localhost:20128/.well-known/agent.json Agent-to-agent, JSON-RPC 2.0 + SSE, 5 skills
# Give Claude Code the full OmniRoute toolset over MCP:
claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp/stream

๐Ÿ“– MCP Server ยท A2A Server ยท Agent Protocols


๐Ÿ—œ๏ธ Save 15โ€“95% Tokens โ€” Automatically

Why use many token when few token do trick? Every request passes through OmniRoute's compression pipeline transparently โ€” no client changes. It stacks ideas from RTK and Caveman (โญ 51K+).

Mode Savings Best for
๐Ÿชถ Lite ~15% Always-on safe default
๐Ÿชจ Standard (Caveman) ~30% Daily coding
โšก Aggressive ~50% Long tool-heavy sessions
๐Ÿ”ฅ Ultra ~75% Maximum savings
๐Ÿงฐ RTK 60โ€“90% Shell/test/build/git output
๐Ÿ”— Stacked (RTK โ†’ Caveman) 78โ€“95% Mixed prompts + tool logs

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. โœ…


๐Ÿ“– How it works โ€” pipeline, architecture & savings math

Client (10,000 tok) โ”€โ”€โ–ถ OmniRoute Compression (7 options) โ”€โ”€โ–ถ Provider (~1,080 tok, up to 95% saved)

Default stacked combo runs RTK โ†’ Caveman. When both act on the same tool/context payload, savings compound:

ร—ใฐใค (1 โˆ’ Caveman_input) average = 1 โˆ’ (1 โˆ’ 0.80) ร—ใฐใค (1 โˆ’ 0.46) = 89.2% range = 78.4 โ€“ 94.6%">
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. Auto-trigger compression by token threshold, or assign a compression pipeline per routing combo.

๐Ÿ“– COMPRESSION_GUIDE.md ยท RTK_COMPRESSION.md ยท COMPRESSION_ENGINES.md


โšก Quick Start

1) Install & run

npm install -g omniroute
omniroute

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 unlimited) 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.


๐Ÿ“ฆ More install methods โ€” Docker, source, pnpm, Arch

๐Ÿณ Docker

docker run -d --name omniroute --restart unless-stopped --stop-timeout 40 \
 -p 20128:20128 -v omniroute-data:/app/data diegosouzapw/omniroute:latest

๐Ÿ› ๏ธ From source

cp .env.example .env && npm install
PORT=20128 npm run dev

๐Ÿ“ฆ pnpm

pnpm install -g omniroute && pnpm approve-builds -g && omniroute

๐Ÿง Arch Linux (AUR)

yay -S omniroute-bin && systemctl --user enable --now omniroute.service

๐Ÿ“– Docker Guide โ€” Compose profiles, Caddy HTTPS, Cloudflare tunnels.


๐ŸŽฌ OmniRoute in Action

Guia em Portuguรชs
๐Ÿ‡ง๐Ÿ‡ท Portuguรชs
Guia completo English Guide
๐Ÿ‡บ๐Ÿ‡ธ English
Complete walkthrough ะ ัƒะบะพะฒะพะดัั‚ะฒะพ
๐Ÿ‡ท๐Ÿ‡บ ะ ัƒััะบะธะน
ะŸะพะปะฝะพะต ั€ัƒะบะพะฒะพะดัั‚ะฒะพ

๐ŸŽฌ Made a video about OmniRoute? Open an issue or discussion with the link โ€” we'll feature it here.


๐Ÿ“š Explore More

๐Ÿ’ฐ Pricing at a glance & the 0ใƒ‰ใƒซ Free Stack (11 providers)
Tier Example Cost
๐Ÿ’ณ Subscription Claude Code Pro / Codex / Copilot 10ใƒ‰ใƒซโ€“200/mo
๐Ÿ”‘ API Key (free tiers) NVIDIA NIM, Cerebras, Groq FREE
๐Ÿ’ฐ Cheap GLM-5 0ใƒ‰ใƒซ.5/1M ยท MiniMax M2.5 0ใƒ‰ใƒซ.3/1M pennies
๐Ÿ†“ Free Forever Kiro, Qoder, Qwen, Pollinations, LongCat 0ใƒ‰ใƒซ

The 0ใƒ‰ใƒซ Free Stack โ€” combine into one unbreakable combo:

Provider Prefix Free models Quota
Kiro kr/ Claude Sonnet 4.5, Haiku 4.5, Opus 4.6 50 credits/mo
Qoder if/ kimi-k2-thinking, qwen3-coder-plus, deepseek-r1 โ™พ๏ธ Unlimited
Qwen qw/ qwen3-coder-plus/flash/next โ™พ๏ธ Unlimited
Pollinations pol/ GPT-5, Claude, Gemini, DeepSeek, Llama 4 No key needed
LongCat lc/ LongCat-Flash-Lite 50M tokens/day ๐Ÿ”ฅ
Cloudflare AI cf/ 50+ models 10K neurons/day
NVIDIA NIM nvidia/ 129 models ~40 RPM
Cerebras cerebras/ Qwen3 235B, GPT-OSS 120B 1M tok/day

๐Ÿ’ก The dashboard "cost" is a savings tracker, not a bill โ€” OmniRoute never charges you. A "290ใƒ‰ใƒซ total cost" using free models means 290ใƒ‰ใƒซ saved.

๐Ÿ“– Complete free directory โ†’ docs/reference/FREE_TIERS.md โ€” 25+ providers, quotas, base URLs.

๐ŸŽฏ Use Cases โ€” ready-made combo playbooks

0ใƒ‰ใƒซ forever:

1. kr/claude-sonnet-4.5 (Kiro โ€” unlimited)
2. if/kimi-k2-thinking (Qoder โ€” unlimited)
3. pol/gpt-5 (Pollinations โ€” no key)
4. lc/longcat-flash-lite (50M tok/day backup)
Compression: aggressive (~50%) โ†’ double your free quota ยท Cost: 0ใƒ‰ใƒซ/mo

24/7 no interruptions: chain 2 subscriptions โ†’ cheap โ†’ free for 5 layers of fallback. Blocked region: free providers + global/per-provider proxy โ†’ access AI from any country. Max savings: subscription + cheap backup + ultra compression (~75%) โ†’ ~150ใƒ‰ใƒซโ€“300/mo saved for heavy users.

๐ŸŒ Bypass geo-blocks โ€” 3-level proxy + stealth

๐Ÿ‡ท๐Ÿ‡บ ๐Ÿ‡จ๐Ÿ‡ณ ๐Ÿ‡ฎ๐Ÿ‡ท ๐Ÿ‡จ๐Ÿ‡บ ๐Ÿ‡น๐Ÿ‡ท In a blocked region? OmniRoute's 3-level proxy (Global / Per-Provider / Per-Connection) proxies API requests, OAuth flows, connection tests, token refresh & model sync.

  • Protocols: HTTP/HTTPS, SOCKS5, authenticated proxies
  • ๐Ÿ†“ 1proxy marketplace โ€” hundreds of free validated proxies, quality scores, auto-rotation
  • Anti-detection โ€” TLS fingerprint spoofing (wreq-js), CLI fingerprint matching, proxy IP preservation

๐Ÿ“– docs/ops/PROXY_GUIDE.md

โœจ Full feature list โ€” 30+ capabilities (memory, evals, observability)

Routing: 14 strategies ยท task-aware smart routing ยท thinking budget controls ยท wildcard routing ยท system prompt injection. Compatibility: OpenAI โ†” Claude โ†” Gemini โ†” Responses API ยท auto OAuth refresh (PKCE, 8 providers) ยท multi-account round-robin ยท Batch + Files API ยท live OpenAPI 3.0. Protocols: MCP (37 tools, 3 transports, 13 scopes) ยท A2A (JSON-RPC 2.0, SSE, skills) ยท ACP ยท cloud agents (Codex, Devin, Jules). Quality & Ops: built-in Evals (golden-set: exact/contains/regex/custom) ยท guardrails (PII, injection, vision) ยท health dashboard ยท p50/p95/p99 telemetry ยท webhooks ยท compliance audit. AI Agent Skills: drop-in markdown manifests โ€” point any agent at skills/omniroute/SKILL.md. 10 skills available.

๐Ÿ“– MCP Server ยท A2A Server ยท Resilience Guide ยท Features Gallery

๐Ÿ“– Setup, env vars & FAQ
Env var Default Purpose
PORT 20128 API + dashboard port
REQUIRE_API_KEY false Require API key for all requests
DATA_DIR ~/.omniroute Database & config storage

Will I be charged by OmniRoute? No โ€” it's free, open-source software on your machine. You only pay paid providers directly. OmniRoute has no billing system. Are FREE providers really unlimited? Yes โ€” Kiro, Qoder, Pollinations, LongCat, Cloudflare. No catch. Will compression hurt quality? No โ€” it only compresses the input; code, URLs, JSON are always protected. Does it work where AI is blocked? Yes โ€” 3-level proxy + 1proxy marketplace reach all 177 providers.

๐Ÿ“– User Guide ยท API Reference ยท Environment Config

๐Ÿ› Troubleshooting
Problem Quick fix
"Language model did not provide messages" Provider quota exhausted โ†’ use a combo fallback
Rate limiting (429) Add fallback: cc/claude โ†’ glm/glm-4.7 โ†’ if/kimi-k2-thinking
OAuth token expired Auto-refreshed; if stuck, delete + re-auth in Providers
unsupported_country_region_territory Configure proxy in Settings โ†’ Proxy
Docker SQLite locks Use --stop-timeout 40 for clean WAL checkpoint
Node runtime errors Use Node >=20.20.2 <21, >=22.22.2 <23, or >=24 <25

๐Ÿ› Reporting a bug? Run npm run system-info and attach system-info.txt. ๐Ÿ“– docs/guides/TROUBLESHOOTING.md

๐Ÿ“ธ Dashboard screenshots
Page Screenshot Page Screenshot
Providers Providers Combos Combos
Analytics Analytics Health Health
Translator Translator Settings Settings
CLI Tools CLI Tools Usage Logs Usage

๐Ÿ“ง Support & Community

๐Ÿ’ฌ Join our WhatsApp groups โ€” get help, share tips, stay updated: ยท ๐ŸŒ International ยท ๐Ÿ‡ง๐Ÿ‡ท Portuguรชs



๐Ÿ› ๏ธ Tech Stack

  • Runtime: Node.js 20.20.2+, 22.22.2+, or 24.x LTS (24 LTS recommended)
  • Language: TypeScript 5.9 โ€” 100% TypeScript across src/ and open-sse/ (zero any in core modules since v2.0)
  • Framework: Next.js 16 + React 19 + Tailwind CSS 4
  • Database: better-sqlite3 (SQLite) + LowDB (JSON legacy) โ€” domain state, proxy logs, MCP audit, routing decisions, memory, skills
  • Schemas: Zod (MCP tool I/O validation, API contracts)
  • Protocols: MCP (stdio/HTTP) + A2A v0.3 (JSON-RPC 2.0 + SSE)
  • Streaming: Server-Sent Events (SSE) + WebSocket bridge (/v1/ws)
  • Auth: OAuth 2.0 (PKCE) + JWT + API Keys + MCP Scoped Authorization
  • Testing: Node.js test runner + Vitest (4,690+ test cases across 517 files โ€” unit, integration, E2E, security, ecosystem)
  • Platforms: Desktop (Electron), Android (Termux), PWA (any browser)
  • CI/CD: GitHub Actions (auto npm publish + Docker Hub on release)
  • Website: omniroute.online
  • Package: npmjs.com/package/omniroute
  • Docker: hub.docker.com/r/diegosouzapw/omniroute
  • Resilience: Circuit breaker, exponential backoff, anti-thundering herd, TLS spoofing, auto-combo self-healing

๐Ÿ“– Documentation

๐Ÿ“˜ Getting Started

Document Description
User Guide Providers, combos, CLI integration, deployment
Setup Guide Full install methods, CLI tool configs, protocol setup, timeout tuning
CLI Tools Guide Per-tool setup for Claude Code, Codex, Cursor, Cline, OpenClaw, Kilo, Copilot
Quick Start 3-step install โ†’ connect โ†’ configure

๐Ÿ”ง Operations & Deployment

Document Description
Docker Guide Docker run, Compose profiles, Caddy HTTPS, tunnels, image tags
VM Deployment Complete guide: VM + nginx + Cloudflare setup
Fly.io Deployment Deploy to Fly.io with persistent storage
Termux Guide Run OmniRoute on Android via Termux
PWA Guide Progressive Web App install, caching, architecture
Uninstall Guide Clean removal for all install methods
Environment Config Complete .env variables and references

๐Ÿง  Features & Architecture

Document Description
Architecture System architecture, data flow, and internals
Compression Guide 7-option pipeline: off / lite / standard / aggressive / ultra / RTK / stacked
RTK Compression Command-output compression, filters, trust, verify, raw-output recovery
Compression Engines Caveman, RTK, stacked pipelines, dashboard/API/MCP surfaces
Compression Rules Format JSON rule-pack schemas for Caveman and RTK filters
Compression Language Packs Language detection and Caveman rule-pack authoring
Resilience Guide Circuit breakers, cooldowns, queue, anti-thundering herd, TLS spoofing
Auto-Combo Engine 6-factor scoring, mode packs, self-healing
Proxy Guide 3-level proxy system, 1proxy marketplace, registry CRUD
Free Tiers 25+ free API providers consolidated directory
Features Gallery Visual dashboard tour with screenshots
Codebase Documentation Beginner-friendly codebase walkthrough

๐Ÿค– Protocols & APIs

Document Description
API Reference All endpoints with examples
OpenAPI Spec OpenAPI 3.0 specification
MCP Server 29 MCP tools, IDE configs, Python/TS/Go clients
MCP Server Guide MCP installation, transports, and tool reference
A2A Server JSON-RPC 2.0 protocol, skills, streaming, task mgmt
A2A Server Guide A2A agent card, tasks, skills, and streaming

๐Ÿ“‹ Project & Quality

Document Description
Contributing Development setup and guidelines
Security Policy Vulnerability reporting and security practices
i18n Guide 40+ language support, translation workflow, RTL
Release Checklist Pre-release validation steps
Coverage Plan Test coverage strategy and 4,690+ test suite

โญ Top Contributors

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.

oyi77
oyi77

๐Ÿฅ‡ 190 commits โ€ข +72K lines
Analytics engine, SQL aggregations,
proxy marketplace, test coverage
Chris Staley
Chris Staley

๐Ÿฅˆ 72 commits โ€ข +5.7K lines
SSE stream hardening, Responses API,
Gemini pagination, test regression fixes
zenobit
zenobit

๐Ÿฅ‰ 62 commits โ€ข +24K lines
CI/CD pipeline, i18n for 33 languages,
Void Linux package, platform fixes
R.D. & Randi
R.D. & Randi

๐Ÿ… 107 commits โ€ข +28K lines
Endpoints page, tunnel integrations,
Docker workflows, A2A status, compression UI
benzntech
benzntech

๐Ÿ… 20 commits โ€ข +7.5K lines
Electron desktop app, auto-updater,
release build workflows, cross-platform CI

๐Ÿ™ 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.



๐Ÿ‘ฅ Contributors

Contributors

How to Contribute

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

Releasing a New Version

# Create a release โ€” npm publish happens automatically
gh release create v3.8.2 --title "v3.8.2" --generate-notes

๐Ÿ“Š Stars

Star History Chart

๐ŸŒ StarMapper

StarMapper

๐Ÿ™ Acknowledgments

Special thanks to 9router by decolua โ€” the original project that inspired this fork. OmniRoute builds upon that incredible foundation with additional features, multi-modal APIs, and a full TypeScript rewrite.

Special thanks to CLIProxyAPI by router-for-me โ€” the original Go implementation that inspired this JavaScript port.

Special thanks to Caveman by JuliusBrussee (โญ 51K+) โ€” the viral "why use many token when few token do trick" project whose caveman-speak compression philosophy inspired OmniRoute's standard compression mode and 30+ filler/condensation regex rules.

Special thanks to RTK - Rust Token Killer by RTK AI โ€” the high-performance command-output compression project whose terminal, build, test, git, and tool-output filtering model inspired OmniRoute's RTK engine, JSON filter DSL, raw-output recovery, and stacked RTK โ†’ Caveman compression pipeline.


๐Ÿ“„ License

MIT License - see LICENSE for details.


โฌ† Back to top ยท Built with โค๏ธ for the open-source AI community.

OmniRoute v3.8.2 ยท Node โ‰ฅ22.22.2 ยท MIT License ยท omniroute.online

About

Never stop coding. Free AI gateway: one endpoint, 160+ providers (50+ free), connect Claude Code, Codex, Cursor, Cline & Copilot to FREE Claude/GPT/Gemini. RTK+Caveman stacked compression saves 15-95% tokens, smart auto-fallback, MCP/A2A, multimodal APIs, Desktop/PWA.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors

Languages

  • TypeScript 93.5%
  • JavaScript 6.2%
  • Python 0.2%
  • Shell 0.1%
  • CSS 0.0%
  • Dockerfile 0.0%

AltStyle ใซใ‚ˆใฃใฆๅค‰ๆ›ใ•ใ‚ŒใŸใƒšใƒผใ‚ธ (->ใ‚ชใƒชใ‚ธใƒŠใƒซ) /