## 💰 ~1.62B Token / A Kowane Wata Daga Matakan Kyauta na Masu Samarwa na Waje
> **Zo da asusun masu samarwa naka na kanka.** Wannan kimarce ce ta jimilla a kan matakan kyauta na masu samarwa na waje waɗanda ake samun cancanta kafada, ba kyautar token ba daga OmniRoute. Yi rajista, samu takardun shaida inda ake buƙata, kuma haɗa masu samarwa waɗanda zaka iya amfani da su; kowane mai samarwa ne yake sarrafa iyakokinsa, samuwar sa, da sharuɗɗansa.
>
> Tara matakan kyauta da hannu abu ne mai wahala — SDKs da dama, iyakokin yawan buƙatu da dama, kuma ba ka san adadin da kake da shi a zahiri ba. OmniRoute yana lissafa **467 shigarwar matakan kyauta a kan 34 maɓallan pool masu maimaitawa** kuma yana ƙididdige babban adadin token daga **17 pools waɗanda ke da kasafin token na wata-wata da aka buga mai kyau ƙari da takunkumi biyar na Groq na kowane samfur**, an cire kwaido ta hanyar pool da aka raba. Quotas waɗanda ke buɗewa kawai bayan binciken shaidar yanki (a yau: ModelScope) ana nuna su dabam, +~6M a bayan tabbatar da shaidar yanki, kuma ba a taɓa ƙara su cikin babban adadin ba. Sakamakon yana kasancewa a bayyane a dashboard (`/dashboard/free-tiers`).
> Takaitaccen bayani mai motsi na shafin `/dashboard/free-tiers` kai tsaye. Cikakken hanyar aiki (cire kwaidon pool, matakan bashi, sharuɗɗan masu samarwa): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
> Ana sake bincika waɗannan adadi kowane makonni biyu a kan lissafin kai tsaye kuma suna **motsawa a bangarori biyu** — mai samarwa ya ƙare matakin kyauta sai adadin ya ragu; sabon ya zo sai ya hau. Muna buga abin da lissafin yake ƙididdigewa a zahiri, ba a taɓa ƙara shi zuwa mafi kyawun yanayi ba.
⭐ Yi wa repo star idan OMNIROUTE ya taimaka maka adana kuɗi da sauƙaƙa aikinka.
[](https://github.com/diegosouzapw/OmniRoute)
[](https://www.star-history.com/diegosouzapw/omniroute)
[](https://olud.ai/project/diegosouzapw-omniroute.html)
### 💬 Shiga cikin al'umma
**👋 Bi mai kula da shi — ka kasance na farko wajen samun sababbin masu samarwa, fitowar sabbin sigogi & shawarwari:**
[](https://www.linkedin.com/in/diegosouzapw/)
[](https://github.com/diegosouzapw)
[](https://discord.gg/U47eFqAXCn)
[](https://t.me/omnirouteOficial)
[](https://chat.whatsapp.com/FvuCbrpZmQ6I85n2vW5QIC?s=cl&p=a&mlu=4)
[](https://chat.whatsapp.com/KWgatljAjmbELQory59Oti?s=cl&p=a&mlu=4)
[](https://omniroute.online)
**Tambayoyi, shawarwari game da masu samarwa, taswirar aiki & tallafi → [Discord](https://discord.gg/U47eFqAXCn) · [Telegram](https://t.me/omnirouteOficial) · WhatsApp [🌍 Duniya](https://chat.whatsapp.com/FvuCbrpZmQ6I85n2vW5QIC?s=cl&p=a&mlu=4) / [🇧🇷 Brasil](https://chat.whatsapp.com/KWgatljAjmbELQory59Oti?s=cl&p=a&mlu=4) / [Portal](https://portal.sthub.com.br/communities/groups/st-hub/channels/Omniroute-World-8kRjmK)**
## 📈 Ƙofar na Ci Gaba da Girma
## 🆓 Shigar da shi, haɗa mai samarwa, sannan ka watsa ta endpoint guda
```bash
# Bayan haɗa mai samarwa, kwafi maɓallin OmniRoute ɗinka daga Dashboard → Endpoints:
curl http://localhost:20128/v1/chat/completions \
-H "Authorization: Bearer YOUR_OMNIROUTE_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"auto","messages":[{"role":"user","content":"Hello!"}]}'
```
`auto` yana buƙatar hanya da ta cancanta. Sabuwar shigarwa na iya rashin manufofin da ba sa buƙatar maɓalli waɗanda suka cancanta, kuma mai samarwa marar maɓalli na iya ƙin abokan ciniki na waje. Masu samarwa da aka yi musu alamar `tos: avoid`, ciki har da Kiro, an fitar da su daga watsa ta atomatik a tsohuwar hanya; haɗa asusu ba ya soke wannan saitin ba. Duba [Jagoran Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md) kafin ka zaɓi mai samarwa.📦 Rubutun quickstart na copy-paste don **Python, Node.js, PHP, da cURL** → [`examples/quickstart/`](examples/quickstart/)
# 💥 Alƙawarin
# 🤔 Me ya sa ake buƙatar OmniRoute?
## 🤝 Masu Tallafa Mana Masu Buɗaɗɗen Tushe
> **Kuna so ku shiga a matsayin Abokin Buɗaɗɗen Tushe?** Waɗannan su ne kamfanonin da ke tallafawa buɗaɗɗen tushe kuma suna taimakawa wajen ci gaba da OmniRoute — kuma muna faɗi a fili inda kowane kuɗin da suka ba mu yake zuwa. Tuntuɓi: [diegosouza.pw@outlook.com](mailto:diegosouza.pw@outlook.com)
Kimi Moonshot AI
Godiya ga Kimi (Moonshot AI), Abokinmu na Buɗaɗɗen Tushe na farko, don tallafawa wannan aikin! Kimi shine dakin gwaje-gwaje na AI a bayan iyalai na samfurin K2 da K3 masu buɗaɗɗen nauyi — Kimi K3 yana ba da taga mahallin 1M-token, hangen nesa na asali da matakin gaba na coding a farashi mai rahusa fiye da samfuran rufaffiyar, kuma yana aiki kai tsaye tare da Claude Code, Codex da kowane kayan aikin coding da OmniRoute ke bayarwa.
Abin da tallafin Kimi ke samarwa: Kiredit na API na Kimi yana samar da bututun sakin OmniRoute mai inganci na AI — matakin ingancin haɗawa wanda Kimi K3 ke samarwa wanda ke duba kowane buƙatar ja kafin a tura shi — tare da haɓaka fasali na yau da kullun. Tallafin Kimi na farko yana aiki akan duka hanyoyin: kai tsaye Kimi API (kimi-k3) da shirin coding na Kimi Code (OAuth da maɓallin API). OmniRoute kuma shine aikin buɗaɗɗen tushe na Brazil na farko a cikin shirin tallafi na Kimi. Samu maɓallin API na Kimi tare da ƙarin kiredit 15% →
Cheaper Inference cheaperinference.com
Godiya ga Cheaper Inference, Abokin Buɗaɗɗen Tushe na OmniRoute, don tallafawa wannan aikin! Cheaper Inference wata hanyar shiga ce mai tsada wacce ke sake siyar da samfuran gaba 42 — Claude, GPT-5.x, Gemini, Kimi K3, GLM, DeepSeek, Grok da MiniMax — a bayan wani wuri mai dacewa da OpenAI, yana tura kowane buƙata zuwa mai bayarwa mafi arha ba tare da cajin sama da farashin jerin mai yin samfurin ba.
Tallafi na farko a OmniRoute: Cikakkun Taɗi, asalin /v1/responses endpoint, hangen nesa, kiran kayan aiki da samfuran hoto 3 (grok-imagine, nano-banana-pro, nano-banana-2, ana iya isa gare su kamar cheaperinference/<model>). Samu maɓallin API →
Hanyoyin haɗi masu alamar aff=omniroute hanyoyin haɗi ne na abokan tarayya. Suna tallafawa aikin ba tare da ƙarin farashi a gare ku ba. 🎟️ Tallace-tallacen Abokan Hulɗa — takardun shaidar rajista kyauta daga masu bayarwa waɗanda ba mu tallafawa (danna don faɗaɗawa)Wannan sashin don lambobin referral/coupon ne kawai. Haɗin gwiwar tallafi suna cikin 🤝 Masu Tallafa Mana Masu Buɗaɗɗen Tushe a sama. OmniRoute ba shi da tallafi ko haɗin gwiwa tare da masu bayarwa da aka jera a nan — waɗannan takardun shaidar jama'a ne waɗanda kowa zai iya amfani da su.
AgentRouter agentrouter.org
AgentRouter — rajistar abokin tarayya · $100 kiredit kyauta akan rajista (sabar kyauta, sa ran jinkiri mafi girma — mafi kyau don gwaji, ba don samarwa ba). Tallafi na farko a OmniRoute tun v3.8.50: Cikakkun Taɗi, tsarin waya mai dacewa da Anthropic da hanyar da ta dace da OpenAI. Samfuran da ake da su sun haɗa da claude-opus-4-8, claude-opus-5, gpt-5.6-sol da ƙari. Ɗauki $100 ɗinku →
⚠️ Hanyar haɗi ta abokin tarayya — OmniRoute ba shi da tallafi ko haɗin gwiwa tare da wannan mai bayarwa.
Kun san wani mai bayarwa tare da takardar shaidar rajista kyauta mai karimci wanda ke amfanar masu amfani da OmniRoute? Buɗe wani batu kuma za mu ƙara shi a nan.
## 🎯 Haɗe-haɗe — Babban Ginshiƙi
> **Haɗin** jerin model ne da OmniRoute ke bi a tsakaninsu **ta atomatik**. Idan quota ya ƙare, provider ya gaza, ko farashi ya yi tashin gwauron zabi, haɗin zai iya matsawa zuwa model mai lafiya na gaba da ya cancanta. 🛡️
### ⚡ Babu saiti — kawai yi amfani da `auto`
Babu buƙatar ƙirƙirar haɗi. Saita model ɗinka zuwa `auto` (ko wani nau'insa), sannan OmniRoute zai gina haɗi na kama-da-wane daga providers ɗin da ka haɗa, yana tantance su kai-tsaye:
ID na Model
Abin da yake ingantawa
auto
🎯 Daidaitaccen zaɓi na asali (LKGP — yana manne wa provider ɗinka na ƙarshe da ya yi aiki)
auto/coding
🧑💻 Nauyi mai fifita inganci don samar da code
auto/fast
⚡ Mafi ƙarancin jinkiri da farko
auto/cheap
💰 Mafi arha ga kowane token da farko
auto/subscription
🎟️ Quota na subscription ɗin da ka riga ka biya kawai — yana rufewa idan ya gaza, ba ya komawa ga zaɓin da za a caje ka (jagora)
auto/thrifty
🪜 Quota na plan da farko, sannan mataki ɗaya bayan ɗaya zuwa zaɓuɓɓukan biyan kuɗi mafi arha — yana komawa kan plan bayan an sake saitawa (jagora)
auto/offline
🔋 Mafi yawan ragowar damar quota / rate-limit da farko
📌 Mannewa sarai ga provider na ƙarshe da aka san yana aiki
auto/chaos
🧪 Aika buƙatu a layi ɗaya zuwa rukunin models (ɗaya ga kowane provider, guda 5 a matsayin tsoho), sannan ya dawo da amsa ɗaya; kira ɗaya na upstream ga kowane model a rukunin, ba gwajin jefa matsala ba
##
### 🔀 Ko ka gina naka — dabarun sarrafa hanya guda 20
Dukkan dabaru **20** — haɗa su yadda kake so a kowane mataki na haɗi:
#
Dabara
Abin da take yi
1
priority
Jeri mai fifita target na farko — a cinye na kowanne kafin a koma na gaba 🥇
2
fill-first
Cika quota na kowane target gaba ɗaya kafin matsawa zuwa na gaba
Rage $ ga kowace buƙata daga farashin catalog na kai-tsaye 💸
10
headroom
Zaɓi target mai mafi yawan quota da ya rage
11
quota-weighted
Tsallake accounts da quota ɗinsu ya ƙare, sannan a zaɓa gwargwadon ragowar quota ÷ nauyin buƙatun da ke gudana — tattaunawar da ake yi tana ci gaba da manne wa zaɓinta ⚖️
12
reset-window
Fi son target wanda za a sake saita lokacin quota ɗinsa da wuri
13
reset-aware
Jera bisa lokacin sake saitin quota — gajerun lokuta da farko 📊
14
context-relay
Miƙa context tsakanin targets don dogayen tattaunawa 🧠
15
context-optimized
Zaɓi wanda ya fi dacewa da girman context na yanzu
16
cache-optimized
Manne kowane farkon prompt da za a iya sake amfani da shi ga account ɗaya — ƙara yawan nasarar prompt-cache zuwa iyaka 🎯
17
lkgp
Hanyar Ƙarshe da Aka San Tana Aiki — tana manne wa provider na ƙarshe da ya yi nasara, sannan ta koma ga ƙa'idoji idan ya gaza
18
auto
Ƙididdigar kai-tsaye mai dalilai 16 a dukkan connections 🤖
19
fusion
Aika buƙatu zuwa rukunin models + mai hukunci ya haɗa amsa ɗaya 🧬
20
pipeline
Haɗa matakai — sakamakon kowane target yana shiga na gaba 🔗
Injin Auto-Combo yana ba kowane zaɓi maki bisa **abubuwa 16** (lafiya, ƙayyadadden kaso, farashi, jinkiri, dacewa da aiki, inganci, samuwar zaman aiki…) — duba [`docs/routing/AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md).
##
### 🧱 An gina juriya a ciki (matakai 3 masu zaman kansu)
📖 [Injin Auto-Combo](docs/routing/AUTO-COMBO.md) · [Jagorar Juriya](docs/architecture/RESILIENCE_GUIDE.md)
## 🏆 Abin da Ya Bambanta OmniRoute
📊 Cikakkiyar hanyar bincike & bayanan kowane fasali idan aka kwatanta da 9router, OpenRouter, CLIProxyAPI & LiteLLM → [`docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md`](docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md)
## 💚 Tallafa wa OmniRoute
OmniRoute na da lasisin MIT kuma ana kula da shi a fili. Idan yana adana maka lokaci ko kuɗi, ga yadda za ka taimaka masa ya ci gaba da kasancewa mai zaman kansa — zaɓi duk abin da ya dace da kai. Tallafi ba ya taɓa shafar fifikon zaɓin hanya; yana sayen bayyanar suna ne, ba matsayi ba.
**🇧🇷 PIX** — nan take, babu kuɗin caji (Brazil)
Maɓalli (bazuwar): `5d865059-bc44-483a-962d-43ceb80126eb`
Kwafi-da-manna na Pix:
```
00020101021126580014br.gov.bcb.pix01365d865059-bc44-483a-962d-43ceb80126eb5204000053039865802BR5922OMNIROUTE CONTRIBUICAO6006BRASIL62070503***630475DD
```
₿ Kuɗin dijital — BTC · ETH · USDT-TRC20 · USDC-Solana (danna don faɗaɗawa)
₿ BTC
Bitcoin (SegWit)
bc1qh00smz004sy85wyl28v77tenkt3ckl6eaep7fd
Ξ ETH
Ethereum (ERC20)
0x64Cf6B68A6Ff34288e89172950a2d00102337a84
₮ USDT
Tron (TRC20)
TKAF41JpuQrHbKTnsQa9svJE2T192Hvsc2
$ USDC
Solana
2emNNZzVVWQc3FQ2wk9M6qXUQmW8AKdjjL174fXR28Tu
⚠️ Aika kowace tsaba a kan hanyar sadarwar da aka nuna kawai — aikawa a kan hanyar sadarwar da ba daidai ba na iya sa a rasa kuɗin.
🐛 Ka gano wata matsala ko kana da shawara? Buɗe [Tattaunawa](https://github.com/diegosouzapw/OmniRoute/discussions).
Bayanan masu haɓakawa: Aikin na iya ƙirƙirar fayil na gida mai suna .env yayin npm install/postinstall domin sauƙaƙa wa masu haɓakawa. Ana yin watsi da wannan fayil da gangan ta hanyar .gitignore (duba .gitignore) kuma ba dole ba ne a taɓa commit ɗinsa — idan aka yi commit ɗinsa bisa kuskure, sauya duk wasu sirrika da aka fallasa sannan a cire fayil ɗin daga tarihin. Duba docs/DEVELOPER-ENVIRONMENT.md don jagora kan sarrafa fayilolin muhalli na gida da sirrika.
## 📡 Radar na OmniRoute
Babban adadin shirin kyauta har yanzu shi ne **~1.62B tokens/wata** daga kundin da aka bayyana a sama, wanda aka cire maimaituwar bayanai tsakanin rumbuna. Ƙimar rajista ta wucin gadi daga masu samarwa na iya ƙara adadin watan farko daban zuwa **~2.22B**. Radar wani zaɓin ƙarin kundi ne mai sa hannu, ga mutanen da ke son samun sabbin bayanai kan samuwar samfuran kyauta tsakanin fitowar sabbin sigogin OmniRoute; kundin al'umma da duk fasalolin kyauta da ake da su za su ci gaba da kasancewa kyauta.
Masu tallafawa za su iya samun kundin kai-tsaye da ƙarin damammaki daga masu samarwa. Matsakaicinsa na daban, wanda zai iya sauyawa, shi ne **kimanin 3B tokens/wata a mafi yawa**, gwargwadon samuwar masu samarwa. Wannan matsakaici ba garanti ba ne: masu samarwa za su iya sauya ƙa'idojin amfani, cancanta, samfura, ko yankuna a kowane lokaci.
Radar na zaɓi ne kuma GET-only. Abokin hulɗar OmniRoute ba ya loda prompts, zirga-zirga, saitunan masu samarwa, bayanan telemetry na amfani, ko matsayin kin nuna sanarwa na cikin gida. Ƙara sani game da cancanta da kundin na yanzu a **[radar.omniroute.online/planos](https://radar.omniroute.online/planos)**.
## ✨ Abubuwan da Suka Sabu
> Fitattun abubuwa na kwanan nan daga **v3.8.20 → v3.8.53**. Cikakken tarihi a cikin [`CHANGELOG.md`](CHANGELOG.md).
- **⚖️ `quota-weighted` routing** — dabarar combo ta 20 tana tsallake asusun da suka gushe, sannan tana zaɓa daga cikin sauran bisa gwargwadon ragowar quota ÷ nauyin in-flight, tana riƙe tattaunawar da ke gudana a matsayinsu. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **🧰 Headless mode** — `omniroute serve --headless` (ko `OMNIROUTE_HEADLESS=1`) yana gudanar da injin proxy na `/v1/*` kawai, yayin da dashboard da sassan da suka shafi dashboard kawai ke kashe. → [Headless Mode](docs/guides/HEADLESS.md)
- **🔎 Model discovery** — `/v1/models` yana tacewa bisa capability, context, kind da text, kuma `POST /v1/models/query` yana dawo da gajeren jeri na deterministic tare da irin wannan ganuwa ga kowane key. → [API Reference](docs/reference/API_REFERENCE.md)
- **🔑 Per-key routing control** — ɗaure API key zuwa model ɗaya ko combo ɗaya da `forcedModel`, kuma ƙara ko cire models da combos na key a kai ɗaya (`/api/keys/{id}/access`). → [API Reference](docs/reference/API_REFERENCE.md) · [OpenAPI](docs/openapi.yaml)
- **🛡️ Finer PII controls** — zaɓi na kowane nau'i, har zuwa alamu na masking na al'ada guda 20 da aka tantance, da ƙidayar gano na kowane nau'i; masking kanta tana ci gaba da kasancewa na zaɓi (opt-in). → [Guardrails](docs/security/GUARDRAILS.md)
- **🌍 67 languages** — dashboard, mirrors na docs da CLI, tare da `npm run i18n:add-locale` yana ƙara harshe a ko'ina da umarni ɗaya. → [i18n Guide](docs/guides/I18N.md)
- **🎛️ OmniConductor** — shigar da A2A delegation zuwa cikin agent fleet naka, Conductor skills a kan Agent Card, da panel na dashboard tare da Faro push-to-talk voice chat. → [A2A Server](docs/frameworks/A2A-SERVER.md)
- **🛂 Adaptive admission & overload protection** — buƙatun chat masu nauyi suna shiga jerin jira maimakon su dawo da 503, tare da atomic RPM rolling leases ga kowace connection. → [Resilience Guide](docs/architecture/RESILIENCE_GUIDE.md)
- **🗂️ Canonical `/v1/models` ordering** — toshe ɗaya mai ci gaba da aka rarraba ta provider ga kowane provider (combos a gaba farko), tabbatacce a dukkan tushen catalog. → [API Reference](docs/reference/API_REFERENCE.md)
- **🗜️ Compression hardening** — inflation guard kunne ta tafarki na asali, Caveman packs ga DE / FR / JA + Chinese (wényán), RTK filters ga Gradle & .NET. → [Compression](docs/compression/COMPRESSION_ENGINES.md)
- **💸 Honest flat-rate cost** — masu samar da subscription / coding-plan suna nuna **$0** a cikin cost analytics; budget, quota & routing suna ci gaba da ƙididdiga. → [API Reference](docs/reference/API_REFERENCE.md)
- **⚖️ Quota-Share routing** — raba quota na account da aka haɗa a daidai a kan pooled keys, yana conserving aiki ta yadda ake ba da rance na slices da ke a banƙyama. → [Resilience Guide](docs/architecture/RESILIENCE_GUIDE.md)
- **🤖 One-command CLI/agent setup** — dokoki 15 da aka yi rajista `setup-*`; `omniroute run` yana ƙaddamar da CLIs 7 (Claude Code, Codex, Aider, Goose, OpenCode, Qwen Code, Gemini CLI); `omniroute configure` yana goyon bayan targets 11 tare da interactive provider+model picker da favorites na kowane context. → [CLI Integrations](docs/guides/CLI-INTEGRATIONS.md)
- **🛰️ Remote mode** — tuka OmniRoute mai nisa da scoped tokens (`connect` / `contexts` / `tokens`) + mai taimakon `antigravity` OAuth ga shigarwa a VPS. → [Remote Mode](docs/guides/REMOTE-MODE.md)
- **🧭 Smarter auto-routing** — combos na `auto/:`, **Fusion** (model panel + judge), task-aware routing, overrides na model / mode / USD-budget ga kowace buƙata. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **🗜️ Pluggable compression** — injuna 12 masu haɗawa + Compression Studios: LLMLingua-2, two-tier Ultra, omniglyph, per-step fidelity gate, GCF v3.2, drag-reorder editor. → [Compression](docs/compression/COMPRESSION_ENGINES.md)
- **🕵️ Transparent MITM decrypt (TPROXY)** — kama CLIs da ke watsi da proxy env vars, tare da per-SNI CA + trust-store installer. → [MITM/TPROXY](docs/security/MITM-TPROXY-DECRYPT.md)
- **💸 Cost telemetry everywhere** — headers na `X-OmniRoute-*` cost/usage a kowane endpoint, header na cache-HIT savings, da quotas na kashe USD na kowane key. → [API Reference](docs/reference/API_REFERENCE.md)
- **🧠 Memory you control** — kashe ta tafarki na asali, opt-in int8 vector quantization + typed decay, `x-omniroute-no-memory` na kowace buƙata. → [Memory](docs/frameworks/MEMORY.md)
- **🛡️ Security** — prompt-injection guard a kowane LLM route (red-team suite), opt-in credential-masking guardrail (yana redact API keys/secrets da suka fito a bangarori biyu), binciken yanar gizo na karshe na kyauta ta DuckDuckGo, da zaɓin OIDC login gate ga dashboard (shiga da password koyaushe tana ci gaba da kasancewa). → [Guardrails](docs/security/GUARDRAILS.md)
- **🖼️ New endpoints** — `/v1/ocr` (Mistral OCR) da `/v1/audio/translations` (salon Whisper) suna cika saman media. → [API Reference](docs/reference/API_REFERENCE.md)
- **🎨 Image / video / audio generation** — API ɗaya ga media: xAI Grok Imagine & Novita AI video, ComfyUI, Magnific, Adobe Firefly, Segmind, da speech providers kamar ElevenLabs. → [API Reference](docs/reference/API_REFERENCE.md)
- **🌍 Deployment & ops** — reverse-proxy `basePath`, gano harshen browser kai tsaye, bin diddigar na'ura na kowane key, root-less MITM trust, zh-TW localization. → [Environment](docs/reference/ENVIRONMENT.md)
- **🤝 More providers & agents** — cloud agents (Codex Cloud, Cursor, Devin, Jules), Grok Build (xAI) tare da browser + OAuth login, Ollama first-class card, Claude Opus 5 & Sonnet 5, haɗin gwiwar Kimi na hukuma (Code/Web/Moonshot), Zed, Requesty, SenseNova, Yuanbao, Agnes AI… da sabon **375-provider catalog**. → [Providers](docs/reference/PROVIDER_REFERENCE.md)
- **📡 Routing transparency** — kowane response yana ɗauke da header na `X-OmniRoute-Decision` wanda ke bayyana strategy/provider/latency da ya yi aiki da shi, sabon dabarar combo na `cache-optimized` + factor na Auto-Combo `cacheAffinity` yana mayar da buƙatun da suka maimaita zuwa connection da ke riƙe da cached prefix, kuma read-only endpoint na `/v1/auto-combo/{channel}/candidates` yana nuna live candidate pool na channel na `auto/*`. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **⚡ Ayyukan gida da kayan aiki** — Redis na gida ta danna ɗaya, masu shigar da relay na Cloudflare Workers / Deno Deploy, Bifrost & Mux a matsayin ayyukan da aka saka a ciki ƙarƙashin kulawa. → [Ayyukan da aka Saka a Ciki](docs/frameworks/EMBEDDED-SERVICES.md)
- **🧩 Har ila a cikin akwatin** — tsarin plugin da kasuwa, tsarin ƙwarewar Omni/Agent/GitHub, haɗin kai na Obsidian vault (kayan aikin MCP 22), APIs na Batch & Files masu jituwa da OpenAI, ma'ajin amsoshi na ma'ana, gamification tare da teburin manya, ganowar wakilan ACP (wakilai 15 da aka gina a ciki), fitar da log da aka tsara zuwa BigQuery, `auto/chaos` fan-out na samfura da yawa a kwarara, gadar bot na Telegram, mai sarrafa siga a cikin app da matsayin masu samarwa kyauta na LMArena-ELO. → [Docs](docs/README.md)
## 🤖 CLI da Wakilan Coding Masu Jituwa
> Tsari ɗaya — `http://localhost:20128/v1` — kuma **kowace** IDE ko CLI ta AI tana aiki da samfurori na kyauta da masu araha.
**Ƙaddamar da kowane CLI mai goyon baya ta OmniRoute da umarni guda** — ba a rubuta fayilolin saiti,
ana saka bayanan tantancewa ga kowane tsari, sannan Qwen/Gemini suna samun keɓantaccen home na wucin gadi:
```bash
omniroute run claude --model openai/gpt-5.4 # Claude Code
omniroute run codex --model glm/glm-5.2 # OpenAI Codex CLI
omniroute run aider --model glm/glm-5.2 -- --message "reply OK"
omniroute run goose --model glm/glm-5.2
omniroute run opencode --model glm/glm-5.2 -- run "reply OK"
omniroute run qwen --model glm/glm-5.2 -- -p "reply OK"
omniroute run gemini --model glm/glm-5.2 -- --skip-trust -p "reply OK"
# Ko zaɓi provider+model ta hanyar hulɗa sannan a rubuta saitin kayan aikin:
omniroute configure codex # akwai kuma: claude opencode qwen aider goose gemini cline continue kilo 5dive
```
Kowane umarni yana mutunta remote context mai aiki (`omniroute connect `), `--dry-run`
yana nuna ainihin env/args ba tare da aiwatarwa ba, sannan `--api-key-env NAME` yana hana sirrika
shiga tarihin shell ɗinka. → [Haɗaɗɗun CLI](docs/guides/CLI-INTEGRATIONS.md)
## 🌐 Masu Samar da AI 375 — 153 da Aka Yi Musu Alamun Kyauta a Katalog
> **Masu samarwa 375 da aka rajista** a cikin manyan tarin chat, media, search, local, cloud-agent da system, ciki har da **153 masu ɗauke da metadata na gano `hasFree: true`**. Rajistar model na chat tana ƙunshe da **masu samarwa 239 / ma'aurata provider-model 3,059 daban-daban / raw model IDs 1,475**; katalog na kasafin kyauta na daban yana da **layuka 467 na kowane model**, **pools 34 masu maimaitawa** da **masu samarwa 51 na maimaitawa/marasa makulli kyauta har abada**. Wadannan adadin ƙidaya daban-daban ne da gangan; ma'anoni da ƙididdigar da aka cire kwafin pools suna cikin [Bayanin Masu Samarwa](docs/reference/PROVIDER_REFERENCE.md) da [Matakan Kyauta](docs/reference/FREE_TIERS.md).
### 🏢 Kowane babban lab — ta hanyar endpoint ɗaya
OpenAI
Anthropic
Gemini
xAI Grok
DeepSeek
Mistral
Qwen
Meta Llama
Groq
NVIDIA
MiniMax
Cohere
Perplexity
HuggingFace
Together
Fireworks
Cloudflare
Baidu
…da ƙarin 350+ — kowane icon yana fitowa kai tsaye daga katalog ɗin masu samarwa na dashboard. 📖 [Bayanin Masu Samarwa](docs/reference/PROVIDER_REFERENCE.md)
### 🆓 Kyauta Har Abada — $0, babu kati
OpenCode Zen DeepSeek V4, Nemotron 3 Babu iyakar token
Kilo Code Auto-router, Tencent Hy3 Kyauta har abada
Requesty GPT-OSS 120B, Nemotron Kyauta har abada
SiliconFlow DeepSeek V3.2 / R1 Matakin kyauta
Z.AI GLM GLM-4.7 / 4.5-Flash Kyauta har abada
Baidu ERNIE ERNIE 4.0 Kyauta har abada
Qoder AI Qwen3-Max, Kimi-K2 KYAUTA marar iyaka
Pollinations GPT, Llama, Claude Ba a buƙatar makulli
Cloudflare AI Samfura 50+ Neurons 10K a rana
NVIDIA NIM GLM, MiniMax ~40 RPM kyauta
Cerebras GLM 4.7, GPT-OSS Kiredit $5 na sau ɗaya; ana buƙatar kati
### 🧩 Sabo: OmniRoute a cikin Copilot Chat na asali na VS Code
> Babu sabon sandar gefe, babu sabon UI na hira — duk samfurin da OmniRoute ke samarwa yana bayyana kai tsaye a cikin
> **mai zaɓar samfurin Copilot Chat da kake amfani da shi tuni**. Tun daga VS Code 1.122, samfuran masu samarwa suna aiki
> ba tare da shiga GitHub ko biyan kuɗin Copilot ba — yanayin wakili, kiran kayan aiki da hangen hoto, duk
> kyauta.
Shigar da ƙarin **[OmniCopilot](https://github.com/diegosouzapw/OmniCopilot)**, saita shi zuwa
sabar OmniRoute ɗinka (tsohon saitin shi ne `localhost:20128`), sannan buɗe Copilot Chat → mai zaɓar samfuri
→ **Sarrafa Samfura…** → **OmniRoute**.
Daga cikin editan: buɗe kallon **Extensions**, bincika **"OmniRoute"**, danna **Install**
— yana aiki iri ɗaya a shagunan biyu. Lambar tushe, matsaloli da littafin matakan wallafawa suna nan a
[diegosouzapw/OmniCopilot](https://github.com/diegosouzapw/OmniCopilot).
📖 [Jagorar VS Code Copilot Chat](docs/guides/VSCODE-COPILOT.md) — saitawa, abin da mai zaɓar ke nunawa, allon kulawa a cikin shafi, warware matsaloli
### 🎩 Sabo: OmniRouteTray — ƙofarka, tana zaune a sandar menu
> `omniroute serve` ya fi jin daɗi idan yana kunne koyaushe. **[OmniRouteTray](https://github.com/zoispag/omniroute-tray)**
> yana mayar da hakan manhajar sandar menu ta macOS da za ka saita ka manta da ita: yana fara sabar, yana tabbatar da ci gaba da aikinta
> bayan sake kunna na’ura, yana sabunta ta a wurinta, kuma yana sa kasafin token ɗinka na kai-tsaye ya kasance kusa da dannawa ɗaya — **ba a
> bar tagar terminal a buɗe ba, babu `npm install -g omniroute` da za a riƙa kula da shi.**
An gina shi da [Tauri v2](https://v2.tauri.app/) (jigon Rust mai ƙanƙanta ƙwarai), yana zuwa
da runtime na Node 24 nasa mai sa hannu kuma yana sarrafa shigarwar OmniRoute mallakar manhajar, don haka ba ya taɓa cin karo da
`node`/`bun` naka na duniya baki ɗaya. Yana **amfani tare da saitunanka da rumbun bayananka na `~/.omniroute/` da suke akwai** — don haka
OmniRoute ɗin da kake gudanarwa tuni ne, kawai yanzu yana sanye da hula. 🎩
Abin da yake yi
Yadda yake yi
🟢 Yana sa ido kan sabar
Yana ƙaddamar da omniroute serve, yana karɓar misalin da ke gudana tuni maimakon maimaita shi
📊 Amfani na kai-tsaye a kallo ɗaya
Sandunan ƙason masu samarwa, iyakokin zaman Claude/na mako-mako tare da ƙidayar lokacin sake saitawa, rabon kuɗin kwanaki 30
🔄 Yana sabunta kansa a wurinsa
Shigarwa mai matakai, musayar atomic, komawa baya idan an gaza — koyaushe a kan sabuwar fitarwa
🚀 Farawa yayin shiga
Zaɓin ƙaddamarwa yayin shiga; tire kawai, babu alamar dock
🩺 Bincike & rajistoci
Binciken matsala da samun damar rajistan sabar da dannawa ɗaya
```sh
brew install --cask zoispag/tap/omniroute-tray
```
Ka fi son saukewa? Ɗauko sabuwar .dmg daga
Fitowar Sabbin Nau'ikan. Lambar tushe, matsaloli da takardun
ginawa suna nan a zoispag/omniroute-tray.
💛 Aikin al'umma ne daga @zoispag — ba fitowar OmniRoute ta hukuma ba ce.
> Bayan uwar garken, OmniRoute **cikakkiyar cibiyar sarrafa layin umarni ce** mai **umarni sama da 80**, tare da buɗaɗɗun ƙa'idojin wakilai domin wakilin AI ya iya sarrafa ta **da kansa**.
### ⌨️ CLI na gaske (ba `start` kawai ba)
```bash
omniroute # ƙaddamar da gateway + dashboard (tashar 20128)
omniroute chat # abokin hulɗar taɗi na TUI (slash: /model /combo /skill /memory)
omniroute setup # jagorar saitin fara amfani
omniroute doctor # gano matsalolin masu samarwa, tashoshi, native deps
```
### 🛰️ Yanayin nesa — gudanar da CLI a nan, OmniRoute a kan VPS
OmniRoute na kan uwar garke? Sarrafa shi daga kwamfutar tafi-da-gidanka da **CLI iri ɗaya**. Shiga sau ɗaya
da scoped access token; daga nan kowane umarni zai nufi na'urar nesa.
```bash
omniroute connect 192.168.0.15 # kalmar sirri → scoped token, an adana shi a matsayin context
omniroute models # ← yana gudana a kan uwar garken NESA
omniroute configure codex # ← yana zaɓar model na nesa, yana rubuta profile na Codex na gida
omniroute tokens create --name ci --scope read # ƙirƙiri tokens masu ƙuntataccen izini don wasu na'urori
omniroute contexts use default # ← koma zuwa uwar garken gida
```
Tokens suna da scopes na `read` / `write` / `admin`; routes masu ƙaddamar da processes suna nan a loopback kawai.
📖 [Yanayin Nesa](docs/guides/REMOTE-MODE.md)
### 🤝 Haɗa wakili — kuma zai sarrafa OmniRoute da kansa
Bayyana OmniRoute ta hanyar **MCP**, **A2A**, **REST API**, **webhooks** ko **CLI na nesa** — duk wani wakili mai ƙwarewa (ko lambar da ka rubuta) zai sami damar sarrafa dukkan gateway ɗin: routing, providers, combos, cache, compression, memory — kai tsaye. Ana samar da HTTP endpoints na ƙasa a ƙarƙashin `http://localhost:20128`.
Hanyar sadarwa
Endpoint / umarni
Abin da ake amfani da shi
🧰 MCP (stdio)
omniroute --mcp
Haɗa shi da Claude Desktop, Cursor, ko kowane MCP client
🌊 MCP (HTTP)
/api/mcp/stream
MCP na nesa — kayan aiki 110, scopes 33 (aiwatar da ƙuntatawa na zaɓi ne), cikakken tarihin bincike
📡 MCP (SSE)
/api/mcp/sse
Hanyar jigilar MCP mai gudana kai tsaye
🤝 A2A
/.well-known/agent.json
Daga wakili zuwa wakili, JSON-RPC 2.0 + SSE, skills 6
🌐 REST API
/v1/*
Mai jituwa da OpenAI — taɗi, embeddings, hotuna, sauti, OCR
```bash
# Ba Claude Code cikakken kayan aikin OmniRoute ta hanyar MCP:
claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp/stream
```
📖 [Uwar Garken MCP](docs/frameworks/MCP-SERVER.md) · [Uwar Garken A2A](docs/frameworks/A2A-SERVER.md) · [Ƙa'idojin Wakilai](docs/frameworks/AGENT_PROTOCOLS_GUIDE.md)
## 🗜️ Adana Token 15–95% — Ta Atomatik
### 📖 Yadda yake aiki — pipeline, gine-gine & lissafin tanadi
Combo na stacked na tsoho yana gudanar da `RTK → Caveman`. Idan dukkansu suna aiki a kan kayan aikin tool/context ɗaya, tanadi yana haɗuwa:
```txt
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
```
Injin kiyayewa yana **kullum kare** code blocks, URLs, JSON da bayanan da aka tsara.
> **Me ya sa ake amfani da token da yawa alhali kaɗan ke cika aikin?** Kowace buƙata tana wucewa ta pipeline ɗin matsawa na OmniRoute **a bayyane** — babu canje-canje a gefen abokin ciniki. Yanzu **tarin injuna 12 da za a iya haɗawa** ne waɗanda ke gudana bisa tsari kuma ana haɗa su da daidaitawa bisa combo na routing — gina bisa ra'ayoyi daga [RTK](https://github.com/rtk-ai/rtk), [Caveman](https://github.com/JuliusBrussee/caveman) (⭐ 90K+), [LLMLingua-2](https://github.com/microsoft/LLMLingua), da [Troglodita](https://github.com/leninejunior/troglodita) (PT-BR).
### 🧱 Taron injuna 12
Injunan suna gudana bisa tsarin pipeline; kowannen yana da iya kunna/kashewa da daidaitawa shi kaɗai bisa combo:
#
Inji
Abin da yake yi
1
Session-Dedup
Yana fitar da abun ciki da aka maimaita a fadin zagayowar tattaunawa (ana nufin shi ta adireshin abun ciki, tsakanin zagayowa)
2
CCR
Yana ajiye manyan tubalan a bayan alamun dawowa, ana kawo su idan an buƙata
3
Lite
Goge whitespace + URL ɗin hoto (tushen da ke da ƙarancin jinkiri)
4
RTK
Tacewa ta wayo ga sakamakon kayan aiki, cire kwaskwarima & guntawa (yana sanin umarni)
5
Responses Tool Output
JSON lossless-da-farko + matsawar bincike mai iyaka don fitar da shell/patch/search/build (Responses API)
6
Headroom
Matse tebur na lossless na JSON arrays (~30%) ta hanyar codec na GCF da aka haɗa a ciki
7
Relevance
Ƙididdigar jimla ta fitarwa bisa tambayar mai amfani ta ƙarshe
8
Caveman
Matsawar rubutu bisa ƙa'ida (~65–75% a kan fitarwa)
9
Aggressive
Takaitawa + tsufa mataki-mataki na tsoffin zagayowar tattaunawa
10
LLMLingua-2
Yanke ma'ana na ML ta hanyar MobileBERT ONNX — amintacce ga code, async
11
Ultra
Yanke token na heuristic tare da matakin ƙaramin samfuri (SLM) na zaɓi
12
OmniGlyph
Lamuntawa ta gwaji ta context-a matsayin-hoto don Claude Fable 5 da aka auna a kan layin Anthropic kai tsaye; GPT 5.6 transformers suna ci gaba da kasancewa fail-closed har sai an samu shaida daga mai samarwa. Bayanan martaba huɗu na matsawa (aggressive tsoho, daidaitacce, amintacce ga coding, passthrough) (mafi ƙarfi; ana shiga ta zaɓi)
Ana **kullum adana** code blocks, URLs da bayanan da aka tsara daidai-ta-byte. **Saitunan danna-ɗaya** suna haɗa injunan:
Yanayi
Tanadi
Mafi dacewa don
🪶 Lite
~15%
Tsoho amintacce da ke aiki koyaushe
🪨 Standard (Caveman)
~30%
Coding na yau da kullum
⚡ Aggressive
~50%
Dogayen zama masu cike da kayan aiki
🔥 Ultra
~75%
Mafi yawan tanadi
🧰 RTK
60–90%
Fitar da shell/test/build/git
🔗 Stacked (RTK → Caveman)
78–95%
Prompts gauraye + rajistan kayan aiki
**Misali na gaske — yanayin Standard:**
> **Kafin (token 69):** _"Dalilin da ya sa React component ɗinku yake sake rendering mai yiwuwa shi ne kuna ƙirƙirar sabon reference na object a kowace zagayowar rendering. Idan kuna wucewa da object na inline a matsayin prop, kwatancen shallow na React yana ganin shi a matsayin wani object daban a kowane lokaci, wanda hakan ke haifar da sake rendering. Ina ba da shawarar amfani da useMemo don memoize object ɗin."_
>
> **Bayan (token 19):** _"Sabon ref na object a kowane rendering. Prop na inline object = sabon ref = sake rendering. Rufe shi a useMemo."_
>
> **Amsa ɗaya ce. Ragin token da 72%. Babu asarar daidaito.** ✅
**Misalin PT-BR — yanayin [Troglodita](https://github.com/leninejunior/troglodita):**
> **Kafin (42 tokens):** _"Matsalar ita ce samfurin yana sake-nunawa saboda ana ƙirƙirar sabon nuni na abu a kowane zagayowar nunawa. Zan ba da shawarar amfani da useMemo."_
>
> **Bayan (12 tokens):** _"Sake-nuni: sabon ref a kowane zagaye (an sake ƙirƙirar abu inline). Yi amfani da `useMemo`."_
>
> **Amsa ɗaya. ~70% ƙarancin tokens. Daidaiton fasaha babu ɓarna.** ✅
### 🎚️ Bayan injunan — salon fitarwa, ma'aunin dacewa & sarrafa kowace buƙata
Injunan 12 da ke sama suna rage abin da ke shiga **ciki**. Sauran matakai uku suna tsara **yadda**, **yaushe**, da abin da ke **fita**:
- **🪄 Salon Fitarwa** _(jagorar axis-fitarwa)_ — shigar da umarnin tsara-amsa masu tabbas, amintattu ga cache; ana iya haɗa su, kowanne a matakin `lite` / `full` / `ultra`. Ƙara salon shine shigarwa ta layi ɗaya a rajista:
- **Prose gajere** — cire cika-kalma / articles / neman kaucewa; ci gaba da riƙe abun fasaha daidai.
- **Ƙarancin code** — "lazy senior dev" YAGNI: mafi ƙaramin canji da ke aiki, babu scaffolding da ba a nema ba.
- **Ponytail (lazy senior dev)** — hau tsirar YAGNI, gyara tushen matsala, mafi ƙaramin diff da ke aiki.
- **Ina da ADHD (aiki-da-farko)** — matakin gaba yana jagora, matakai suna da lambobi, mataki na gaba ɗaya mai tabbas, babu gabatarwa.
- **Terse CJK (文言)** — salon ultra-gajere na Sinanci na gargajiya (an ƙuntata shi zuwa `zh`).
- **🎯 Kasafin context mai dacewa** _(ma'auni)_ — maimakon ƙofar token ɗaya ta kunna/bice, ɗaga mafi araha, injunan da ba su da asara kawai har zuwa inda ake buƙata don **samar da dacewa da tagar context na samfurin**. Manufofi: `reserve-output` (tsoho, ya san samfurin) · `percentage` · `absolute`. Yanayi: `floor` (tabbatar da dacewa) · `replace-autotrigger` (zaɓin ku na sarif yana nasara) · `off` (ƙofar gado).
- **🎛️ Inda ake yanke shawarar matstsawa** _(fifiko, sama → ƙasa)_ — header na kowace buƙata `x-omniroute-compression` › override na routing-combo › profile mai suna da ke aiki › dacewa / auto-trigger › tsohon panel › kashe. Tsarin da aka yi amfani da shi yana dawowa a cikin header na amsa `X-OmniRoute-Compression: ; source=`.
Kunna ta atomatik ta ƙofar token, kunna ma'aunin dacewa, kafa profile mai suna, saita na lokaci ɗaya ga kowace buƙata, ko sanya pipeline ga kowace routing combo — duk wanda ya dace da aikin. **Eval harness** na zaɓi mara layi (`npm run eval:compression`) yana ƙididdige aminci vs. tanadi a kan corpus da aka kafa kafin ku inganta canji.
📖 [`COMPRESSION_GUIDE.md`](docs/compression/COMPRESSION_GUIDE.md) · [`RTK_COMPRESSION.md`](docs/compression/RTK_COMPRESSION.md) · [`COMPRESSION_ENGINES.md`](docs/compression/COMPRESSION_ENGINES.md)
# ⚡ Fara da Sauri
**1) Shigar & gudana**
```bash
npm install -g omniroute
omniroute
```
> 💡 Kuna ganin `npm warn ERESOLVE` ko gargaɗin peer-dep? [Ba su da illa](docs/guides/TROUBLESHOOTING.md#npm-install-warnings-eresolve--peer--deprecated).
> **Kuna amfani da npm 11 ko na baya?** npm na iya toshe rubutun lifecycle na fakiti sai in an ba su izini. Ana buƙatar `postinstall` na OmniRoute (`node scripts/build/postinstall.mjs`) don shirya fayilolin runtime na asali. Bari fakitocin da aka ambata a gargaɗin npm yayin shigarwa a duniya. Don tsarin fakitin da OmniRoute 3.8.53 ya ba da rahoto:
>
> ```bash
> npm install -g --allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild omniroute
> ```
>
> Don sake amfani da wannan jerin izini don shigarwar duniya ta nan gaba, saita shi sau ɗaya, sannan ku shigar kamar yadda aka saba:
>
> ```bash
> npm config set allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild --location=user
> npm install -g omniroute
> ```
>
> Jerin abubuwan dogaro na iya canzawa tsakanin fitarwa; idan npm ya ba da rahoton jeri daban, yi amfani da sunayen fakiti daga wannan gargaɗi. Ba da izinin fakiti yana ba da damar gudanar da rubutun shigarwa.
> **Kuna amfani da Gemini Web ko wani mai samar da web-cookie?** Fakitin npm yana haɗawa da
> Playwright amma ba binary na Chromium ba. Duba bayanin
> [saita Playwright Chromium](docs/guides/TROUBLESHOOTING.md#gemini-web-and-playwright-chromium)
> kafin yin buƙata ta farko ta mai samar da yanar gizo.
Dashboard a `http://localhost:20128` · API a `http://localhost:20128/v1`.
**2) Haɗa mai samarwa mai cancanta ta amfani da asusun ku**
Dashboard → **Providers** → zaɓi mai samarwa wanda sharuddan sa na yanzu da quota suka dace da yanayin amfanin ku → ƙara maɓallin API ko kammala tsarin asusun sa. Matakan kyauta na iya buƙatar rajista, amincewa, ko hanyar biya. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md); ba a tabbatar da samuwa ba tare da maɓalli ba, kuma an keɓe masu samarwa da aka yi wa alama `tos: avoid` daga `auto` ta tsoho.
**3) Nuna kayan aikin coding ɗin ku**
```txt
Base URL: http://localhost:20128/v1
API Key: [copy from Dashboard → Endpoints]
Model: auto (routes among eligible connections — or choose provider/model)
```
**4) Tabbatar yana aiki**
```bash
curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"
```
Ya kamata ku ga samfurori da kuka haɗa an jera su. 🎉 Shi kenan — fara coding, kuma OmniRoute yana auto-routing & fallback a gare ku.
Idan abokin cinikin ku ba zai iya aika alamu na al'ada ba, OmniRoute kuma yana bayyana aliases na dacewa masu alama:
```txt
OpenAI catalog: http://localhost:20128/vscode/YOUR_KEY/
OpenAI models: http://localhost:20128/vscode/YOUR_KEY/models
OpenAI chat: http://localhost:20128/vscode/YOUR_KEY/chat/completions
OpenAI responses: http://localhost:20128/vscode/YOUR_KEY/responses
Ollama chat: http://localhost:20128/vscode/YOUR_KEY/api/chat
Ollama tags: http://localhost:20128/vscode/YOUR_KEY/api/tags
```
Yi amfani da waɗannan kawai ga abokan ciniki da ba za su iya haɗa `Authorization: Bearer ...` ba. Auth na header ya kasance hanyar da aka fi so.
## 📦 Ƙarin hanyoyin girkawa — Docker, tushe, pnpm, Arch
**🐳 Docker**
```bash
docker run -d --name omniroute --restart unless-stopped --stop-timeout 40 \
-p 127.0.0.1:20128:20128 -v omniroute-data:/app/data diegosouzapw/omniroute:latest
```
`:latest` yana bin mafi girman tsayayyen SemVer da aka **wallafa**. Ba ya bin git `main`. Saka takamaiman `:X.Y.Z` don GitOps. Duba [Tashoshin Fitarwar Docker](docs/guides/DOCKER_GUIDE.md#release-channels).An saita hoton zuwa **`OMNIROUTE_MEMORY_MB=1024`**. Wannan ya isa ga dashboard da hira marar nauyi. **Wakilan coding** (`POST /v1/responses` daga Claude Code, Codex, Grok, …) suna buƙatar V8 heap mafi girma sosai, in ba haka ba tsarin zai yi `FATAL ERROR` a kusan 12 GiB yayin da dogayen contexts guda biyu suka zo lokaci guda. Saita girman container sama da heap (native buffers suna wajen V8):
| Nauyin aiki | Heap (`-e OMNIROUTE_MEMORY_MB`) | Container (`--memory`) |
| ------------------------------------------ | ------------------------------- | ---------------------- |
| Dashboard / hira marar nauyi | `1024` (tsohon saitin hoton) | ≥2 g |
| Wakilin coding guda ɗaya | `8192` | ≥10 g |
| Dogayen `/v1/responses` biyu a lokaci guda | `10240`–`12288` | ≥12–16 g |
```bash
docker run -d --name omniroute --restart unless-stopped --stop-timeout 40 \
-e OMNIROUTE_MEMORY_MB=8192 --memory=10g \
-p 127.0.0.1:20128:20128 -v omniroute-data:/app/data diegosouzapw/omniroute:latest
```
Cikakken jadawali: [Jagorar Docker — RAM na lokacin aiki](docs/guides/DOCKER_GUIDE.md#runtime-ram-for-coding-agents).
> **Tashar Docker ta kafin fitarwa:** `diegosouzapw/omniroute:next` da
> `diegosouzapw/omniroute:next-web` suna bin reshen `release/v*` na yanzu wanda ake amfani da shi ta tsoho.
> Waɗannan tags masu sauyawa an tanade su ne kawai don gwada gyare-gyaren da ba a fitar ba kuma
> **ba a goyon bayansu don production**. Duba
> [Tashoshin Fitarwar Docker](docs/guides/DOCKER_GUIDE.md#release-channels).
**🥟 Bun**
Ana goyon bayan daidaitaccen `bun install` da girkawa ta global (`bun install -g omniroute`) ta hanyar gano Bun runtime:
- **Ginannen `bun:sqlite`**: OmniRoute yana amfani da ginannen driver na Bun mai suna `bun:sqlite` lokacin da yake gudana ƙarƙashin Bun, sannan ya koma amfani da `better-sqlite3` a Node.js ko `sql.js`.
- **Zaɓin Webpack bundler ta atomatik a dev**: Development (`bun run dev`) yana gano Bun ta atomatik kuma ya kashe Turbopack don amfani da Webpack domin hana rashin jituwa da native V8 bindings. Production builds (`bun run build`) suna bin `OMNIROUTE_USE_TURBOPACK` daidai kamar a Node: Turbopack ta tsoho, `OMNIROUTE_USE_TURBOPACK=0` don yin build da Webpack (`Dockerfile.bun` yana samar da shi a matsayin `--build-arg`).
- **Dockerfile na musamman don Bun**: `Dockerfile.bun` mai matakai da yawa don native Bun production deployments (`docker build -f Dockerfile.bun -t omniroute:bun .`).
```bash
# Girka kuma gudanar da Bun
bun install
bun run dev
```
**🛠️ Daga tushe**
```bash
cp .env.example .env && npm install
PORT=20128 npm run dev
```
**📦 pnpm**
```bash
pnpm add -g omniroute@latest --allow-build=better-sqlite3 --allow-build=@swc/core && omniroute
```
**🐧 Arch Linux (AUR)**
```bash
yay -S omniroute-bin && systemctl --user enable --now omniroute.service
```
**🔧 Nix (Flake)**
```bash
# Amfani da Nix flakes
nix develop
npm run dev
# Ko amfani da devbox
devbox run npm run dev
```
📖 [Jagorar Docker](docs/guides/DOCKER_GUIDE.md) — Compose profiles, Caddy HTTPS, Cloudflare tunnels.
**🦭 Podman**
```bash
# 1. Shirya kundin bayanan da aka haɗa ta bind mount
mkdir -p data
# 2. Linux + local rootless Podman kawai (kar a taɓa amfani da remote Podman Machine client):
podman unshare chown 1000:1000 ./data
# 3. Saita alamar runtime, gina local Compose image, sannan fara
echo "CONTAINER_HOST=podman" >> .env
podman compose --profile base up -d --build
```
A macOS ko Windows, Podman yana amfani da remote Podman Machine: tsallake `podman unshare` kuma
bi [jagorar kundin bayanai bisa topology](contrib/podman/README.md#data-directory-permissions-by-topology).
📖 [Jagorar Podman](contrib/podman/README.md) — Compose builds, Podman Machine, da
saitin Linux/systemd Quadlet.
**⚡ Girkawa mafi sauri / marar nauyi (tsallake native build)**
Native SQLite engine (`better-sqlite3`) dependency ne na **zaɓi**, don haka global
install ba ya taɓa tsayawa yana jiran compilation daga tushe: yana amfani da prebuilt binary idan akwai wanda ya dace da
platform/Node ɗinka, idan kuma babu sai ya koma kai tsaye zuwa pure-JS engine
(`node:sqlite` a Node 22+, in ba haka ba bundled `sql.js` WASM) — ba a buƙatar build tools.
Don tsallake native warm-up na bayan girkawa gaba ɗaya (CI, headless, ko na'urori masu jinkiri):
```bash
OMNIROUTE_SKIP_POSTINSTALL=1 npm install -g omniroute # CI=1 shi ma yana tsallake shi
```
Don girkawa mafi sauri, fi son **pnpm** (content-addressed store + hard links — duba sama).
Don runtime marar dashboard kuma headless, yi amfani da Docker `base` profile (a sama) ko
[jagorar Termux](docs/guides/TERMUX_GUIDE.md). CLI da web dashboard ana samar da su ne ta
tsari guda a port guda, don haka babu wani package na CLI-kawai a halin yanzu.
Dabarun rufe gwaji don bayanan gwaji na tsayayye sama da 56,000 a fayilolin gwaji sama da 7,800 da ake bibiya
# ⭐ Manyan Masu Ba da Gudummawa
> Al'ummar buɗaɗɗiyar tushe mai himma ce ta kafa OmniRoute. Waɗannan mutanen sun ba da gudummawa na musamman waɗanda ke da tasiri kai tsaye ga inganci, kwanciyar hankali, da fadɗaɗɗen aikin. **Na gode.**
### Masu ba da gudummawa na waje ta haɗaɗɗun pull requests
An yi ƙidayar a 2026-10-18 15:09:09 UTC tare da ƙarshen release/v3.8.52 mai rayuwa 656f01cb43. Ƙidayar GitHub GraphQL mai shafi-shafi tana ƙunshe da haɗaɗɗun PRs 9,191: 3,834 daga mai ma'ajiyar, 229 daga Dependabot, 6 daga sauran bots/apps, kuma PRs na waje 5,122 daga masu ba da gudummawa daban-daban 835. "Layukan da aka canza" shi ne GitHub additions + deletions kuma ya ƙunshi fayilolin da aka samar, lockfiles, catalogs, fassarori da takaddun; shi ne churn, ba LOC da aka rubuta ba. PRs 49 sun ba da rahoton GitHub diffs sama da layi 500,000 (misali #13399, ƙara mai samar guda ɗaya, ya jera fayiloli 2,347 da aka canza), wanda ya ƙara adadin wasu lambobin da ke sama. Ana daraja daidaitattun tare.
### Commits da aka danganta ga GitHub
An sake duba a 2026-10-18 14:44:45 UTC: commits da GitHub ta danganta wanda Contributors API na ma'ajiyar ya ba da rahoto ga tsohon reshe release/v3.8.52. API ya dawo da keɓaɓɓun bayanai 849 (masu amfani 429, bots 2, marasa suna 418); wannan teburin ya cire mai kula da aikin, bots da keɓaɓɓun marasa suna, kuma ya riƙe daidaiton gasar. Ya bambanta da duka jerin matsayin PR da aka haɗa da ke sama da kuma ƙidayar Git-metadata da ke ƙasa.
> 🙏 Fasalolin da waɗannan masu bayar da gudummawa suka kawo, gyaran kura-kurai, da gyare-gyaren kayayyakin more rayuwa sune **babban ɓangare** na abin da yake sa OmniRoute zama abin dogaro kuma mai cike da fasaloli. Kowane pull request, kowane test case, da kowane fayil na fassarar i18n yana da muhimmanci. Mutane irin nasu ne suke gina buɗaɗɗen tushe.
---
## 💖 Masu Tallafawa
Godiya ta musamman daga zuciya ga mutanen da ke ɗaukar nauyin OmniRoute daga aljihunsu — kowace gudummawa tana taimaka wa aikin ya ci gaba da kasancewa kyauta, mai cin gashin kansa kuma yana tafiya gaba.
… da sauran waɗanda suka fi son kasancewa a ɓoye 💛An sake tabbatar da masu tallafawa na GitHub na jama'a a ranar 2026-10-18 ta hanyar GitHub Sponsors GraphQL API: tallafi 11 na jama'a (6 masu ci gaba, 5 na baya) daga jimillar 14. Matsayin isActive na GitHub ne ke ƙayyade alamun masu ci gaba da ke sama; ana ci gaba da yi wa tsoffin masu tallafawa na jama'a na lokaci ɗaya godiya, yayin da masu tallafawa na sirri ke kasancewa ba tare da bayyana sunayensu ba. Ba a jera gudummawar Ko-fi, Buy Me a Coffee, Liberapay, PIX da crypto ba saboda ba su da bayanan mai tallafawa na jama'a.💖 Zama mai tallafawa → — kowace dala tana taimaka wa OmniRoute ya ci gaba da kasancewa kyauta kuma mai cin gashin kansa.
## 👥 Masu Ba da Gudummawa 900+
[](https://github.com/diegosouzapw/OmniRoute/graphs/contributors)
An gudanar da bincike a ranar 2026-10-18 a kan ƙarshen release/v3.8.52 na kai-tsaye, wato ad160ab2d1 (commits 6,826): asalin mutane 993 na Git da aka daidaita — 707 sun bayyana a matsayin marubutan commit (ciki har da mai kula da aikin), yayin da 286 suka bayyana ne kawai a cikin alamomin Co-authored-by da aka bayyana kai tsaye. Ƙidayar tana amfani da .mailmap, tana kwatanta adiresoshin imel ba tare da la’akari da bambancin manyan da ƙananan haruffa ba, tana haɗa adiresoshin GitHub noreply masu lambobi da na rubutu kawai idan suna wakiltar suna iri ɗaya, tana ware asalin bots/agents/services/placeholders guda 26, kuma ba ta haɗa adiresoshin imel na yau da kullum kawai saboda sunayen da suke nunawa sun yi daidai ba. Binciken ranar 2026-08-24 ya wallafa 639; sake gudanar da wannan hanyar a kan tushen binciken nan na ac02c5b42f ya ba da 619, don haka ƙaruwar ta samo asali ne daga sababbin masu ba da gudummawa, ba daga sassauta hanyar ba.
### Yadda Ake Ba da Gudummawa
1. Yi fork na ma’ajiyar
2. Ƙirƙiri reshe daga ƙarshen **mai aiki** na `release/vX.Y.Z` (ba `main` ba) — duba [Tsarin Reshe da Fitarwa](docs/ops/BRANCHING_MODEL.md)
3. Ƙirƙiri reshen fasalinka (`git checkout -b feat/amazing-feature`)
4. Yi commit na sauye-sauyenka (`git commit -m 'feat: add amazing feature'`)
5. Tura zuwa reshen (`git push origin feat/amazing-feature`)
6. Buɗe Pull Request mai **base = wannan reshen `release/vX.Y.Z`**
Duba [CONTRIBUTING.md](CONTRIBUTING.md) don cikakkun jagorori.
### Fitar da Sabuwar Siga
```bash
# Ƙirƙiri fitarwa — npm publish zai gudana ta atomatik
VERSION=x.y.z
gh release create "v${VERSION}" --title "v${VERSION}" --generate-notes
```
## 📊 Taurari
## 🌍 StarMapper
## 🙏 Godiya
OmniRoute ya ginu ne a kan ayyukan manyan da suka gabata. Ya fara ne a matsayin reshen **[9router](https://github.com/decolua/9router)** da kuma sauya aikin Go na **[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)** zuwa TypeScript — daga nan kuma, kowane ƙaramin tsarin da ke ƙasa ya samo wahayi daga wani aikin buɗaɗɗen tushe da ya riga ya cim ma hakan. Kowannensu ya taimaka wajen tsara wani takamaiman ɓangare na OmniRoute. Wannan ita ce godiyarmu gare su baki ɗaya. 🙏
> ⭐ an tabbatar da yawan taurari daga REST API na GitHub a ranar 18 ga Oktoba, 2026 — ku je ku ba waɗannan ayyukan tauraro. Adadin ainihin hoton bayanai ne na wannan ranar kuma zai sauya a zahiri.
### 🧬 Asali & ƙofa
Ƙofar AI wadda bayanan farashinta na jama'a ke ciyar da daidaitawar bin diddigin kuɗinmu, kuma tsarin daidaita masu samarwarta ya taimaka wajen tsara hanyar isar da buƙatunmu.
An daidaita tushen MIT zuwa gadar ChatGPT Web → Codex Responses da aka haɗa cikin aikin, ciki har da adaftocin zaman burauza, tsara amsa, amfani da binciken yanar gizo.
An ɗauko tsarukansa zuwa dawo da yawo, laƙaban rashin-tunani, binciken yanar gizo na madadin, iyakokin taga mai motsi, ɓoye bayanai a rajista da ingantattun hanyoyin ƙaddamarwa.
An daidaita taswirar samfurin Grok ɗinsa, janareton Statsig na fake-TypeError, tsoffin saitunan buƙata da na'ura, da mai sarrafa amsar NDJSON zuwa mai aiwatar da Grok Web na OmniRoute.
Babban tushen lambar da aka gada a bayan grok2api-merged; an adana aiwatarwar samfurinsa, kanunsa, payload, Statsig da masu sarrafawa a cikin asalin Grok Web.
Asalin tushen MIT na payload na Grok da tsoffin saitunan na'ura, janareton Statsig, da mai sarrafa result.response da aka gada ta TQZHR da grok2api-merged.
Wani tushen da aka gada wanda grok2api-merged ya ambata saboda shimfiɗar proxy-pool ɗinsa; OmniRoute yana riƙe wannan sanarwar asali amma baya ikirarin ɗauko proxy-pool a cikin iyakantaccen mai aiwatar da Grok Web nasa.
Aiwatarwar Grok Web ta asali ta yi amfani da ƙirar HTTP/burauza ta uwar garken sama; hanyarta ta HTTP kai tsaye ta samo asali daga GrokProxy, don haka ba a ikirarin ɗauko lamba mai zaman kanta ba.
Shahararren aikin "me ya sa a yi amfani da token da yawa alhali kaɗan za su yi aikin" — falsafar maganar mutumin kogo tasa ce ke ƙarfafa yanayin matsawar mu na yau da kullum da dokokin cire kalmomin cikewa/tattara bayanai sama da 30.
Binciken matsawar umarni (LLMLingua / LLMLingua-2) — ya zaburar da injin llmlingua ɗinmu mai aiki ba tare da jira ba, mai kiyaye lamba, kuma mai ci gaba da aiki idan ya gaza.
Matsawar token ta PT-BR — ita ce ke ƙarfafa fakitin harshen pt-BR ɗinmu: rage maimaita ma’ana da cire kalmomin cikewa da aka daidaita don nahawun Fotigal na Brazil.
Shahararriyar ƙwarewar mai rubuta lambar YAGNI ta "babban mai haɓakawa malalaci" — ta zaburar da Salon Fitarwa na less-code: jagorantar mafi ƙarancin canjin da zai yi aiki wanda ke rage lambar da aka _samar_ (takwaran ɓangaren fitarwa na taƙaitacciyar maganar Caveman).
Tsarin jadawalinsa mai taƙaituwa da ƙirar bayanin martaba na gama-gari sun taimaka wajen tsara taƙaita jadawalin OmniRoute da tsarin codec na Headroom.
Matsawar fitarwa mai fahimtar abun ciki bisa kowane nau’in fayil tare da janyewa idan aka samu gazawa — ya tabbatar da rarrabawar mu bisa kowane nau’i da tsallake matsawa idan ribar ta yi ƙasa da mafi ƙaranci.
"Nemo token na fatalwa" — tsarin tura bayanai waje + makama da za a iya amfani da shi wajen dawo da su ya taimaka wajen tsara tunaninmu game da tura bayanai waje ta CCR.
JSON na ginshiƙan Rust + dawo da bayanai bisa adireshin abun ciki + cire maimaituwa tsakanin saƙonni — ya tabbatar da ƙirar injinan headroom/ccr/session-dedup ɗinmu da ƙa’idar ma’ajiyar wucin gadi mai ɗorewa cewa "siffar da aka matsa ba ta dogara da matsayi".
Jera taswirar ma’ajiyar lamba irin ta Aider bisa muhimmanci — ya taimaka wajen bincikenmu kan taswirar ma’ajiya / jera dawo da bayanai bisa muhimmanci.
Tsarewa/binciken MITM na zirga-zirgar mataimakin shirye-shirye ↔ LLM ya taimaka wajen tsara buƙatun farko na Traffic Inspector. An maye gurbin kayayyaki huɗu da aka samo a baya — haɗa SSE, daidaita tattaunawa, ɓoye sirri da tsabtace headers — da aiwatarwa masu zaman kansu da aka gina daga tushe bisa ƙa'idodin yarjejeniya na jama'a. Fuskokin host-passthrough guda biyu (passthrough.ts da _internal/bypass.cjs) sun ci gaba da kasancewa aiwatarwa na cikin OmniRoute waɗanda aka rarraba su daban; ba a sake rubuta su a matsayin wani ɓangare na wannan sauyawar ba.
Jagorantar proxy ga kowane process a bayyane — ya zaburar da kashe MITM cikin aminci idan aka samu rushewa, wa'adin rashin aiki na socket, danganta process ta /proc da kama zirga-zirga ta TPROXY.
Ya gano fuskar ƙayyadadden amfani ta Grok Build; daga nan OmniRoute ya tabbatar tare da gyara tsarin bayanan da ake watsawa kai tsaye da kansa.
## 📄 Lasisi
Lasisin MIT - duba [LICENSE](LICENSE) don ƙarin bayani.
---
**[⬆ Koma sama](#-omniroute)** · An gina shi da ❤️ don al'ummar AI ta buɗaɗɗen tushe.
OmniRoute v3.8.53 · Node ≥22.22.2 · Lasisin MIT · omniroute.online