11

Home

github-actions[bot] edited this page 2026-07-13 12:12:53 +00:00

Table of Contents

• 🚀 OmniRoute — The Free AI Gateway
• ✨ Highlights
• 🚀 Quick Start
• 📚 Documentation
• 🔗 Links

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

🚀 OmniRoute — The Free AI Gateway

Never stop coding. Connect every AI tool to 250 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.

---

✨ Highlights

Feature	Description
250 AI Providers	OpenAI, Anthropic, Gemini, DeepSeek, Groq, xAI, Mistral, and many more
50+ Free Tiers	OAuth + free-tier providers for zero-cost AI access
18 Routing Strategies	Priority, weighted, round-robin, cost-optimized, context-relay, and more
Token Compression	RTK + Caveman engines save 15–95% tokens automatically
MCP Server	87 tools with stdio/SSE/Streamable HTTP transports
A2A Protocol	JSON-RPC 2.0 agent-to-agent communication
Electron App	Cross-platform desktop app (Windows, macOS, Linux)
40+ Languages	Full i18n support across the dashboard

🚀 Quick Start

# Install via npm
npx omniroute@latest

# Or via Docker
docker run -p 20128:20128 diegosouzapw/omniroute

Then open http://localhost:20128.

📚 Documentation

Use the sidebar to navigate through all documentation sections:

• Getting Started — Installation, setup, first steps
• User Guide — Complete usage guide
• Features — All features explained
• Architecture — System design and internals
• API Reference — REST API documentation
• Providers — All 250 supported providers
• Combos & Routing — Routing strategies
• Compression — Token compression pipeline
• MCP Server — MCP tools and transports
• A2A Server — Agent-to-agent protocol
• Security — Auth, guardrails, compliance
• Deployment — Deploy to VPS/VM/Fly.io
• CLI & Tools — Command-line reference
• Environment — All environment variables
• Troubleshooting — Common issues & fixes
• Contributing — How to contribute

🔗 Links

• GitHub Repository
• npm Package
• Docker Hub
• Website
• WhatsApp Community 🌍
• WhatsApp Community 🇧🇷

🏠 Home

🌍 Languages (40+)

---

🚀 Getting Started

• Setup Guide
• User Guide
• Features
• Quick Start (Docker)
• Electron Desktop App
• Termux (Android)
• PWA Guide

🌐 Providers

• Provider Reference
• All Providers
• Free Tiers
• Kiro Setup

🎯 Routing & Combos

• Auto-Combo
• Reasoning Replay

🗜️ Compression

• Compression Guide
• Compression Engines
• RTK Compression
• Language Packs
• Rules Format

🔌 Integrations

• MCP Server
• A2A Server
• Agent Protocols
• OpenCode Plugin
• Webhooks
• Cloud Agents
• Skills
• Memory
• Evals
• Gamification

🏗️ Architecture

• Architecture Overview
• Codebase Documentation
• Repository Map
• Authorization Guide
• Resilience Guide

🔒 Security

• Guardrails
• Compliance
• Error Sanitization
• Public Credentials
• Route Guard Tiers
• Stealth Guide
• CLI Token Auth

📋 Reference

• API Reference
• CLI Tools
• Environment Variables

🚀 Operations

• VM Deployment
• Fly.io Deployment
• Tunnels Guide
• Proxy Guide
• SQLite Runtime
• Coverage Plan
• Release Checklist

ℹ️ More

• Troubleshooting
• i18n / Translations
• Uninstall
• Contributing
• Comparison vs Alternatives

OmniRoute · Website · npm · Docker Hub