<div align="center">
  <img src="./docs/screenshots/MainOmniRoute.png" alt="OmniRoute Dashboard" width="800"/>
  
  # 🚀 OmniRoute — безкоштовний ШІ-шлюз

### Ніколи не припиняйте кодувати. Розумна маршрутизація до **БЕЗКОШТОВНИХ і недорогих моделей штучного інтелекту** з автоматичним резервним копіюванням.

_Ваш універсальний API-проксі — одна кінцева точка, понад 36 провайдерів, нуль простоїв._

**Завершення чату • Вбудовування • Генерація зображень • Аудіо • Реранжування • 100% TypeScript**

---

### 🤖 Безкоштовний постачальник AI для ваших улюблених агентів кодування

_Підключіть будь-який інструмент IDE або CLI на основі штучного інтелекту через OmniRoute — безкоштовний шлюз API для необмеженого програмування._

  <table>
    <tr>
      <td align="center" width="110">
        <a href="https://github.com/cline/cline">
          <img src="./public/providers/openclaw.png" alt="OpenClaw" width="48"/><br/>
          <b>OpenClaw</b>
        </a><br/>
        <sub>⭐ 205K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/HKUDS/nanobot">
          <img src="./public/providers/nanobot.png" alt="NanoBot" width="48"/><br/>
          <b>NanoBot</b>
        </a><br/>
        <sub>⭐ 20.9K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/sipeed/picoclaw">
          <img src="./public/providers/picoclaw.jpg" alt="PicoClaw" width="48"/><br/>
          <b>PicoClaw</b>
        </a><br/>
        <sub>⭐ 14.6K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/zeroclaw-labs/zeroclaw">
          <img src="./public/providers/zeroclaw.png" alt="ZeroClaw" width="48"/><br/>
          <b>ZeroClaw</b>
        </a><br/>
        <sub>⭐ 9.9K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/nearai/ironclaw">
          <img src="./public/providers/ironclaw.png" alt="IronClaw" width="48"/><br/>
          <b>IronClaw</b>
        </a><br/>
        <sub>⭐ 2.1K</sub>
      </td>
    </tr>
    <tr>
      <td align="center" width="110">
        <a href="https://github.com/anomalyco/opencode">
          <img src="./public/providers/opencode.svg" alt="OpenCode" width="48"/><br/>
          <b>OpenCode</b>
        </a><br/>
        <sub>⭐ 106K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/openai/codex">
          <img src="./public/providers/codex.png" alt="Codex CLI" width="48"/><br/>
          <b>Codex CLI</b>
        </a><br/>
        <sub>⭐ 60.8K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/anthropics/claude-code">
          <img src="./public/providers/claude.png" alt="Claude Code" width="48"/><br/>
          <b>Claude Code</b>
        </a><br/>
        <sub>⭐ 67.3K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/google-gemini/gemini-cli">
          <img src="./public/providers/gemini-cli.png" alt="Gemini CLI" width="48"/><br/>
          <b>Gemini CLI</b>
        </a><br/>
        <sub>⭐ 94.7K</sub>
      </td>
      <td align="center" width="110">
        <a href="https://github.com/Kilo-Org/kilocode">
          <img src="./public/providers/kilocode.png" alt="Kilo Code" width="48"/><br/>
          <b>Kilo Code</b>
        </a><br/>
        <sub>⭐ 15.5K</sub>
      </td>
    </tr>
  </table>

<sub>📡 Усі агенти підключаються через <code>http://localhost:20128/v1</code> або <code>http://cloud.omniroute.online/v1</code> — одна конфігурація, необмежена кількість моделей і квота</sub>

---

