# πŸš€ OmniRoute ### **The Free AI Gateway β€” one endpoint, 177+ providers, zero downtime.** **Auto-fallback to free models. Stop coding interruptions. Cut tokens 15-95%.** [![npm](https://img.shields.io/npm/v/omniroute?logo=npm&style=flat-square)](https://www.npmjs.com/package/omniroute) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE) [![Node](https://img.shields.io/badge/node-%E2%89%A520.20.2-brightgreen?style=flat-square)](package.json) [![Stars](https://img.shields.io/github/stars/diegosouzapw/OmniRoute?style=social)](https://github.com/diegosouzapw/OmniRoute) [![Trendshift](https://trendshift.io/api/badge/repositories/23589)](https://trendshift.io/repositories/23589) [**Website**](https://omniroute.online) Β· [**Quick Start**](#-quick-start) Β· [**Docs**](#-documentation) Β· [**Discord/WhatsApp**](#-community) v3.8.0 Β· MIT Β· Production-ready Β· Self-hosted
--- ## ⚑ The Pitch (60 seconds) | 🎯 The problem | βœ… How OmniRoute solves it | | ------------------------------ | -------------------------------------------------------------------------------------------------- | | Hit rate limits on Claude/GPT? | **Auto-fallback** across 177 providers β€” never see a 429 again | | Bored of switching API keys? | **One endpoint** (`localhost:20128`) speaks OpenAI, Anthropic, Gemini, Claude Code, Cursor formats | | Paying $200/mo for AI? | **11 free providers** + intelligent routing β†’ most users pay $0 | | Tokens too expensive? | **RTK + Caveman compression** saves 15-95% on eligible payloads | | Blocked region? | **4-level proxy** (account/provider/combo/global) + **1proxy free marketplace** | | Want CLI agents free? | Plug **Cursor, Cline, Codex, Claude Code, Aider, 15+ CLIs** at OmniRoute | πŸ“Ί **Watch in action:** [Video demo](https://www.youtube.com/@diegosouza-pw) --- ## πŸ–ΌοΈ Dashboard Preview ![OmniRoute Main Dashboard](docs/screenshots/MainOmniRoute.png)
Click for more screenshots (Providers, Combos, Memory, MCP, Audit…) | | | | --------------------------------------------- | ---------------------------------------------------- | | ![Providers](docs/screenshots/Provedores.png) | ![Combos](docs/screenshots/Combos.png) | | ![Routing](docs/screenshots/Roteamento.png) | ![Compression](docs/screenshots/Compress%C3%A3o.png) | | ![Audit](docs/screenshots/Auditoria.png) | ![Analytics](docs/screenshots/Analytics.png) |
--- ## ⚑ Quick Start ```bash # Run instantly (npx β€” no install needed) npx -y omniroute@latest # Or install globally npm install -g omniroute && omniroute # Or via Docker docker run -d -p 20128:20128 diegosouzapw/omniroute:3.8.0 ``` β†’ Open **http://localhost:20128** β†’ login with `admin` / `CHANGEME` β†’ connect your first provider via OAuth or API key. **Point any OpenAI-compatible client at OmniRoute:** ```bash export OPENAI_BASE_URL=http://localhost:20128/v1 export OPENAI_API_KEY=or_ ``` That's it. Cursor, Cline, Codex, Continue, Aider, and any SDK now work. β†’ Detailed setup: [`docs/guides/SETUP_GUIDE.md`](docs/guides/SETUP_GUIDE.md) --- ## 🌟 What's new in v3.8.0 - πŸ€– **Auto-Combo zero-config routing** β€” just use `auto/coding`, `auto/cheap`, `auto/fast`, `auto/offline`, `auto/smart`, `auto/lkgp` as model IDs - 🎯 **Manifest-aware tier routing W1-W4** β€” automatic tier prioritization - πŸ†• **Command Code provider** + **Z.AI quota labels** + **KIE video expansion** - πŸ” **Windsurf + Devin CLI + GitLab Duo OAuth** flows - πŸ†“ **9 new free providers**: LLM7, Lepton, Kluster, UncloseAI, BazaarLink, Completions, Enally, FreeTheAi, AgentRouter ($200 credits) - 🩺 **Model Cooldowns dashboard** with manual re-enable - 🎨 **Cursor full OpenAI parity** (tools, streaming, sessions) - πŸ“Œ **Per-session sticky routing** for Codex - πŸ”Š **Inworld TTS** enhancements - 🧠 **Reasoning Replay Cache** β€” fixes 400s on DeepSeek V4, Kimi K2, Qwen-Thinking, GLM - πŸ”„ **Reset-aware routing** strategy (14th strategy) - πŸ› οΈ **20+ new CLI commands** (`omniroute setup/doctor/providers/combos`) β†’ Full changelog: [`CHANGELOG.md`](CHANGELOG.md) --- ## 🎯 Why OmniRoute Wins | | OmniRoute v3.8 | LiteLLM | OpenRouter | | ------------------ | ------------------- | ---------------- | ------------- | | Providers | **177+** | ~50 | ~50 | | Free providers | **11** | 0 | 0 | | OAuth providers | **14** | 0 | 1 | | Routing strategies | **14** | 3 | 1 | | Auto routing | βœ… 9-factor scoring | ❌ | ❌ | | Prompt compression | βœ… RTK + Caveman | ❌ | ❌ | | MCP server | βœ… 37 tools | ❌ | ❌ | | A2A protocol | βœ… v0.3 + 5 skills | ❌ | ❌ | | Desktop app | βœ… Electron 41 | ❌ | ❌ | | PWA | βœ… | ❌ | ❌ | | Self-hosted | βœ… MIT | Limited | ❌ (cloud) | | Pricing | **$0 forever** | OSS / Cloud paid | 10% fee + API | β†’ Detailed comparison: [`docs/guides/FEATURES.md`](docs/guides/FEATURES.md) --- ## πŸ› οΈ Compatible CLI Tools (17+) All work out-of-the-box once you point `OPENAI_BASE_URL` at OmniRoute: **Claude family:** Claude Code Β· Cline Β· Continue Β· Kilo Code Β· Kimi Coding **OpenAI family:** Codex CLI Β· Cursor Β· Aider Β· OpenClaw Β· Droid Β· AMP **Google family:** Gemini CLI Β· Antigravity Β· Jules **Others:** Windsurf Β· GitLab Duo Β· Devin CLI Β· Hermes Β· Amazon Q Β· Kiro Β· Qoder Β· Custom β†’ Full setup: [`docs/reference/CLI-TOOLS.md`](docs/reference/CLI-TOOLS.md) --- ## 🌐 Providers (177+) ### πŸ†“ Free providers (11 β€” no API key or unlimited tier) | Provider | Highlight | | --------------------------------------------------- | --------------------------------------- | | **Kiro AI** | 50 credits/month (Claude Sonnet/Haiku) | | **Qoder AI** | Unlimited (Kimi-K2, Qwen3, DeepSeek-R1) | | **Gemini CLI** | 180K tokens/month | | **Amazon Q** | AWS Builder ID OAuth | | **LongCat** | 50M tokens/day | | **Pollinations** | No API key, GPT-5 + Claude | | **AgentRouter** | $200 free credits | | **LLM7** Β· **Lepton** Β· **Kluster** Β· **UncloseAI** | New v3.8 free tiers | ⚠️ Qwen Code OAuth was **discontinued on 2026-04-15** (use API key with `alicode` provider instead). β†’ Curated guide: [`docs/reference/FREE_TIERS.md`](docs/reference/FREE_TIERS.md) Β· Full catalog: [`docs/reference/PROVIDER_REFERENCE.md`](docs/reference/PROVIDER_REFERENCE.md) (auto-generated) ### πŸ” OAuth providers (14) Claude Code Β· Codex Β· GitHub Copilot Β· Cursor Β· Antigravity Β· Gemini Β· Kimi Coding Β· Kilo Code Β· Cline Β· Qwen Β· Kiro Β· Qoder Β· Windsurf Β· GitLab Duo ### πŸ”‘ API key providers (~123) OpenAI Β· Anthropic Β· Google Β· Mistral Β· Cohere Β· DeepSeek Β· Groq Β· Together Β· Fireworks Β· Cerebras Β· SambaNova Β· NVIDIA NIM Β· Bedrock Β· Vertex Β· Azure Β· Cloudflare AI Β· 100+ more. ### 🏠 Self-hosted (10) Ollama Β· LM Studio Β· vLLM Β· Llamafile Β· Lemonade Β· Petals Β· Triton Β· Docker Model Runner Β· Xinference Β· Oobabooga --- ## πŸ€– Auto-Combo β€” Zero-Config Routing Just use `auto/` as model ID. No combo setup needed. ```bash # 6 variants + plain `auto`: auto/coding # β†’ optimized for coding tasks auto/cheap # β†’ minimize cost auto/fast # β†’ minimize latency auto/offline # β†’ prefer local providers auto/smart # β†’ prefer top-tier models auto/lkgp # β†’ Last-Known-Good-Path (sticky) auto # β†’ balanced default ``` **How it picks:** 9-factor scoring (health Β· quota Β· cost Β· latency Β· taskFit Β· stability Β· tierPriority Β· tierAffinity Β· specificityMatch) over a virtual candidate pool built from all enabled providers. β†’ Full guide: [`docs/routing/AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md) --- ## πŸ—œοΈ Prompt Compression β€” Save 15-95% Tokens Two engines, stackable: - **Caveman** β€” natural-language condensation (filler removal, hedging, repeated context). 30+ regex rules per language pack (en, es, pt-BR, de, fr, ja). - **RTK** β€” terminal/shell/git/test output. 49 declarative filters. **Modes:** `off` Β· `lite` Β· `standard` Β· `aggressive` Β· `ultra` Β· `rtk` Β· `stacked` (RTKβ†’Caveman, max savings). β†’ [`docs/compression/COMPRESSION_GUIDE.md`](docs/compression/COMPRESSION_GUIDE.md) Β· [`docs/compression/RTK_COMPRESSION.md`](docs/compression/RTK_COMPRESSION.md) Β· [`docs/compression/COMPRESSION_LANGUAGE_PACKS.md`](docs/compression/COMPRESSION_LANGUAGE_PACKS.md) --- ## 🌍 Bypass Geographic Blocks For users in **Russia, China, Iran, Cuba, Turkey** and other regions: - **4-level outbound proxy** β€” account / provider / combo / global scopes - **1proxy free marketplace** β€” auto-syncs working HTTP/SOCKS5 proxies - **Anti-detection** β€” TLS fingerprinting (JA3/JA4), CCH headshakes, header sanitization - **Public tunnels** β€” Cloudflare (Quick or Named), ngrok, Tailscale Funnel for OAuth callbacks β†’ [`docs/ops/PROXY_GUIDE.md`](docs/ops/PROXY_GUIDE.md) Β· [`docs/ops/TUNNELS_GUIDE.md`](docs/ops/TUNNELS_GUIDE.md) Β· [`docs/security/STEALTH_GUIDE.md`](docs/security/STEALTH_GUIDE.md) --- ## πŸ“± Multi-Platform | Platform | Install | Doc | | --------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------- | | **CLI / Server** | `npm install -g omniroute` | [`SETUP_GUIDE.md`](docs/guides/SETUP_GUIDE.md) | | **Desktop (Win/Mac/Linux)** | Electron installer from GitHub Releases | [`ELECTRON_GUIDE.md`](docs/guides/ELECTRON_GUIDE.md) | | **PWA** | Install from any modern browser | [`PWA_GUIDE.md`](docs/guides/PWA_GUIDE.md) | | **Android (Termux)** | `pkg install nodejs-lts && npm i -g omniroute` | [`TERMUX_GUIDE.md`](docs/guides/TERMUX_GUIDE.md) | | **Docker** | `docker compose up` (base/cli/host/cliproxyapi profiles) | [`DOCKER_GUIDE.md`](docs/guides/DOCKER_GUIDE.md) | | **VM / VPS** | Generic Ubuntu/Debian + nginx + systemd | [`VM_DEPLOYMENT_GUIDE.md`](docs/ops/VM_DEPLOYMENT_GUIDE.md) | | **Fly.io** | `fly deploy` | [`FLY_IO_DEPLOYMENT_GUIDE.md`](docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md) | --- ## 🧩 Extensibility | System | What it does | Docs | | ----------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------ | | 🧠 **Skills** | Built-in skills + marketplace + sandboxed custom skills (Docker) | [`docs/frameworks/SKILLS.md`](docs/frameworks/SKILLS.md) | | πŸ’Ύ **Memory** | Persistent conversational memory (SQLite FTS5 + Qdrant vector) | [`docs/frameworks/MEMORY.md`](docs/frameworks/MEMORY.md) | | ☁️ **Cloud Agents** | Submit long tasks to Codex Cloud / Devin / Jules | [`docs/frameworks/CLOUD_AGENT.md`](docs/frameworks/CLOUD_AGENT.md) | | πŸͺ **Webhooks** | HMAC-signed event delivery (request.completed, quota.exceeded, etc.) | [`docs/frameworks/WEBHOOKS.md`](docs/frameworks/WEBHOOKS.md) | | πŸ›‘οΈ **Guardrails** | PII masker, prompt injection guard, vision bridge β€” hot-reload | [`docs/security/GUARDRAILS.md`](docs/security/GUARDRAILS.md) | | πŸ§ͺ **Evals** | Suite-based regression testing (combos/models/cases/rubrics) | [`docs/frameworks/EVALS.md`](docs/frameworks/EVALS.md) | | πŸ” **Compliance/Audit** | `audit_log` table, retention, `noLog` opt-out, SSRF logging | [`docs/security/COMPLIANCE.md`](docs/security/COMPLIANCE.md) | | πŸ›‘οΈ **MCP Server** | 37 tools, 3 transports (stdio/SSE/Streamable HTTP), ~13 scopes | [`docs/frameworks/MCP-SERVER.md`](docs/frameworks/MCP-SERVER.md) | | 🀝 **A2A Protocol** | v0.3 JSON-RPC, 5 skills (smart-routing, quota, discovery, cost, health) | [`docs/frameworks/A2A-SERVER.md`](docs/frameworks/A2A-SERVER.md) | --- ## πŸ“š Documentation Everything you need, organized by area. ### πŸš€ Start here - [`SETUP_GUIDE.md`](docs/guides/SETUP_GUIDE.md) β€” install + connect first provider - [`USER_GUIDE.md`](docs/guides/USER_GUIDE.md) β€” end-user manual (modes, combos, CLIs, audio, ~1200 lines) - [`FREE_TIERS.md`](docs/reference/FREE_TIERS.md) β€” start free, no card - [`TROUBLESHOOTING.md`](docs/guides/TROUBLESHOOTING.md) β€” common issues + v3.8 known issues ### πŸ›οΈ Architecture - [`ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) β€” high-level architecture - [`CODEBASE_DOCUMENTATION.md`](docs/architecture/CODEBASE_DOCUMENTATION.md) β€” engineering reference - [`REPOSITORY_MAP.md`](docs/architecture/REPOSITORY_MAP.md) β€” every directory and root file - [`FEATURES.md`](docs/guides/FEATURES.md) β€” full feature matrix ### πŸ”Œ API & contracts - [`API_REFERENCE.md`](docs/reference/API_REFERENCE.md) β€” endpoint reference - [`openapi.yaml`](docs/reference/openapi.yaml) β€” OpenAPI 3.0 spec - [`PROVIDER_REFERENCE.md`](docs/reference/PROVIDER_REFERENCE.md) β€” full catalog (auto-generated) - [`CLI-TOOLS.md`](docs/reference/CLI-TOOLS.md) β€” CLI integrations + internal CLI - [`ENVIRONMENT.md`](docs/reference/ENVIRONMENT.md) β€” all env vars ### 🎯 Routing & resilience - [`AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md) β€” Auto-Combo (9-factor scoring, 14 strategies) - [`RESILIENCE_GUIDE.md`](docs/architecture/RESILIENCE_GUIDE.md) β€” circuit breaker + cooldown + lockout - [`REASONING_REPLAY.md`](docs/routing/REASONING_REPLAY.md) β€” reasoning cache for DeepSeek/Kimi/Qwen - [`STEALTH_GUIDE.md`](docs/security/STEALTH_GUIDE.md) β€” TLS fingerprinting + obfuscation ### πŸ€– Agent protocols - [`AGENT_PROTOCOLS_GUIDE.md`](docs/frameworks/AGENT_PROTOCOLS_GUIDE.md) β€” A2A vs ACP vs Cloud Agents - [`MCP-SERVER.md`](docs/frameworks/MCP-SERVER.md) β€” Model Context Protocol server - [`A2A-SERVER.md`](docs/frameworks/A2A-SERVER.md) β€” Agent-to-Agent protocol - [`CLOUD_AGENT.md`](docs/frameworks/CLOUD_AGENT.md) β€” Codex Cloud / Devin / Jules ### 🧠 Extensions - [`SKILLS.md`](docs/frameworks/SKILLS.md) β€” Skills framework - [`MEMORY.md`](docs/frameworks/MEMORY.md) β€” Memory system - [`EVALS.md`](docs/frameworks/EVALS.md) β€” Eval framework - [`GUARDRAILS.md`](docs/security/GUARDRAILS.md) β€” PII / injection / vision - [`WEBHOOKS.md`](docs/frameworks/WEBHOOKS.md) β€” Webhook delivery - [`COMPLIANCE.md`](docs/security/COMPLIANCE.md) β€” Audit + retention - [`AUTHZ_GUIDE.md`](docs/architecture/AUTHZ_GUIDE.md) β€” Authorization pipeline ### πŸ—œοΈ Compression - [`COMPRESSION_GUIDE.md`](docs/compression/COMPRESSION_GUIDE.md) - [`COMPRESSION_ENGINES.md`](docs/compression/COMPRESSION_ENGINES.md) - [`COMPRESSION_RULES_FORMAT.md`](docs/compression/COMPRESSION_RULES_FORMAT.md) - [`COMPRESSION_LANGUAGE_PACKS.md`](docs/compression/COMPRESSION_LANGUAGE_PACKS.md) - [`RTK_COMPRESSION.md`](docs/compression/RTK_COMPRESSION.md) ### πŸš€ Deployment - [`DOCKER_GUIDE.md`](docs/guides/DOCKER_GUIDE.md) - [`VM_DEPLOYMENT_GUIDE.md`](docs/ops/VM_DEPLOYMENT_GUIDE.md) - [`FLY_IO_DEPLOYMENT_GUIDE.md`](docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md) - [`ELECTRON_GUIDE.md`](docs/guides/ELECTRON_GUIDE.md) - [`PWA_GUIDE.md`](docs/guides/PWA_GUIDE.md) - [`TERMUX_GUIDE.md`](docs/guides/TERMUX_GUIDE.md) - [`TUNNELS_GUIDE.md`](docs/ops/TUNNELS_GUIDE.md) - [`PROXY_GUIDE.md`](docs/ops/PROXY_GUIDE.md) ### πŸ“‹ Operations - [`RELEASE_CHECKLIST.md`](docs/ops/RELEASE_CHECKLIST.md) β€” release flow with Claude Code skills - [`COVERAGE_PLAN.md`](docs/ops/COVERAGE_PLAN.md) β€” test coverage state (current: 82.58%/82.58%/84.23%/75.22%) - [`I18N.md`](docs/guides/I18N.md) β€” 30 supported locales - [`UNINSTALL.md`](docs/guides/UNINSTALL.md) ### 🀝 Contributing & policy - [`CONTRIBUTING.md`](CONTRIBUTING.md) β€” contributor guide - [`SECURITY.md`](SECURITY.md) β€” security policy - [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) - [`CLAUDE.md`](CLAUDE.md) β€” rules for Claude Code agents - [`AGENTS.md`](AGENTS.md) β€” rules for non-Claude agents - [`GEMINI.md`](GEMINI.md) β€” rules for Gemini agents --- ## πŸ’‘ Use Cases | Scenario | Solution | | --------------------------------- | ------------------------------------------------------------- | | "Claude Pro user, hit rate limit" | Combo: Claude β†’ GLM β†’ DeepSeek (auto-fallback) | | "Want $0 forever" | `auto/cheap` β†’ Kiro/Qoder/Pollinations fallback chain | | "24/7 coding, no interruptions" | `auto/lkgp` (sticky to last-good) + Resilience | | "Blocked region" | 1proxy free marketplace + Cloudflare Quick Tunnel | | "Max token savings" | Stacked compression: `rtk β†’ caveman` (78-95% on logs) | | "Multi-agent system" | Expose OmniRoute as A2A node, route via `smart-routing` skill | | "Long-running coding task" | Cloud Agents β†’ Devin/Jules with management auth | β†’ Detailed playbooks: [`USER_GUIDE.md`](docs/guides/USER_GUIDE.md) Β· [`AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md) --- ## πŸ“‘ Protocols supported OmniRoute speaks all major AI protocols β€” clients don't need to change: - **OpenAI** (Chat Completions, Responses, Embeddings, Images, Audio, Files, Batches, Rerank, Moderations) - **Anthropic Messages** (Claude format, with thinking blocks + reasoning replay) - **Google Gemini** (generateContent + Vertex) - **Claude Code** (CLI-specific format with CCH + fingerprinting) - **Cursor** (proprietary format with tool calls) - **Kiro** (AWS Builder ID OAuth) - **MCP** (Model Context Protocol β€” 37 tools, stdio/SSE/Streamable HTTP) - **A2A** (Agent-to-Agent v0.3 JSON-RPC β€” agent card at `/.well-known/agent.json`) --- ## πŸ—οΈ Architecture (10-second tour) ``` Client β†’ /v1/chat/completions β†’ [CORS β†’ Zod β†’ Auth β†’ Authz β†’ Guardrails] β†’ handleChatCore() β†’ [Cache β†’ Rate limit β†’ Combo routing] β†’ translateRequest β†’ getExecutor β†’ fetch upstream (with retry) β†’ response translation β†’ SSE stream or JSON β†’ [Compliance audit] β†’ response ``` **Major pieces:** - **`src/app/`** β€” Next.js 16 App Router (60+ API routes + 30 dashboard pages) - **`src/lib/`** β€” 50+ domain modules (db, a2a, memory, skills, guardrails, evals, …) - **`open-sse/`** β€” Streaming engine workspace (31 executors, 9+8+9 translators, 80+ services, 37-tool MCP server) - **`src/domain/`** β€” Pure business logic (policies, fallback, cost rules) - **`src/server/`** β€” Server-only (authz pipeline, cors) β†’ Deep dive: [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) Β· [`docs/architecture/CODEBASE_DOCUMENTATION.md`](docs/architecture/CODEBASE_DOCUMENTATION.md) --- ## 🌍 i18n UI translated to **30 languages** with full RTL support for Arabic and Hebrew. 🌐 [English](README.md) Β· [PortuguΓͺs](docs/i18n/pt-BR/README.md) Β· [EspaΓ±ol](docs/i18n/es/README.md) Β· [FranΓ§ais](docs/i18n/fr/README.md) Β· [Deutsch](docs/i18n/de/README.md) Β· [δΈ­ζ–‡](docs/i18n/zh-CN/README.md) Β· [ζ—₯本θͺž](docs/i18n/ja/README.md) Β· [ν•œκ΅­μ–΄](docs/i18n/ko/README.md) Β· [Ψ§Ω„ΨΉΨ±Ψ¨ΩŠΨ©](docs/i18n/ar/README.md) Β· [ΰ€Ήΰ€Ώΰ€¨ΰ₯ΰ€¦ΰ₯€](docs/i18n/hi/README.md) Β· [Русский](docs/i18n/ru/README.md) Β· [+ 19 more](docs/i18n/) β†’ Adding a language: [`docs/guides/I18N.md`](docs/guides/I18N.md) --- ## 🀝 Community - 🌐 **Website:** [omniroute.online](https://omniroute.online) - πŸ“¦ **npm:** [omniroute](https://www.npmjs.com/package/omniroute) - 🐳 **Docker Hub:** [diegosouzapw/omniroute](https://hub.docker.com/r/diegosouzapw/omniroute) - πŸ’¬ **WhatsApp (BR):** Brazilian community group β€” see README link - πŸ› **Issues:** [GitHub Issues](https://github.com/diegosouzapw/OmniRoute/issues) - πŸ’‘ **Discussions:** [GitHub Discussions](https://github.com/diegosouzapw/OmniRoute/discussions) --- ## ❀️ Contributing We welcome PRs! Start with: 1. Read [`CONTRIBUTING.md`](CONTRIBUTING.md) β€” setup, conventional commits, testing 2. Pick an issue labeled [`good first issue`](https://github.com/diegosouzapw/OmniRoute/labels/good%20first%20issue) 3. Branch from `main` (`feat/*`, `fix/*`, `docs/*`, `refactor/*`, `test/*`, `chore/*`) 4. Hooks will run lint + test on commit/push **Adding a provider?** [`docs/architecture/ARCHITECTURE.md Β§ Adding a New Provider`](docs/architecture/ARCHITECTURE.md) **Adding an MCP tool?** [`docs/frameworks/MCP-SERVER.md`](docs/frameworks/MCP-SERVER.md) **Adding an A2A skill?** [`docs/frameworks/A2A-SERVER.md Β§ Adding a New Skill`](docs/frameworks/A2A-SERVER.md) --- ## πŸ”’ Security - **Reporting:** see [`SECURITY.md`](SECURITY.md) for disclosure policy - **Supported versions:** 3.8.x (Active), 3.7.x (Security only) - **Secrets:** never commit. Use `.env` (auto-generated from `.env.example` on first install) or vaults - **Encryption:** credentials at rest with AES-256-GCM - **Authz:** route-aware classification (`src/server/authz/`) β€” see [`docs/architecture/AUTHZ_GUIDE.md`](docs/architecture/AUTHZ_GUIDE.md) - **Guardrails:** PII masking, prompt injection detection β€” hot-reloadable --- ## πŸ“„ License [MIT](LICENSE) Β© 2025-2026 [Diego Souza](https://github.com/diegosouzapw) Free forever. Self-hosted. No tracking. No cloud lock-in. ---
**[⬆ Back to top](#-omniroute)** Β· Built with ❀️ for the open-source AI community. OmniRoute v3.8.0 Β· Node β‰₯20.20.2 Β· MIT License