[![npm version](https://img.shields.io/npm/v/omniroute?color=cb3837&logo=npm)](https://www.npmjs.com/package/omniroute)
[![Docker Hub](https://img.shields.io/docker/v/diegosouzapw/omniroute?label=Docker%20Hub&logo=docker&color=2496ED)](https://hub.docker.com/r/diegosouzapw/omniroute)
[![License](https://img.shields.io/github/license/diegosouzapw/OmniRoute)](https://github.com/diegosouzapw/OmniRoute/blob/main/LICENSE)
[![Website](https://img.shields.io/badge/Website-omniroute.online-blue?logo=google-chrome&logoColor=white)](https://omniroute.online)
[![WhatsApp](https://img.shields.io/badge/WhatsApp-Community-25D366?logo=whatsapp&logoColor=white)](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t)

[🌐 Website](https://omniroute.online) • [🚀 Quick Start](#-quick-start) • [💡 Features](#-key-features) • [📖 Docs](#-documentation) • [💰 Pricing](#-pricing-at-a-glance) • [💬 WhatsApp](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t)

🌐 **Available in:** 🇺🇸 [English](README.md) | 🇧🇷 [Português (Brasil)](README.pt-BR.md) | 🇪🇸 [Español](README.es.md) | 🇫🇷 [Français](README.fr.md) | 🇮🇹 [Italiano](README.it.md) | 🇷🇺 [Русский](README.ru.md) | 🇨🇳 [中文 (简体)](README.zh-CN.md) | 🇩🇪 [Deutsch](README.de.md) | 🇮🇳 [हिन्दी](README.in.md) | 🇹🇭 [ไทย](README.th.md) | 🇺🇦 [Українська](README.uk-UA.md) | 🇸🇦 [العربية](README.ar.md) | 🇯🇵 [日本語](README.ja.md) | 🇻🇳 [Tiếng Việt](README.vi.md) | 🇧🇬 [Български](README.bg.md) | 🇩🇰 [Dansk](README.da.md) | 🇫🇮 [Suomi](README.fi.md) | 🇮🇱 [עברית](README.he.md) | 🇭🇺 [Magyar](README.hu.md) | 🇮🇩 [Bahasa Indonesia](README.id.md) | 🇰🇷 [한국어](README.ko.md) | 🇲🇾 [Bahasa Melayu](README.ms.md) | 🇳🇱 [Nederlands](README.nl.md) | 🇳🇴 [Norsk](README.no.md) | 🇵🇹 [Português (Portugal)](README.pt.md) | 🇷🇴 [Română](README.ro.md) | 🇵🇱 [Polski](README.pl.md) | 🇸🇰 [Slovenčina](README.sk.md) | 🇸🇪 [Svenska](README.sv.md) | 🇵🇭 [Filipino](README.phi.md)

</div>

---

## 🤔 Чому OmniRoute?

**Припиніть витрачати гроші та досягати лімітів:**

- <img src="https://img.shields.io/badge/✗-e74c3c?style=flat-square" height="16"/> Квота підписки закінчується без використання кожного місяця
- <img src="https://img.shields.io/badge/✗-e74c3c?style=flat-square" height="16"/> Обмеження швидкості перешкоджають кодуванню в середині
- <img src="https://img.shields.io/badge/✗-e74c3c?style=flat-square" height="16"/> Дорогі API ($20-50/місяць за постачальника)
- <img src="https://img.shields.io/badge/✗-e74c3c?style=flat-square" height="16"/> Ручне перемикання між провайдерами

**OmniRoute вирішує цю проблему:**

- ✅ **Збільште кількість підписок** - Відстежуйте квоту, використовуйте кожен біт перед скиданням
- ✅ **Автоматичний резерв** - Підписка → Ключ API → Дешево → Безкоштовно, без простоїв
- ✅ **Кілька облікових записів** - Циклічний цикл між обліковими записами кожного постачальника
- ✅ **Універсальний** - Працює з Claude Code, Codex, Gemini CLI, Cursor, Cline, OpenClaw, будь-яким інструментом CLI

---

## 🔄 Як це працює

```
┌─────────────┐
│  Your CLI   │  (Claude Code, Codex, Gemini CLI, OpenClaw, Cursor, Cline...)
│   Tool      │
└──────┬──────┘
       │ http://localhost:20128/v1
       ↓
┌─────────────────────────────────────────┐
│           OmniRoute (Smart Router)        │
│  • Format translation (OpenAI ↔ Claude) │
│  • Quota tracking + Embeddings + Images │
│  • Auto token refresh                   │
└──────┬──────────────────────────────────┘
       │
       ├─→ [Tier 1: SUBSCRIPTION] Claude Code, Codex, Gemini CLI
       │   ↓ quota exhausted
       ├─→ [Tier 2: API KEY] DeepSeek, Groq, xAI, Mistral, NVIDIA NIM, etc.
       │   ↓ budget limit
       ├─→ [Tier 3: CHEAP] GLM ($0.6/1M), MiniMax ($0.2/1M)
       │   ↓ budget limit
       └─→ [Tier 4: FREE] iFlow, Qwen, Kiro (unlimited)

Result: Never stop coding, minimal cost
```

---

## 🎯 What OmniRoute Solves — 16 Real Pain Points

> **Every developer using AI tools faces these problems daily.** OmniRoute was built to solve them all — from cost overruns to regional blocks, from broken OAuth flows to zero observability.

<details>
<summary><b>💸 1. "I pay for an expensive subscription but still get interrupted by limits"</b></summary>

Developers pay $20–200/month for Claude Pro, Codex Pro, or GitHub Copilot. Even paying, quota has a ceiling — 5h of usage, weekly limits, or per-minute rate limits. Mid-coding session, the provider stops responding and the developer loses flow and productivity.

**How OmniRoute solves it:**

- **Smart 4-Tier Fallback** — If subscription quota runs out, automatically redirects to API Key → Cheap → Free with zero manual intervention
- **Real-Time Quota Tracking** — Shows token consumption in real-time with reset countdown (5h, daily, weekly)
- **Multi-Account Support** — Multiple accounts per provider with auto round-robin — when one runs out, switches to the next
- **Custom Combos** — Customizable fallback chains with 6 balancing strategies (fill-first, round-robin, P2C, random, least-used, cost-optimized)
- **Codex Business Quotas** — Business/Team workspace quota monitoring directly in the dashboard

</details>

<details>
<summary><b>🔌 2. "I need to use multiple providers but each has a different API"</b></summary>

OpenAI uses one format, Claude (Anthropic) uses another, Gemini yet another. If a dev wants to test models from different providers or fallback between them, they need to reconfigure SDKs, change endpoints, deal with incompatible formats. Custom providers (FriendLI, NIM) have non-standard model endpoints.

**How OmniRoute solves it:**

- **Unified Endpoint** — A single `http://localhost:20128/v1` serves as proxy for all 36+ providers
- **Format Translation** — Automatic and transparent: OpenAI ↔ Claude ↔ Gemini ↔ Responses API
- **Response Sanitization** — Strips non-standard fields (`x_groq`, `usage_breakdown`, `service_tier`) that break OpenAI SDK v1.83+
- **Role Normalization** — Converts `developer` → `system` for non-OpenAI providers; `system` → `user` for GLM/ERNIE
- **Think Tag Extraction** — Extracts `<think>` blocks from models like DeepSeek R1 into standardized `reasoning_content`
- **Structured Output for Gemini** — `json_schema` → `responseMimeType`/`responseSchema` automatic conversion
- **`stream` defaults to `false`** — Aligns with OpenAI spec, avoiding unexpected SSE in Python/Rust/Go SDKs

</details>

<details>
<summary><b>🌐 3. "My AI provider blocks my region/country"</b></summary>

Providers like OpenAI/Codex block access from certain geographic regions. Users get errors like `unsupported_country_region_territory` during OAuth and API connections. This is especially frustrating for developers from developing countries.

**How OmniRoute solves it:**

- **3-Level Proxy Config** — Configurable proxy at 3 levels: global (all traffic), per-provider (one provider only), and per-connection/key
- **Color-Coded Proxy Badges** — Visual indicators: 🟢 global proxy, 🟡 provider proxy, 🔵 connection proxy, always showing the IP
- **OAuth Token Exchange Through Proxy** — OAuth flow also goes through the proxy, solving `unsupported_country_region_territory`
- **Connection Tests via Proxy** — Connection tests use the configured proxy (no more direct bypass)
- **SOCKS5 Support** — Full SOCKS5 proxy support for outbound routing
- **TLS Fingerprint Spoofing** — Browser-like TLS fingerprint via `wreq-js` to bypass bot detection

</details>

<details>
<summary><b>🆓 4. "I want to use AI for coding but I have no money"</b></summary>

Not everyone can pay $20–200/month for AI subscriptions. Students, devs from emerging countries, hobbyists, and freelancers need access to quality models at zero cost.

**How OmniRoute solves it:**

- **Free Tier Providers Built-in** — Native support for 100% free providers: iFlow (8 unlimited models), Qwen (3 unlimited models), Kiro (Claude for free), Gemini CLI (180K/month free)
- **Free-Only Combos** — Chain `gc/gemini-3-flash → if/kimi-k2-thinking → qw/qwen3-coder-plus` = $0/month with zero downtime
- **NVIDIA NIM Free Credits** — 1000 free credits integrated
- **Cost Optimized Strategy** — Routing strategy that automatically chooses the cheapest available provider

</details>

<details>
<summary><b>🔒 5. "I need to protect my AI gateway from unauthorized access"</b></summary>

When exposing an AI gateway to the network (LAN, VPS, Docker), anyone with the address can consume the developer's tokens/quota. Without protection, APIs are vulnerable to misuse, prompt injection, and abuse.

**How OmniRoute solves it:**

- **API Key Management** — Generation, rotation, and scoping per provider with a dedicated `/dashboard/api-manager` page
- **Model-Level Permissions** — Restrict API keys to specific models (`openai/*`, wildcard patterns), with Allow All/Restrict toggle
- **API Endpoint Protection** — Require a key for `/v1/models` and block specific providers from the listing
- **Auth Guard + CSRF Protection** — All dashboard routes protected with `withAuth` middleware + CSRF tokens
- **Rate Limiter** — Per-IP rate limiting with configurable windows
- **IP Filtering** — Allowlist/blocklist for access control
- **Prompt Injection Guard** — Sanitization against malicious prompt patterns
- **AES-256-GCM Encryption** — Credentials encrypted at rest

</details>

<details>
<summary><b>🛑 6. "My provider went down and I lost my coding flow"</b></summary>

AI providers can become unstable, return 5xx errors, or hit temporary rate limits. If a dev depends on a single provider, they're interrupted. Without circuit breakers, repeated retries can crash the application.

**How OmniRoute solves it:**

- **Circuit Breaker per-provider** — Auto-open/close with configurable thresholds and cooldown (Closed/Open/Half-Open)
- **Exponential Backoff** — Progressive retry delays
- **Anti-Thundering Herd** — Mutex + semaphore protection against concurrent retry storms
- **Combo Fallback Chains** — If the primary provider fails, automatically falls through the chain with no intervention
- **Combo Circuit Breaker** — Auto-disables failing providers within a combo chain
- **Health Dashboard** — Uptime monitoring, circuit breaker states, lockouts, cache stats, p50/p95/p99 latency

</details>

<details>
<summary><b>🔧 7. "Configuring each AI tool is tedious and repetitive"</b></summary>

Developers use Cursor, Claude Code, Codex CLI, OpenClaw, Gemini CLI, Kilo Code... Each tool needs a different config (API endpoint, key, model). Reconfiguring when switching providers or models is a waste of time.

**How OmniRoute solves it:**

- **CLI Tools Dashboard** — Dedicated page with one-click setup for Claude Code, Codex CLI, OpenClaw, Kilo Code, Antigravity, Cline
- **GitHub Copilot Config Generator** — Generates `chatLanguageModels.json` for VS Code with bulk model selection
- **Onboarding Wizard** — Guided 4-step setup for first-time users
- **One endpoint, all models** — Configure `http://localhost:20128/v1` once, access 36+ providers

</details>

<details>
<summary><b>🔑 8. "Managing OAuth tokens from multiple providers is hell"</b></summary>

Claude Code, Codex, Gemini CLI, Copilot — all use OAuth 2.0 with expiring tokens. Developers need to re-authenticate constantly, deal with `client_secret is missing`, `redirect_uri_mismatch`, and failures on remote servers. OAuth on LAN/VPS is particularly problematic.

**How OmniRoute solves it:**

- **Auto Token Refresh** — OAuth tokens refresh in background before expiration
- **OAuth 2.0 (PKCE) Built-in** — Automatic flow for Claude Code, Codex, Gemini CLI, Copilot, Kiro, Qwen, iFlow
- **Multi-Account OAuth** — Multiple accounts per provider via JWT/ID token extraction
- **OAuth LAN/Remote Fix** — Private IP detection for `redirect_uri` + manual URL mode for remote servers
- **OAuth Behind Nginx** — Uses `window.location.origin` for reverse proxy compatibility
- **Remote OAuth Guide** — Step-by-step guide for Google Cloud credentials on VPS/Docker

</details>

<details>
<summary><b>📊 9. "I don't know how much I'm spending or where"</b></summary>

Developers use multiple paid providers but have no unified view of spending. Each provider has its own billing dashboard, but there's no consolidated view. Unexpected costs can pile up.

**How OmniRoute solves it:**

- **Cost Analytics Dashboard** — Per-token cost tracking and budget management per provider
- **Budget Limits per Tier** — Spending ceiling per tier that triggers automatic fallback
- **Per-Model Pricing Configuration** — Configurable prices per model
- **Usage Statistics Per API Key** — Request count and last-used timestamp per key
- **Analytics Dashboard** — Stat cards, model usage chart, provider table with success rates and latency

</details>

<details>
<summary><b>🐛 10. "I can't diagnose errors and problems in AI calls"</b></summary>

When a call fails, the dev doesn't know if it was a rate limit, expired token, wrong format, or provider error. Fragmented logs across different terminals. Without observability, debugging is trial-and-error.

**How OmniRoute solves it:**

- **Unified Logs Dashboard** — 4 tabs: Request Logs, Proxy Logs, Audit Logs, Console
- **Console Log Viewer** — Real-time terminal-style viewer with color-coded levels, auto-scroll, search, filter
- **SQLite Proxy Logs** — Persistent logs that survive server restarts
- **Translator Playground** — 4 debugging modes: Playground (format translation), Chat Tester (round-trip), Test Bench (batch), Live Monitor (real-time)
- **Request Telemetry** — p50/p95/p99 latency + X-Request-Id tracing
- **File-Based Logging with Rotation** — Console interceptor captures everything to JSON log with size-based rotation

</details>

<details>
<summary><b>🏗️ 11. "Deploying and maintaining the gateway is complex"</b></summary>

Installing, configuring, and maintaining an AI proxy across different environments (local, VPS, Docker, cloud) is labor-intensive. Problems like hardcoded paths, `EACCES` on directories, port conflicts, and cross-platform builds add friction.

**How OmniRoute solves it:**

- **npm global install** — `npm install -g omniroute && omniroute` — done
- **Docker Multi-Platform** — AMD64 + ARM64 native (Apple Silicon, AWS Graviton, Raspberry Pi)
- **Docker Compose Profiles** — `base` (no CLI tools) and `cli` (with Claude Code, Codex, OpenClaw)
- **Electron Desktop App** — Native app for Windows/macOS/Linux with system tray, auto-start, offline mode
- **Split-Port Mode** — API and Dashboard on separate ports for advanced scenarios (reverse proxy, container networking)
- **Cloud Sync** — Config synchronization across devices via Cloudflare Workers
- **DB Backups** — Automatic backup, restore, export and import of all settings

</details>

<details>
<summary><b>🌍 12. "The interface is English-only and my team doesn't speak English"</b></summary>

Teams in non-English-speaking countries, especially in Latin America, Asia, and Europe, struggle with English-only interfaces. Language barriers reduce adoption and increase configuration errors.

**How OmniRoute solves it:**

- **Dashboard i18n — 30 Languages** — All 500+ keys translated including Arabic, Bulgarian, Danish, German, Spanish, Finnish, French, Hebrew, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Malay, Dutch, Norwegian, Polish, Portuguese (PT/BR), Romanian, Russian, Slovak, Swedish, Thai, Ukrainian, Vietnamese, Chinese, Filipino, English
- **RTL Support** — Right-to-left support for Arabic and Hebrew
- **Multi-Language READMEs** — 30 complete documentation translations
- **Language Selector** — Globe icon in header for real-time switching

</details>

<details>
<summary><b>🔄 13. "I need more than chat — I need embeddings, images, audio"</b></summary>

AI isn't just chat completion. Devs need to generate images, transcribe audio, create embeddings for RAG, rerank documents, and moderate content. Each API has a different endpoint and format.

**How OmniRoute solves it:**

- **Embeddings** — `/v1/embeddings` with 6 providers and 9+ models
- **Image Generation** — `/v1/images/generations` with 4 providers and 9+ models
- **Audio Transcription** — `/v1/audio/transcriptions` — Whisper-compatible
- **Text-to-Speech** — `/v1/audio/speech` — Multi-provider audio synthesis
- **Moderations** — `/v1/moderations` — Content safety checks
- **Reranking** — `/v1/rerank` — Document relevance reranking
- **Responses API** — Full `/v1/responses` support for Codex

</details>

<details>
<summary><b>🧪 14. "I have no way to test and compare quality across models"</b></summary>

Developers want to know which model is best for their use case — code, translation, reasoning — but comparing manually is slow. No integrated eval tools exist.

**How OmniRoute solves it:**

- **LLM Evaluations** — Golden set testing with 10 pre-loaded cases covering greetings, math, geography, code generation, JSON compliance, translation, markdown, safety refusal
- **4 Match Strategies** — `exact`, `contains`, `regex`, `custom` (JS function)
- **Translator Playground Test Bench** — Batch testing with multiple inputs and expected outputs, cross-provider comparison
- **Chat Tester** — Full round-trip with visual response rendering
- **Live Monitor** — Real-time stream of all requests flowing through the proxy

</details>

<details>
<summary><b>📈 15. "I need to scale without losing performance"</b></summary>

As request volume grows, without caching the same questions generate duplicate costs. Without idempotency, duplicate requests waste processing. Per-provider rate limits must be respected.

**How OmniRoute solves it:**

- **Semantic Cache** — Two-tier cache (signature + semantic) reduces cost and latency
- **Request Idempotency** — 5s deduplication window for identical requests
- **Rate Limit Detection** — Per-provider RPM, min gap, and max concurrent tracking
- **Editable Rate Limits** — Configurable defaults in Settings → Resilience with persistence
- **API Key Validation Cache** — 3-tier cache for production performance
- **Health Dashboard with Telemetry** — p50/p95/p99 latency, cache stats, uptime

</details>

<details>
<summary><b>🤖 16. "I want to control model behavior globally"</b></summary>

Developers who want all responses in a specific language, with a specific tone, or want to limit reasoning tokens. Configuring this in every tool/request is impractical.

**How OmniRoute solves it:**

- **System Prompt Injection** — Global prompt applied to all requests
- **Thinking Budget Validation** — Reasoning token allocation control per request (passthrough, auto, custom, adaptive)
- **6 Routing Strategies** — Global strategies that determine how requests are distributed
- **Wildcard Router** — `provider/*` patterns route dynamically to any provider
- **Combo Enable/Disable Toggle** — Toggle combos directly from the dashboard
- **Provider Toggle** — Enable/disable all connections for a provider with one click
- **Blocked Providers** — Exclude specific providers from `/v1/models` listing

</details>

## ⚡ Швидкий старт

**1. Встановити глобально:**

```bash
npm install -g omniroute
omniroute
```

🎉 Інформаційна панель відкривається в `http://localhost:20128`

| Команда                 | Опис                                           |
| ----------------------- | ---------------------------------------------- |
| `omniroute`             | Запустити сервер (порт за замовчуванням 20128) |
| `omniroute --port 3000` | Використовувати спеціальний порт               |
| `omniroute --no-open`   | Не відкривати автоматично браузер              |
| `omniroute --help`      | Показати довідку                               |

**2. Підключіть БЕЗКОШТОВНОГО провайдера:**

Інформаційна панель → Постачальники → Підключити **Claude Code** або **Antigravity** → Вхід OAuth → Готово!

**3. Використовуйте у своєму інструменті CLI:**

```
Claude Code/Codex/Gemini CLI/OpenClaw/Cursor/Cline Settings:
  Endpoint: http://localhost:20128/v1
  API Key: [copy from dashboard]
  Model: if/kimi-k2-thinking
```

**Ось і все!** Почніть кодувати з БЕЗКОШТОВНИМИ моделями ШІ.

**Альтернатива — запустити з джерела:**

```bash
cp .env.example .env
npm install
PORT=20128 NEXT_PUBLIC_BASE_URL=http://localhost:20128 npm run dev
```

---

## 🐳 Докер

OmniRoute доступний як загальнодоступний образ Docker на [Docker Hub](https://hub.docker.com/r/diegosouzapw/omniroute).

**Швидкий біг:**

```bash
docker run -d \
  --name omniroute \
  --restart unless-stopped \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest
```

**З файлом середовища:**

```bash
# Copy and edit .env first
cp .env.example .env

docker run -d \
  --name omniroute \
  --restart unless-stopped \
  --env-file .env \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest
```

**Використання Docker Compose:**

```bash
# Base profile (no CLI tools)
docker compose --profile base up -d

# CLI profile (Claude Code, Codex, OpenClaw built-in)
docker compose --profile cli up -d
```

| Зображення               | Тег      | Розмір  | Опис                       |
| ------------------------ | -------- | ------- | -------------------------- |
| `diegosouzapw/omniroute` | `latest` | ~250 МБ | Останній стабільний випуск |
| `diegosouzapw/omniroute` | `1.0.3`  | ~250 МБ | Поточна версія             |

---

---

## 🖥️ Desktop App — Offline & Always-On

> 🆕 **NEW!** OmniRoute is now available as a **native desktop application** for Windows, macOS, and Linux.

- 🖥️ **Native Window** — Dedicated app window with system tray integration
- 🔄 **Auto-Start** — Launch OmniRoute on system login
- 🔔 **Native Notifications** — Get alerts for quota exhaustion or provider issues
- ⚡ **One-Click Install** — NSIS (Windows), DMG (macOS), AppImage (Linux)
- 🌐 **Offline Mode** — Works fully offline with bundled server

```bash
npm run electron:dev           # Development mode
npm run electron:build         # Current platform
npm run electron:build:win     # Windows (.exe)
npm run electron:build:mac     # macOS (.dmg)
npm run electron:build:linux   # Linux (.AppImage)
```

📖 Full documentation: [`electron/README.md`](electron/README.md)

---

## 💰 Короткий огляд цін

| Рівень             | Постачальник     | Вартість                        | Скидання квоти                | Найкраще для                 |
| ------------------ | ---------------- | ------------------------------- | ----------------------------- | ---------------------------- |
| **💳 ПІДПИСКА**    | Клод Код (Pro)   | 20 доларів США на місяць        | 5 годин + щотижня             | Вже підписані                |
|                    | Codex (Plus/Pro) | $20-200/міс                     | 5 годин + щотижня             | Користувачі OpenAI           |
|                    | Gemini CLI       | **БЕЗКОШТОВНО**                 | 180 тис./місяць + 1 тис./день | всі!                         |
|                    | Копілот GitHub   | $10-19/міс                      | Щомісяця                      | Користувачі GitHub           |
| **🔑 КЛЮЧ API**    | NVIDIA NIM       | **БЕЗКОШТОВНО** (1000 кредитів) | Одноразова                    | Безкоштовне тестування рівня |
|                    | DeepSeek         | Оплата за використання          | Жодного                       | Краща ціна/якість            |
|                    | Groq             | Безкоштовний рівень + платний   | Оцінка обмежена               | Надшвидкий висновок          |
|                    | xAI (Грок)       | Оплата за використання          | Жодного                       | Моделі Grok                  |
|                    | Містраль         | Безкоштовний рівень + платний   | Оцінка обмежена               | Європейський ШІ              |
|                    | OpenRouter       | Оплата за використання          | Жодного                       | 100+ моделей                 |
| **💰 ДЕШЕВО**      | GLM-4.7          | $0,6/1 млн                      | Щодня о 10 ранку              | Резервне копіювання бюджету  |
|                    | MiniMax M2.1     | $0,2/1 млн                      | 5-годинний роликовий          | Найдешевший варіант          |
|                    | Кімі К2          | 9 $/міс квартира                | 10 млн токенів/міс            | Передбачувана вартість       |
| **🆓 БЕЗКОШТОВНО** | iFlow            | $0                              | Необмежений                   | 8 моделей безкоштовно        |
|                    | Квен             | $0                              | Необмежений                   | 3 моделі безкоштовно         |
|                    | Кіро             | $0                              | Необмежений                   | Клод безкоштовно             |

**💡 Порада професіонала:** Почніть із Gemini CLI (180 тис. безкоштовно/місяць) + iFlow (необмежено безкоштовно) = 0 доларів США!

---

## 💡 Основні характеристики

### 🧠 Основна маршрутизація та інтелект

| Особливість                                  | Що він робить                                                                                                    |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| 🎯 **Розумний 4-рівневий резервний варіант** | Авто-маршрут: Підписка → Ключ API → Дешево → Безкоштовно                                                         |
| 📊 **Відстеження квот у реальному часі**     | Підрахунок живих токенів + скидання зворотного відліку для кожного постачальника                                 |
| 🔄 **Формат перекладу**                      | OpenAI ↔ Claude ↔ Gemini ↔ Cursor ↔ Kiro seamless + відповідь санація                                            |
| 👥 **Підтримка кількох облікових записів**   | Кілька облікових записів на постачальника з інтелектуальним вибором                                              |
| 🔄 **Автоматичне оновлення токенів**         | Маркери OAuth оновлюються автоматично з повторною спробою                                                        |
| 🎨 **Користувацькі комбо**                   | 6 стратегій: спочатку заповнює, циклічний, p2c, випадковий, найменш використовуваний, оптимізований за витратами |
| 🧩 **Користувацькі моделі**                  | Додайте будь-який ідентифікатор моделі до будь-якого постачальника                                               |
| 🌐 **Wildcard Router**                       | Динамічно направляйте шаблони `provider/*` до будь-якого постачальника                                           |
| 🧠 **Мислення про бюджет**                   | Наскрізний, автоматичний, настроюваний і адаптивний режими для моделей міркування                                |
| 💬 **Швидке впровадження системи**           | Глобальне системне підказка застосовується до всіх запитів                                                       |
| 📄 **API відповідей**                        | Повна підтримка OpenAI Responses API (`/v1/responses`) для Codex                                                 |

### 🎵 Мультимодальні API

| Особливість                        | Що він робить                                         |
| ---------------------------------- | ----------------------------------------------------- |
| 🖼️ **Створення зображень**         | `/v1/images/generations` — 4 провайдери, 9+ моделей   |
| 📐 **Вбудовування**                | `/v1/embeddings` — 6 провайдерів, 9+ моделей          |
| 🎤 **Транскрипція аудіо**          | `/v1/audio/transcriptions` — сумісний із Whisper      |
| 🔊 **Створення тексту в мовлення** | `/v1/audio/speech` — Багатопровайдерний аудіосинтез   |
| 🛡️ **Модерації**                   | `/v1/moderations` — Перевірка безпеки вмісту          |
| 🔀 **Переранжування**              | `/v1/rerank` — Переранжування релевантності документа |

### 🛡️ Стійкість і безпека

| Особливість                           | Що він робить                                                                                         |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| 🔌 **Автоматичний вимикач**           | Автоматичне відкриття/закриття для кожного постачальника з настроюваними пороговими значеннями        |
| 🛡️ **Anti-Thundering Herd**           | Mutex + обмеження швидкості семафора для постачальників ключів API                                    |
| 🧠 **Семантичний кеш**                | Дворівневий кеш (підпис + семантика) зменшує вартість і затримку                                      |
| ⚡ **Запит на ідемпотентність**       | 5-секундне вікно дедупляції для дублікатів запитів                                                    |
| 🔒 **Підробка відбитків пальців TLS** | Обійти виявлення ботів на основі TLS через wreq-js                                                    |
| 🌐 **IP-фільтрація**                  | Білий/чорний список для керування доступом API                                                        |
| 📊 **Редаговані ліміти ставок**       | Конфігурація RPM, мінімальний проміжок і максимальна одночасність на рівні системи                    |
| 🛡 **API Endpoint Protection**        | Аутентифікація + блокування постачальника для кінцевої точки `/models`                                |
| 🔒 **Видимість проксі**               | Кольорові значки: 🟢 глобальний, 🟡 постачальник, 🔵 кожне підключення з відображенням IP             |
| 🌐 **3-рівнева конфігурація проксі**  | Налаштуйте проксі-сервери на глобальному рівні, на рівні кожного постачальника чи кожного підключення |

### 📊 Спостережливість і аналітика

| Особливість                          | Що він робить                                                                                                |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| 📝 **Подати запит на реєстрацію**    | Режим налагодження з повними журналами запитів/відповідей                                                    |
| 💾 **Журнали проксі SQLite**         | Постійні журнали проксі зберігаються після перезавантаження сервера                                          |
| 📊 **Інформаційна панель аналітики** | На основі Recharts: картки статистики, діаграма використання моделей, таблиця провайдерів                    |
| 📈 **Відстеження прогресу**          | Увімкніть події прогресу SSE для потокового передавання                                                      |
| 🧪 **Оцінки LLM**                    | Тестування золотого набору з 4 стратегіями матчу                                                             |
| 🔍 **Надіслати запит на телеметрію** | агрегація затримок p50/p95/p99 + трасування X-Request-Id                                                     |
| 📋 **Інформаційна панель журналів**  | Уніфікована сторінка з 4 вкладками: журнали запитів, журнали проксі, журнали аудиту, консоль                 |
| 🖥️ **Перегляд журналу консолі**      | Переглядач у режимі реального часу у стилі терміналу з фільтром рівнів, пошуком, автоматичним прокручуванням |
| 📑 **Логування на основі файлів**    | Перехоплювач консолі захоплює весь вихід у файл журналу JSON із обертанням                                   |
| 🏥 **Інформаційна панель здоров’я**  | Час роботи системи, стани автоматичного вимикача, блокування, статистика кешу                                |
| 💰 **Відстеження витрат**            | Управління бюджетом + конфігурація ціноутворення для кожної моделі                                           |

### ☁️ Розгортання та синхронізація

| Особливість                                 | Що він робить                                                                       |
| ------------------------------------------- | ----------------------------------------------------------------------------------- |
| 💾 **Хмарна синхронізація**                 | Синхронізація конфігурації між пристроями через Cloudflare Workers                  |
| 🌐 **Розгортайте будь-де**                  | Localhost, VPS, Docker, Cloudflare Workers                                          |
| 🔑 **Керування ключами API**                | Генерувати, обертати та використовувати ключі API для кожного постачальника         |
| 🧙 **Майстер адаптації**                    | 4-етапне покрокове налаштування для користувачів, які вперше                        |
| 🔧 **Інформаційна панель інструментів CLI** | Налаштувати в один клік Claude, Codex, Cline, OpenClaw, Kilo, Antigravity           |
| 🔄 **Резервне копіювання БД**               | Автоматичне резервне копіювання, відновлення, експорт і імпорт для всіх налаштувань |
| 🌐 **Інтернаціоналізація**                  | Повний i18n із next-intl — підтримка англійської та португальської (Бразилія)       |
| 🌍 **Вибір мови**                           | Значок глобуса в заголовку для перемикання мов у реальному часі (🇺🇸/🇧🇷)             |
| 📂 **Каталог користувацьких даних**         | `DATA_DIR` змінна env для перевизначення типового шляху зберігання `~/.omniroute`   |

<details>
<summary><b>📖 Деталі функції</b></summary>

### 🎯 Smart 4-Tier Fallback

Створюйте комбо з автоматичним резервним варіантом:

```
Combo: "my-coding-stack"
  1. cc/claude-opus-4-6        (your subscription)
  2. nvidia/llama-3.3-70b      (free NVIDIA API)
  3. glm/glm-4.7               (cheap backup, $0.6/1M)
  4. if/kimi-k2-thinking       (free fallback)

→ Auto switches when quota runs out or errors occur
```

### 📊 Відстеження квот у реальному часі

- Споживання токенів на постачальника
- Скидання зворотного відліку (5 годин, щодня, щотижня)
- Оцінка вартості платних рівнів
- Щомісячні звіти про витрати

### 🔄 Переклад формату

Плавний переклад між форматами:

- **OpenAI** ↔ **Клод** ↔ **Близнюки** ↔ **Відповіді OpenAI**
- Ваш інструмент CLI надсилає формат OpenAI → OmniRoute перекладає → Постачальник отримує рідний формат
- Працює з будь-яким інструментом, який підтримує спеціальні кінцеві точки OpenAI
- **Дезінфікація відповіді** — видаляє нестандартні поля для суворої сумісності з OpenAI SDK
- **Нормалізація ролі** — `developer` → `system` для не-OpenAI; `system` → `user` для моделей GLM/ERNIE
- **Вилучення тегів мислення** — `<think>` блоків → `reasoning_content` для моделей мислення
- **Структурований вихід** — `json_schema` → Gemini `responseMimeType`/`responseSchema`

### 👥 Підтримка кількох облікових записів

- Додайте кілька облікових записів для кожного постачальника
- Автоматична циклічна або пріоритетна маршрутизація
- Повернення до наступного облікового запису, коли досягається квота

### 🔄 Автоматичне оновлення токенів

- Маркери OAuth автоматично оновлюються до закінчення терміну дії
- Повторна автентифікація вручну не потрібна
- Бездоганний досвід у всіх постачальників

### 🎨 Спеціальні комбо

- Створюйте необмежену кількість комбінацій моделей
- 6 стратегій: спочатку заповнюй, циклічна, сила двох варіантів, випадкова, найменш використовувана, оптимізована за витратами
- Діліться комбо на різних пристроях за допомогою Cloud Sync

### 🏥 Інформаційна панель здоров'я

- Статус системи (час роботи, версія, використання пам'яті)
- Стани автоматичного вимикача для кожного постачальника (замкнуто/розімкнуто/напіврозімкнуто)
- Статус обмеження швидкості та активні блокування
  — Статистика кешу підписів
- Телеметрія затримки (p50/p95/p99) + кеш підказок
- Скинути стан здоров'я одним клацанням миші

### 🔧 Ігровий майданчик для перекладачів

OmniRoute містить потужний вбудований Translator Playground із **4 режимами** для налагодження, тестування та моніторингу перекладів API:

| Режим                    | Опис                                                                                                                                                                                                                                                |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **💻 Ігровий майданчик** | Прямий переклад формату — вставте будь-яке тіло запиту API та миттєво подивіться, як OmniRoute перекладає його між форматами постачальників (OpenAI ↔ Claude ↔ Gemini ↔ Responses API). Включає приклади шаблонів і автоматичне визначення формату. |
| **💬 Тестер чату**       | Надсилайте справжні запити в чат через OmniRoute і переглядайте повну інформацію: ваші дані, перекладений запит, відповідь постачальника та перекладену відповідь. Безцінний для перевірки комбінованої маршрутизації.                              |
| **🧪 Тестовий стенд**    | Режим пакетного тестування — визначте кілька тестів із різними вхідними та очікуваними результатами, запустіть їх усі одночасно та порівняйте результати між постачальниками та моделями.                                                           |
| **📱 Live Monitor**      | Моніторинг запитів у режимі реального часу — спостерігайте за вхідними запитами, коли вони проходять через OmniRoute, переглядайте трансляції форматів у реальному часі та миттєво виявляйте проблеми.                                              |

**Доступ:** Інформаційна панель → Перекладач (бічна панель)

### 💾 Cloud Sync

- Синхронізація постачальників, комбінацій і налаштувань на всіх пристроях
- Автоматична фонова синхронізація
- Безпечне зашифроване сховище

</details>

---

## 🎯 Випадки використання

### Випадок 1: «У мене є підписка на Claude Pro»

**Проблема:** Квота закінчується невикористаною, обмеження швидкості під час інтенсивного кодування

```
Combo: "maximize-claude"
  1. cc/claude-opus-4-6        (use subscription fully)
  2. glm/glm-4.7               (cheap backup when quota out)
  3. if/kimi-k2-thinking       (free emergency fallback)

Monthly cost: $20 (subscription) + ~$5 (backup) = $25 total
vs. $20 + hitting limits = frustration
```

### Випадок 2: "Я хочу нульову вартість"

**Проблема:** не можу дозволити собі підписку, потрібне надійне кодування ШІ

```
Combo: "free-forever"
  1. gc/gemini-3-flash         (180K free/month)
  2. if/kimi-k2-thinking       (unlimited free)
  3. qw/qwen3-coder-plus       (unlimited free)

Monthly cost: $0
Quality: Production-ready models
```

### Випадок 3: «Мені потрібне кодування 24/7, без перерв»

**Проблема:** Дедлайни, не можу дозволити собі простою

```
Combo: "always-on"
  1. cc/claude-opus-4-6        (best quality)
  2. cx/gpt-5.2-codex          (second subscription)
  3. glm/glm-4.7               (cheap, resets daily)
  4. minimax/MiniMax-M2.1      (cheapest, 5h reset)
  5. if/kimi-k2-thinking       (free unlimited)

Result: 5 layers of fallback = zero downtime
```

### Випадок 4: «Я хочу БЕЗКОШТОВНОГО ШІ в OpenClaw»

**Проблема:** потрібен помічник штучного інтелекту в програмах для обміну повідомленнями, повністю безкоштовний

```
Combo: "openclaw-free"
  1. if/glm-4.7                (unlimited free)
  2. if/minimax-m2.1           (unlimited free)
  3. if/kimi-k2-thinking       (unlimited free)

Monthly cost: $0
Access via: WhatsApp, Telegram, Slack, Discord, iMessage, Signal...
```

---

## 📖 Посібник із налаштування

<details>
<summary><b>💳 Постачальники підписки</b></summary>

### Claude Code (Pro/Max)

```bash
Dashboard → Providers → Connect Claude Code
→ OAuth login → Auto token refresh
→ 5-hour + weekly quota tracking

Models:
  cc/claude-opus-4-6
  cc/claude-sonnet-4-5-20250929
  cc/claude-haiku-4-5-20251001
```

**Професійна порада:** використовуйте Opus для складних завдань, Sonnet для швидкості. OmniRoute відстежує квоту на модель!

### OpenAI Codex (Plus/Pro)

```bash
Dashboard → Providers → Connect Codex
→ OAuth login (port 1455)
→ 5-hour + weekly reset

Models:
  cx/gpt-5.2-codex
  cx/gpt-5.1-codex-max
```

### Gemini CLI (БЕЗКОШТОВНО 180K/місяць!)

```bash
Dashboard → Providers → Connect Gemini CLI
→ Google OAuth
→ 180K completions/month + 1K/day

Models:
  gc/gemini-3-flash-preview
  gc/gemini-2.5-pro
```

**Найкраще:** Величезний безкоштовний рівень! Використовуйте це перед платними рівнями.

### Копілот GitHub

```bash
Dashboard → Providers → Connect GitHub
→ OAuth via GitHub
→ Monthly reset (1st of month)

Models:
  gh/gpt-5
  gh/claude-4.5-sonnet
  gh/gemini-3-pro
```

</details>

<details>
<summary><b>🔑 Постачальники ключів API</b></summary>

### NVIDIA NIM (БЕЗКОШТОВНІ 1000 кредитів!)

1. Зареєструйтесь: [build.nvidia.com](https://build.nvidia.com)
2. Отримайте безкоштовний ключ API (1000 кредитів включено)
3. Інформаційна панель → Додати постачальника → NVIDIA NIM:
   - Ключ API: `nvapi-your-key`

**Моделі:** `nvidia/llama-3.3-70b-instruct`, `nvidia/mistral-7b-instruct` та понад 50 інших

**Порада професіонала:** OpenAI-сумісний API — бездоганно працює з перекладом формату OmniRoute!

### DeepSeek

1. Зареєструйтеся: [platform.deepseek.com](https://platform.deepseek.com)
2. Отримайте ключ API
3. Інформаційна панель → Додати постачальника → DeepSeek

**Моделі:** `deepseek/deepseek-chat`, `deepseek/deepseek-coder`

### Groq (доступний безкоштовний рівень!)

1. Зареєструйтеся: [console.groq.com](https://console.groq.com)
2. Отримайте ключ API (включає безкоштовний рівень)
3. Інформаційна панель → Додати постачальника → Groq

**Моделі:** `groq/llama-3.3-70b`, `groq/mixtral-8x7b`

**Професійна порада:** Надшвидкий висновок — найкращий для кодування в реальному часі!

### OpenRouter (100+ моделей)

1. Зареєструйтеся: [openrouter.ai](https://openrouter.ai)
2. Отримайте ключ API
3. Інформаційна панель → Додати провайдера → OpenRouter

**Моделі:** Отримуйте доступ до понад 100 моделей від усіх основних постачальників за допомогою єдиного ключа API.

</details>

<details>
<summary><b>💰 Дешеві постачальники (резервні)</b></summary>

### GLM-4.7 (щоденне скидання, $0,6/1 млн)

1. Зареєструйтеся: [Zhipu AI](https://open.bigmodel.cn/)
2. Отримайте ключ API від Coding Plan
3. Інформаційна панель → Додати ключ API:
   - Постачальник: `glm`
   - Ключ API: `your-key`

**Використовуйте:** `glm/glm-4.7`

**Професійна порада:** План кодування пропонує 3x квоту за 1/7 вартості! Скидання щодня о 10:00.

### MiniMax M2.1 (5 годин скидання, $0,20/1 млн)

1. Зареєструйтеся: [MiniMax](https://www.minimax.io/)
2. Отримайте ключ API
3. Інформаційна панель → Додати ключ API

**Використовуйте:** `minimax/MiniMax-M2.1`

**Порада:** Найдешевший варіант для довгого контексту (1 млн токенів)!

### Kimi K2 ($9/місяць)

1. Підпишіться: [Moonshot AI](https://platform.moonshot.ai/)
2. Отримайте ключ API
3. Інформаційна панель → Додати ключ API

**Використання:** `kimi/kimi-latest`

**Професійна порада:** Фіксовані 9 доларів США на місяць за 10 мільйонів токенів = 0,90 доларів США за 1 млн. ефективних витрат!

</details>

<details>
<summary><b>🆓 БЕЗКОШТОВНІ постачальники (аварійне резервне копіювання)</b></summary>

### iFlow (8 БЕЗКОШТОВНИХ моделей)

```bash
Dashboard → Connect iFlow
→ iFlow OAuth login
→ Unlimited usage

Models:
  if/kimi-k2-thinking
  if/qwen3-coder-plus
  if/glm-4.7
  if/minimax-m2
  if/deepseek-r1
```

### Qwen (3 БЕЗКОШТОВНІ моделі)

```bash
Dashboard → Connect Qwen
→ Device code authorization
→ Unlimited usage

Models:
  qw/qwen3-coder-plus
  qw/qwen3-coder-flash
```

### Кіро (Клод БЕЗКОШТОВНО)

```bash
Dashboard → Connect Kiro
→ AWS Builder ID or Google/GitHub
→ Unlimited usage

Models:
  kr/claude-sonnet-4.5
  kr/claude-haiku-4.5
```

</details>

<details>
<summary><b>🎨 Створення комбо</b></summary>

### Приклад 1: максимізація підписки → дешеве резервне копіювання

```
Dashboard → Combos → Create New

Name: premium-coding
Models:
  1. cc/claude-opus-4-6 (Subscription primary)
  2. glm/glm-4.7 (Cheap backup, $0.6/1M)
  3. minimax/MiniMax-M2.1 (Cheapest fallback, $0.20/1M)

Use in CLI: premium-coding
```

### Приклад 2: лише безкоштовно (нульова вартість)

```
Name: free-combo
Models:
  1. gc/gemini-3-flash-preview (180K free/month)
  2. if/kimi-k2-thinking (unlimited)
  3. qw/qwen3-coder-plus (unlimited)

Cost: $0 forever!
```

</details>

<details>
<summary><b>🔧 Інтеграція CLI</b></summary>

### Курсор IDE

```
Settings → Models → Advanced:
  OpenAI API Base URL: http://localhost:20128/v1
  OpenAI API Key: [from OmniRoute dashboard]
  Model: cc/claude-opus-4-6
```

### Клод Код

Використовуйте сторінку **Інструменти CLI** на інформаційній панелі для налаштування одним клацанням миші або редагуйте `~/.claude/settings.json` вручну.

### Codex CLI

```bash
export OPENAI_BASE_URL="http://localhost:20128"
export OPENAI_API_KEY="your-omniroute-api-key"

codex "your prompt"
```

### OpenClaw

**Варіант 1 — Інформаційна панель (рекомендовано):**

```
Dashboard → CLI Tools → OpenClaw → Select Model → Apply
```

**Варіант 2 — вручну:** Редагувати `~/.openclaw/openclaw.json`:

```json
{
  "models": {
    "providers": {
      "omniroute": {
        "baseUrl": "http://127.0.0.1:20128/v1",
        "apiKey": "sk_omniroute",
        "api": "openai-completions"
      }
    }
  }
}
```

> **Примітка:** OpenClaw працює лише з локальним OmniRoute. Використовуйте `127.0.0.1` замість `localhost`, щоб уникнути проблем із вирішенням IPv6.

### Cline / Продовжити / RooCode

```
Settings → API Configuration:
  Provider: OpenAI Compatible
  Base URL: http://localhost:20128/v1
  API Key: [from OmniRoute dashboard]
  Model: if/kimi-k2-thinking
```

</details>

---

## 🧪 Оцінки (Evals)

OmniRoute містить вбудовану систему оцінювання для перевірки якості відповіді LLM на відповідність золотому набору. Доступ до нього через **Аналітика → Оцінки** на інформаційній панелі.

### Вбудований Золотий набір

Попередньо завантажений "Золотий набір OmniRoute" містить 10 тестів, які охоплюють:

- Привітання, математика, географія, генерація коду
- Відповідність формату JSON, переклад, розмітка
- Відмова безпеки (шкідливий контент), підрахунок, булева логіка

### Стратегії оцінювання

| Стратегія  | Опис                                                           | Приклад                          |
| ---------- | -------------------------------------------------------------- | -------------------------------- |
| `exact`    | Вихідні дані повинні точно відповідати                         | `"4"`                            |
| `contains` | Вихідні дані повинні містити підрядок (незалежно від регістру) | `"Paris"`                        |
| `regex`    | Вихідні дані мають відповідати шаблону регулярного виразу      | `"1.*2.*3"`                      |
| `custom`   | Спеціальна функція JS повертає true/false                      | `(output) => output.length > 10` |

---

## 🐛 Усунення несправностей

<details>
<summary><b>Натисніть, щоб розгорнути посібник з усунення несправностей</b></summary>

**"Мовна модель не надавала повідомлень"**

- Квота постачальника вичерпана → Перевірте систему відстеження квот на інформаційній панелі
- Рішення: скористайтеся комбінованим альтернативним варіантом або перейдіть на дешевший рівень

**Обмеження швидкості**

— Вичерпана квота на підписку → Повернення до GLM/MiniMax

- Додати комбо: `cc/claude-opus-4-6 → glm/glm-4.7 → if/kimi-k2-thinking`

**Термін дії маркера OAuth минув**

— Автоматично оновлено OmniRoute

- Якщо проблеми не зникають: Інформаційна панель → Постачальник → Повторне підключення

**Високі витрати**

- Перевірте статистику використання в Інформаційній панелі → Витрати
- Переключіть основну модель на GLM/MiniMax
- Використовуйте безкоштовний рівень (Gemini CLI, iFlow) для некритичних завдань

**Інформаційна панель відкривається через неправильний порт**

- Встановити `PORT=20128` та `NEXT_PUBLIC_BASE_URL=http://localhost:20128`

**Помилки хмарної синхронізації**

- Переконайтеся, що `BASE_URL` вказує на ваш запущений екземпляр
- Перевірте `CLOUD_URL` вказує на очікувану кінцеву точку хмари
- Зберігайте значення `NEXT_PUBLIC_*` у відповідності зі значеннями на стороні сервера

**Перший вхід не працює**

- Перевірте `INITIAL_PASSWORD` в `.env`
- Якщо не встановлено, резервний пароль – `123456`

**Немає журналів запитів**

- Установіть `ENABLE_REQUEST_LOGS=true` в `.env`

**Тест з’єднання показує «Недійсне» для OpenAI-сумісних постачальників**

- Багато постачальників не розкривають кінцеву точку `/models`
- OmniRoute v1.0.6+ включає резервну перевірку через завершення чату
- Переконайтеся, що базова URL-адреса містить суфікс `/v1`

### 🔐 OAuth em Servidor Remoto (віддалене налаштування OAuth)

<a name="oauth-em-servidor-remoto"></a>

> **⚠️ ВАЖЛИВО для використання OmniRoute у віддаленому VPS/Docker/сервері**

### Чи OAuth для Antigravity / Gemini CLI не підтримує віддалені сервери?

Провідники **Antigravity** і **Gemini CLI** використовують **Google OAuth 2.0** для автентифікації. Google вимагає, щоб `redirect_uri` не використовував fluxo OAuth, який **exatamente** має URI перед кадастрадами без додатка Google Cloud Console.

Оскільки повноваження OAuth embutidas, OmniRoute не встановлено в кадастрадах **apenas para `localhost`**. Якщо ви маєте доступ до OmniRoute у віддаленому сервері (наприклад: `https://omniroute.meuservidor.com`), або Google rejeita a autenticação com:

```
Error 400: redirect_uri_mismatch
```

### Рішення: налаштуйте власні облікові записи OAuth

Потрібно точно написати **Ідентифікатор клієнта OAuth 2.0** у Google Cloud Console через URI вашого сервера.

#### Passo a passo

**1. Доступ до Google Cloud Console**

Abra: [https://console.cloud.google.com/apis/credentials](https://console.cloud.google.com/apis/credentials)

**2. Crie um novo OAuth 2.0 ID клієнта**

- Натисніть **"+ Створити облікові дані"** → **"Ідентифікатор клієнта OAuth"**
- Tipo de aplicativo: **"Веб-програма"**
- Назва: escolha qualquer nome (наприклад: `OmniRoute Remote`)

**3. Додайте як авторизовані URI перенаправлення**

Без поля **"Авторизовані URI перенаправлення"**, додайте:

```
https://seu-servidor.com/callback
```

> Замініть `seu-servidor.com` домен або IP на свій сервер (включно з необхідним портом, наприклад: `http://45.33.32.156:20128/callback`).

**4. Зберегти електронну копію як ідентифікацію**

Наприклад, Google показує **Ідентифікатор клієнта** і **Секрет клієнта**.

**5. Налаштувати як variáveis de ambiente**

Немає `.env` (або наших варіантів середовища Docker):

```bash
# Para Antigravity:
ANTIGRAVITY_OAUTH_CLIENT_ID=seu-client-id.apps.googleusercontent.com
ANTIGRAVITY_OAUTH_CLIENT_SECRET=GOCSPX-seu-secret

# Para Gemini CLI:
GEMINI_OAUTH_CLIENT_ID=seu-client-id.apps.googleusercontent.com
GEMINI_OAUTH_CLIENT_SECRET=GOCSPX-seu-secret
GEMINI_CLI_OAUTH_CLIENT_SECRET=GOCSPX-seu-secret
```

**6. Reinicie o OmniRoute**

```bash
# Se usando npm:
npm run dev

# Se usando Docker:
docker restart omniroute
```

**7. Tente conectar novamente**

Інформаційна панель → Постачальники → Антигравітація (або Gemini CLI) → OAuth

Agora o Google redirecionará corretamente para `https://seu-servidor.com/callback` e a authenticação funcionará.

---

### Тимчасове вирішення проблеми (необхідне налаштування облікових записів)

Se não quiser criar credenciais próprias agora, ainda é possível usar o fluxo **manual de URL**:

1. OmniRoute скидає URL-адресу авторизації Google
2. Якщо ви авторизуєтеся, перенаправлення даних Google для `localhost` (неможливо віддалено від сервера)
3. **Скопіюйте повну URL-адресу** для переходу до вашого браузера (повідомте, що сторінка не створена)
4. Cole essa URL no campo que aparece no modal de conexão do OmniRoute
5. Натисніть **"Підключити"**

> Este workaround funciona porque o código de autorização na URL é válido independente do redirect ter carregado ou não.

</details>

---

## 🛠️ Tech Stack

- **Серед виконання**: Node.js 18–22 LTS (⚠️ Node.js 24+ **не підтримується** — рідні двійкові файли `better-sqlite3` несумісні)
- **Мова**: TypeScript 5.9 — **100% TypeScript** для `src/` та `open-sse/` (версія 1.0.6)
- **Framework**: Next.js 16 + React 19 + Tailwind CSS 4
- **База даних**: LowDB (JSON) + SQLite (стан домену + журнали проксі)
- **Потокове передавання**: події, надіслані сервером (SSE)
- **Auth**: OAuth 2.0 (PKCE) + JWT + ключі API
- **Тестування**: програма для тестування Node.js (368+ модульних тестів)
- **CI/CD**: дії GitHub (автоматична публікація npm + Docker Hub після випуску)
- **Веб-сайт**: [omniroute.online](https://omniroute.online)
- **Пакет**: [npmjs.com/package/omniroute](https://www.npmjs.com/package/omniroute)
- **Docker**: [hub.docker.com/r/diegosouzapw/omniroute](https://hub.docker.com/r/diegosouzapw/omniroute)
- **Стійкість**: автоматичний вимикач, експоненціальна віддача, захист від громового стада, підробка TLS

---

## 📖 Документація

| Документ                                     | Опис                                                  |
| -------------------------------------------- | ----------------------------------------------------- |
| [User Guide](docs/USER_GUIDE.md)             | Постачальники, комбо, інтеграція CLI, розгортання     |
| [API Reference](docs/API_REFERENCE.md)       | Усі кінцеві точки з прикладами                        |
| [Troubleshooting](docs/TROUBLESHOOTING.md)   | Загальні проблеми та рішення                          |
| [Architecture](docs/ARCHITECTURE.md)         | Архітектура системи та внутрішні                      |
| [Contributing](CONTRIBUTING.md)              | Розробка установки та рекомендацій                    |
| [OpenAPI Spec](docs/openapi.yaml)            | Специфікація OpenAPI 3.0                              |
| [Security Policy](SECURITY.md)               | Повідомлення про вразливості та методи безпеки        |
| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Повний посібник: налаштування VM + nginx + Cloudflare |
| [Features Gallery](docs/FEATURES.md)         | Огляд інформаційної панелі зі знімками екрана         |

### 📸 Попередній перегляд інформаційної панелі

<details>
<summary><b>Натисніть, щоб переглянути знімки панелі інструментів</b></summary>

| Сторінка                 | Скріншот                                          |
| ------------------------ | ------------------------------------------------- |
| **Постачальники**        | ![Providers](docs/screenshots/01-providers.png)   |
| **Комбінації**           | ![Combos](docs/screenshots/02-combos.png)         |
| **Аналітика**            | ![Analytics](docs/screenshots/03-analytics.png)   |
| **Здоров'я**             | ![Health](docs/screenshots/04-health.png)         |
| **Перекладач**           | ![Translator](docs/screenshots/05-translator.png) |
| **Налаштування**         | ![Settings](docs/screenshots/06-settings.png)     |
| **Інструменти CLI**      | ![CLI Tools](docs/screenshots/07-cli-tools.png)   |
| **Журнали використання** | ![Usage](docs/screenshots/08-usage.png)           |
| **Кінцева точка**        | ![Endpoint](docs/screenshots/09-endpoint.png)     |

</details>

---

## 🗺️ Дорожня карта

OmniRoute має **заплановано понад 210 функцій** на кількох етапах розробки. Ось ключові області:

| Категорія                        | Заплановані особливості | Основні моменти                                                                                                           |
| -------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 🧠 **Маршрутизація та інтелект** | 25+                     | Маршрутизація з найменшою затримкою, маршрутизація на основі тегів, попередній перегляд квот, вибір облікового запису P2C |
| 🔒 **Безпека та відповідність**  | 20+                     | Захист SSRF, маскування облікових даних, обмеження швидкості для кінцевої точки, визначення обсягу ключа керування        |
| 📊 **Спостережливість**          | 15+                     | Інтеграція OpenTelemetry, моніторинг квот у реальному часі, відстеження витрат на модель                                  |
| 🔄 **Інтеграція постачальників** | 20+                     | Реєстр динамічної моделі, час відновлення провайдера, Codex із кількома обліковими записами, розбір квоти Copilot         |
| ⚡ **Виконання**                 | 15+                     | Подвійний рівень кешу, кеш запитів, кеш відповідей, потокове підтримання активності, пакетний API                         |
| 🌐 **Екосистема**                | 10+                     | API WebSocket, гаряче перезавантаження конфігурації, розподілене сховище конфігурацій, комерційний режим                  |

### 🔜 Незабаром

- 🔗 **Інтеграція OpenCode** — власна підтримка постачальника для IDE кодування OpenCode AI
- 🔗 **Інтеграція TRAE** — повна підтримка інфраструктури розробки TRAE AI
- 📦 **Batch API** — асинхронна пакетна обробка масових запитів
- 🎯 **Маршрутизація на основі тегів** — Маршрутизація запитів на основі спеціальних тегів і метаданих
- 💰 **Стратегія найнижчої вартості** — автоматично вибирайте найдешевшого доступного постачальника

> 📝 Повні специфікації функцій доступні в [link](docs/new-features/) (217 детальних специфікацій)

---

## 📧 Підтримка

> 💬 **Приєднуйтесь до нашої спільноти!** [WhatsApp Group](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t) — отримуйте допомогу, діліться порадами та будьте в курсі подій.

- **Веб-сайт**: [omniroute.online](https://omniroute.online)
- **GitHub**: [github.com/diegosouzapw/OmniRoute](https://github.com/diegosouzapw/OmniRoute)
- **Проблеми**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues)
- **WhatsApp**: [Community Group](https://chat.whatsapp.com/JI7cDQ1GyaiDHhVBpLxf8b?mode=gi_t)
- **Оригінальний проект**: [9router by decolua](https://github.com/decolua/9router)

---

## 👥 Автори

[![Contributors](https://contrib.rocks/image?repo=diegosouzapw/OmniRoute&max=100&columns=20&anon=1)](https://github.com/diegosouzapw/OmniRoute/graphs/contributors)

### Як зробити внесок

1. Розгалужте репозиторій
2. Створіть свою гілку функцій (`git checkout -b feature/amazing-feature`)
3. Зафіксуйте свої зміни (`git commit -m 'Add amazing feature'`)
4. Push до відділення (`git push origin feature/amazing-feature`)
5. Відкрийте Pull Request

Див. [CONTRIBUTING.md](CONTRIBUTING.md), щоб отримати докладні вказівки.

### Випуск нової версії

```bash
# Create a release — npm publish happens automatically
gh release create v1.0.6 --title "v1.0.6" --generate-notes
```

---

## 📊 Зоряна історія

<a href="https://star-history.com/#diegosouzapw/OmniRoute&Date">
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=diegosouzapw/OmniRoute&type=Date&theme=dark" />
   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=diegosouzapw/OmniRoute&type=Date" />
   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=diegosouzapw/OmniRoute&type=Date" />
 </picture>
</a>

---

## 🙏 Подяка

Особлива подяка **[9router](https://github.com/decolua/9router)** від **[decolua](https://github.com/decolua)** — оригінального проекту, який надихнув цей форк. OmniRoute спирається на цю неймовірну основу завдяки додатковим функціям, мультимодальним API і повному перепису TypeScript.

Особлива подяка **[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)** — оригінальній реалізації Go, яка надихнула цей порт JavaScript.

---

## 📄 Ліцензія

Ліцензія Массачусетського технологічного інституту – подробиці див. [LICENSE](LICENSE).

---

<div align="center">
  <sub>Створено з ❤️ для розробників, які працюють у режимі 24/7</sub>
  <br/>
  <sub><a href="https://omniroute.online">omniroute.online</a></sub>
</div>
