## 💰 ~1.62B Tokens / Wata a Faɗin Matakan Kyauta na Wasu Kamfanoni
> **Kawo asusun masu samar da sabis naka.** Wannan ƙiyasin jimilla ne daga matakan kyauta na wasu kamfanoni waɗanda ake samun cancantarsu daban-daban, ba tallafin tokens daga OmniRoute ba ne. Yi rajista, samo bayanan shiga inda ake buƙata, sannan ka haɗa masu samar da sabis da za ka iya amfani da su; kowane mai samar da sabis ne ke sarrafa iyakokinsa, samuwarsa, da sharuɗɗansa.
>
> Haɗa matakan kyauta da hannu abu ne mai wahala — SDKs da dama, iyakokin ƙimar amfani da dama, kuma ba ka san ainihin adadin da kake da shi ba. OmniRoute yana lissafa **shigarwar matakan kyauta 489 a faɗin maɓallan rumbun amfani masu maimaituwa 35** kuma yana ƙididdige babban adadin tokens daga **rumbuna 17 masu ingantaccen kasafin wata da aka wallafa tare da iyakokin Groq guda biyar na kowane model**, bayan cire maimaitawa bisa rumbun da aka raba. Quotas waɗanda ba sa buɗewa sai bayan tantance shaidar yanki (a yau: ModelScope) ana nuna su daban, +~6M bayan tantance shaidar yanki, kuma ba a taɓa haɗa su cikin babban adadin ba. Sakamakon yana ci gaba da bayyana a dashboard (`/dashboard/free-tiers`).
> Taƙaitaccen bayani mai motsi na shafin `/dashboard/free-tiers` kai-tsaye. Cikakkiyar hanyar ƙididdiga (cire maimaitawar rumbuna, matakan credits, sharuɗɗan masu samar da sabis): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
> Ana sake binciken waɗannan alkaluma kowane mako biyu ta hanyar kwatanta su da kundin kai-tsaye kuma **suna motsawa ta ɓangarorin biyu** — idan mai samar da sabis ya kawo ƙarshen matakin kyauta, adadin yana raguwa; idan sabo ya shigo, yana ƙaruwa. Muna wallafa abin da kundin yake ƙididdigewa a zahiri, ba mafi kyawun yanayin da aka ɗaga adadinsa ba.
⭐ Ba wa repo tauraro 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 aikin — ka fara samun sababbin masu samar da sabis, fitowar sababbin nau'o'i da 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, shawarwarin masu samar da sabis, taswirar ci gaba da tallafi → [Discord](https://discord.gg/U47eFqAXCn) · [Telegram](https://t.me/omnirouteOficial) · WhatsApp [🌍 Na Duniya](https://chat.whatsapp.com/FvuCbrpZmQ6I85n2vW5QIC?s=cl&p=a&mlu=4) / [🇧🇷 Brazil](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 Tana Ci Gaba da Faɗaɗa
| | v3.8.50 | **v3.8.51** | `v3.8.52+` |
| -------------------------------------------- | :----------------------: | :---------: | :-------------------: |
| 🌐 Masu samarwa | 352 | **358** | 372 |
| 🧠 ID na samfurin hira na musamman | 1320 | **1374** | 1443 |
| 🖼️ Gadar nau'in bayanai | 🆕 gani + sauti + bidiyo | ✓ | ✓ |
| 📡 Kundin Radar na kyauta | 🆕 sai an zaɓa | ✓ | ✓ |
| ⚖️ Tsarawa bisa la'akari da ƙayyadadden kaso | 🆕 Quota-Share | ✓ | ✓ |
| 📊 Bayanan ma'aunin ƙayyadadden kaso | 🆕 kai-tsaye | ✓ | ✓ |
| 🧰 Yanayin mara fuskar mai amfani | — | — | 🆕 `serve --headless` |
| 🛤️ Ababen more rayuwa na layin LTS | — | — | 🆕 tashoshin fitarwa |
**→ [Taswirar ci gaba](ROADMAP.md) — bin layin zuwa `v3.9.0 LTS`**
## 🆓 Girka, haɗa mai samarwa, sannan ka bi ta hanyar endpoint guda ɗaya
```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 hanyar da ta cancanta. Sabuwar girkawa na iya kasancewa ba ta da wuraren zuwa marasa maɓalli da suka cancanta, kuma mai samarwa mara maɓalli na iya ƙin amincewa da manhajojin ɓangare na uku. Masu samarwa da aka yi wa alamar `tos: avoid`, ciki har da OpenCode Free da Kiro, ba a saka su cikin zaɓin hanya na atomatik ta tsohuwa; haɗa asusu ba ya soke wannan saitin. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md) kafin zaɓar mai samarwa.📦 Skrifofin farawa cikin sauri na kwafa-da-liƙawa don **Python, Node.js, PHP, da cURL** → [`examples/quickstart/`](examples/quickstart/)
# 💥 Alkawarin
# 🤔 Me ya sa 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.
## 🎯 Combos — Babban Ginshiƙi
> **Combo** jerin models ne da OmniRoute ke bi ta cikinsu **ta atomatik**. Idan quota ta ƙare, provider ya gaza, ko farashi ya yi tashin gwauron zabi, combo na iya matsawa zuwa model mai inganci na gaba wanda ya cancanta. 🛡️
### ⚡ Babu saiti — kawai yi amfani da `auto`
Babu buƙatar ƙirƙirar combo. Saita model ɗinka zuwa `auto` (ko wani nau'insa), sannan OmniRoute ya gina combo na kama-da-wane daga providers ɗin da ka haɗa, tare da kimanta 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
🧑💻 Nauyin da ke fifita inganci wajen samar da code
auto/fast
⚡ Mafi ƙarancin jinkiri da farko
auto/cheap
💰 Mafi arha ga kowane token da farko
auto/offline
🔋 Mafi yalwar quota / sararin rate-limit da farko
auto/smart
🔭 Fifita inganci + bincike na 10% don gano models mafi kyau
auto/lkgp
📌 Mannewa kai-tsaye ga provider na ƙarshe da aka san yana aiki
auto/chaos
🧪 Watsawa a layi ɗaya zuwa rukunin models (ɗaya ga kowane provider, 5 a matsayin tsoho), sannan ya dawo da amsa ɗaya; kira ɗaya na upstream ga kowane model na rukunin, ba shigar da kuskure ba
##
### 🔀 Ko kuma ka gina naka — dabarun tura buƙata guda 19
Dukkan dabarun **19** — haɗa su yadda kake so a kowane matakin combo:
#
Dabara
Abin da take yi
1
priority
Jerin da aka tsara bisa wanda aka fara nufi — a ƙare kowane ɗaya kafin na gaba 🥇
2
fill-first
Cika quota ta kowane maƙasudi gaba ɗaya kafin matsawa zuwa na gaba
3
weighted
Zaɓin bazuwar mai nauyi bisa nauyin kowane maƙasudi
4
round-robin
Bi ta cikin maƙasudai bi da bi cikin tsari
5
p2c
Daidaita nauyi ta bazuwar zaɓi-biyu
6
least-used
Zaɓi maƙasudin da ke da mafi ƙarancin nauyi a halin yanzu
7
random
Zaɓin bazuwar da ya yi daidai (an cire maimaituwa)
8
strict-random
Bazuwar ba tare da cire maimaituwa ba 🎲
9
cost-optimized
Rage $ ga kowace buƙata bisa farashin kundin kai-tsaye 💸
10
headroom
Zaɓi maƙasudin da ya fi saura da quota
11
reset-window
Fifita maƙasudin da za a sake saita lokacin quota ɗinsa nan ba da jimawa ba
12
reset-aware
Jera bisa lokacin sake saitin quota — gajerun lokuta da farko 📊
13
context-relay
Miƙa mahallin tattaunawa tsakanin maƙasudai don dogayen tattaunawa 🧠
14
context-optimized
Zaɓi wanda ya fi dacewa da girman mahallin yanzu
15
cache-optimized
Ɗaure kowane farkon prompt da za a iya sake amfani da shi ga account ɗaya — ƙara yawan dacewar prompt-cache 🎯
16
lkgp
Last-Known-Good Path — yana ɗaurewa ga provider na ƙarshe da ya yi nasara, sannan ya koma ga ƙa'idoji idan ya gaza
17
auto
Kimantawa kai-tsaye bisa abubuwa 16 a dukkan haɗin sadarwa 🤖
Haɗa matakai — sakamakon kowane maƙasudi yana shiga na gaba 🔗
Injin Auto-Combo yana kimanta kowane ɗan takara bisa **abubuwa 16** (lafiya, quota, farashi, jinkiri, dacewa da aiki, inganci, samuwar zama…) — duba [`docs/routing/AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md).
##
### 🧱 An gina juriya a ciki (matakai masu zaman kansu guda 3)
📖 [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)**.
## ✨ Sabbin Abubuwa
> Muhimman sabbin abubuwa daga **v3.8.20 → v3.8.50**. Cikakken tarihin yana cikin [`CHANGELOG.md`](CHANGELOG.md).
- **🎛️ OmniConductor** — karɓar wakilcin A2A zuwa rundunar wakilanka, ƙwarewar Conductor a kan Agent Card, da kuma allon gudanarwa mai tattaunawar murya ta danna-ka-yi-magana ta Faro. → [Sabar A2A](docs/frameworks/A2A-SERVER.md)
- **🛂 Karɓa mai daidaitawa & kariyar cunkoso** — manyan buƙatun taɗi suna shiga jerin jira maimakon mayar da 503, tare da hayar RPM mai juyawa ta atomatik ga kowace haɗi. → [Jagorar Juriya](docs/architecture/RESILIENCE_GUIDE.md)
- **🗂️ Tsararren jeri na `/v1/models`** — katanga guda mai ci gaba da aka tara bisa mai bayarwa ga kowane mai bayarwa (ana fara liƙa combos), mai daidaito a duk wata tushen kasida. → [Manunin API](docs/reference/API_REFERENCE.md)
- **🗜️ Ƙarfafa matse bayanai** — kariyar faɗaɗa da take kunne ta tsohuwa, fakitin Caveman don DE / FR / JA + Sinanci (wényán), matatan RTK don Gradle & .NET. → [Matse Bayanai](docs/compression/COMPRESSION_ENGINES.md)
- **💸 Gaskiyar kuɗin farashi-tsayayye** — masu bayarwa na biyan kuɗin rajista / coding-plan suna nuna **$0** a nazarin kuɗi; kasafi, ƙayyadadden amfani & zaɓen hanya suna ci gaba da yin ƙiyasta. → [Manunin API](docs/reference/API_REFERENCE.md)
- **⚖️ Zaɓen hanya na Quota-Share** — raba ƙayyadadden amfanin asusun gama-gari cikin adalci tsakanin maɓallan da aka tara, tare da kiyaye aiki ta yadda ake ba da rabe-raben da ba a amfani da su aro. → [Jagorar Juriya](docs/architecture/RESILIENCE_GUIDE.md)
- **🤖 Saita CLI/wakili da umarni guda** — umarnin `setup-*` guda 13 da aka yi wa rajista; `omniroute run` yana ƙaddamar da CLI guda 7 (Claude Code, Codex, Aider, Goose, OpenCode, Qwen Code, Gemini CLI); `omniroute configure` yana tallafa wa wurare 10 tare da mai zaɓen mai bayarwa+samfuri na mu'amala da abubuwan da aka fi so na kowane mahalli. → [Haɗaɗɗun CLI](docs/guides/CLI-INTEGRATIONS.md)
- **🛰️ Yanayin nesa** — sarrafa OmniRoute na nesa da token masu iyakantaccen iko (`connect` / `contexts` / `tokens`) + mataimakin OAuth na `antigravity` don girkawa a VPS. → [Yanayin Nesa](docs/guides/REMOTE-MODE.md)
- **🧭 Zaɓen hanya ta atomatik mafi wayo** — combos na `auto/:`, **Fusion** (rukunin samfura + alkali), zaɓen hanya bisa aikin da ake yi, da sauya samfuri / yanayi / kasafin-USD ga kowace buƙata. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **🗜️ Matse bayanai mai karɓar tsawo** — injuna 12 masu haɗuwa + Compression Studios: LLMLingua-2, Ultra mai matakai biyu, omniglyph, ƙofar tabbatar da inganci ga kowane mataki, GCF v3.2, da editan ja-ka-sake-tsarawa. → [Matse Bayanai](docs/compression/COMPRESSION_ENGINES.md)
- **🕵️ Bayyanannen warware ɓoyewar MITM (TPROXY)** — kama CLI da suke yin watsi da sauye-sauyen muhallin proxy, tare da CA na kowane SNI + mai girka trust-store. → [MITM/TPROXY](docs/security/MITM-TPROXY-DECRYPT.md)
- **💸 Bayanan kuɗi a ko'ina** — kanun kuɗi/amfani na `X-OmniRoute-*` a kowane endpoint, kanun ajiyar cache-HIT, da ƙayyadadden kashe USD ga kowane maɓalli. → [Manunin API](docs/reference/API_REFERENCE.md)
- **🧠 Ƙwaƙwalwar da kake sarrafawa** — a kashe take ta tsohuwa, quantization na vector na int8 da ake kunna bisa zaɓi + lalacewa mai nau'i, da `x-omniroute-no-memory` ga kowace buƙata. → [Ƙwaƙwalwa](docs/frameworks/MEMORY.md)
- **🛡️ Tsaro** — kariyar prompt-injection a kowace hanyar LLM (rukunin gwajin red-team), shingen rufe bayanan shaidar shiga da ake kunna bisa zaɓi (yana ɓoye maɓallan API/sirrin da suka zube a duka ɓangarori), binciken yanar gizo na DuckDuckGo na ƙarshe kyauta, da ƙofar shiga ta OIDC ta zaɓi don allon gudanarwa (shiga da kalmar sirri kullum yana nan). → [Shingayen Kariya](docs/security/GUARDRAILS.md)
- **🖼️ Sabbin endpoints** — `/v1/ocr` (Mistral OCR) da `/v1/audio/translations` (irin Whisper) sun kammala fagen kafofin watsa labarai. → [Manunin API](docs/reference/API_REFERENCE.md)
- **🎨 Samar da hoto / bidiyo / sauti** — API guda don kafofin watsa labarai: xAI Grok Imagine & bidiyon Novita AI, ComfyUI, Magnific, Adobe Firefly, Segmind, da masu bayar da murya kamar ElevenLabs. → [Manunin API](docs/reference/API_REFERENCE.md)
- **🌍 Turawa & gudanarwa** — `basePath` na reverse-proxy, gano harshen burauza ta atomatik, bin diddigin na'ura ga kowane maɓalli, amincewar MITM ba tare da root ba, da fassarar zh-TW. → [Muhalli](docs/reference/ENVIRONMENT.md)
- **🤝 Ƙarin masu bayarwa & wakilai** — wakilan cloud (Codex Cloud, Cursor, Devin, Jules), Grok Build (xAI) tare da burauza + shiga ta OAuth, katin Ollama na cikakken matsayi, Claude Opus 5 & Sonnet 5, haɗin gwiwar hukuma da Kimi (Code/Web/Moonshot), Zed, Requesty, SenseNova, Yuanbao, Agnes AI… da sabunta **kasidar masu bayarwa 352**. → [Masu Bayarwa](docs/reference/PROVIDER_REFERENCE.md)
- **📡 Bayyananniyar zaɓen hanya** — kowace amsa tana ɗauke da kanun `X-OmniRoute-Decision` da ke bayyana dabarar/mai bayarwa/latency da suka sarrafa ta, sabuwar dabarar combo ta `cache-optimized` + ma'aunin Auto-Combo na `cacheAffinity` suna mayar da maimaitattun buƙatu zuwa haɗin da ke riƙe da prefix ɗin da aka adana, sannan endpoint na karatu-kawai `/v1/auto-combo/{channel}/candidates` yana nuna tarin 'yan takara masu aiki na tashar `auto/*`. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **⚡ Aikin cikin gida & ababen more rayuwa** — Redis na cikin gida da dannawa guda, masu tura relay na Cloudflare Workers / Deno Deploy, da Bifrost & Mux a matsayin ayyukan da aka saka ciki kuma ake sa ido a kansu. → [Ayyukan da Aka Saka Ciki](docs/frameworks/EMBEDDED-SERVICES.md)
- **🧩 Haka kuma a cikin kunshin** — tsarin plugin + kasuwa, tsarin ƙwarewar Omni/Agent/GitHub, haɗaɗɗiyar ma'ajiyar Obsidian (kayan aikin MCP 22), API na Batch & Files masu dacewa da OpenAI, cache na amsa bisa ma'ana, mayar da aiki wasa tare da allunan jagoranci, gano wakili na ACP (wakilai 15 da aka gina a ciki), fitar da log zuwa BigQuery bisa jadawali, `auto/chaos` mai watsa aiki a layi ɗaya zuwa samfura da yawa, gadar bot ta Telegram, mai sarrafa sigar cikin manhaja da jerin martabar masu bayarwa kyauta na LMArena-ELO. → [Takardu](docs/README.md)
## 🤖 CLIs Masu Jituwa & Wakilan Rubuta Lamba
> Saiti guda — `http://localhost:20128/v1` — kuma **kowane** IDE ko CLI na AI yana aiki da samfura kyauta & masu araha.
**Ƙaddamar da kowane CLI mai goyon baya ta hanyar OmniRoute da umarni ɗaya** — ba a rubuta fayilolin saiti,
ana shigar da bayanan shiga ga kowane process, sannan Qwen/Gemini suna samun keɓantaccen kundin gida 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 mai samarwa+samfuri ta hanyar mu'amala sannan ka rubuta saitin kayan aikin:
omniroute configure codex # har ila yau: claude opencode qwen aider goose gemini cline continue kilo
```
Kowane umarni yana bin mahallin nesa 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ɗe-haɗen CLI](docs/guides/CLI-INTEGRATIONS.md)
## 🌐 Masu Samar da AI 372 — 154 Masu Alamar Kyauta a Kundin Bayani
> **Masu samarwa 372 da aka yi wa rajista** a cikin tarin hukuma na taɗi, kafofin watsa labarai, bincike, na gida, wakilan gajimare da tsarin aiki, ciki har da **154 masu ɗauke da metadata na gano `hasFree: true`**. Rajistar samfurin taɗi ta ƙunshi **masu samarwa 237 / haɗe-haɗen mai samarwa da samfuri guda 3,009 / ainihin ID na samfura 1,443**; kundin kasafin kyauta na daban yana da **layuka 491 na kowane samfuri**, **rukunin albarkatu masu sabuntawa 35** da kuma **masu samar da kyauta-har-abada masu sabuntawa/marasa buƙatar maɓalli 54**. Waɗannan ma'aunai ne daban bisa tsari; ma'anoni da lissafin da aka cire maimaituwar rukunin albarkatu suna cikin [Manunin Masu Samarwa](docs/reference/PROVIDER_REFERENCE.md) da [Matakan Kyauta](docs/reference/FREE_TIERS.md).
### 🧩 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 sabar, OmniRoute **cikakken kokfit ne na layin umarni** mai **umarni 80+**, tare da buɗaɗɗun ƙa’idojin wakilai domin wakilin AI ya iya sarrafa shi **da kansa**.
### ⌨️ CLI na gaske (ba kawai `start` ba)
```bash
omniroute # gabatar da ƙofar shiga + dashboard (port 20128)
omniroute chat # abokin hirar TUI mai mu'amala (slash: /model /combo /skill /memory)
omniroute setup # wizard mai jagora don fara amfani
omniroute doctor # gano matsalolin providers, ports, native deps
```
### 🛰️ Yanayin nesa — gudanar da CLI a nan, OmniRoute a kan VPS
OmniRoute yana kan saba? Sarrafa shi daga kwamfutar tafi-da-gidanka da **CLI iri ɗaya**. Shiga sau ɗaya
da scoped access token; daga nan kowace umarni za ta nufi sabar nesa.
```bash
omniroute connect 192.168.0.15 # kalmar sirri → scoped token, an adana shi a matsayin context
omniroute models list # ← yana gudana a kan sabar NESA
omniroute configure codex # ← yana zaɓar model na nesa, yana rubuta Codex profile na cikin gida
omniroute tokens create --name ci --scope read # ƙirƙiri tokens masu ƙuntataccen izini don wasu na'urori
omniroute contexts use default # ← koma zuwa sabar cikin gida
```
An iyakance izinin tokens zuwa `read` / `write` / `admin`; routes da ke ƙaddamar da processes suna ci gaba da kasancewa na loopback kawai.
📖 [Yanayin Nesa](docs/guides/REMOTE-MODE.md)
### 🤝 Haɗa wakili — kuma shi kansa zai sarrafa OmniRoute
Bayyana OmniRoute ta hanyar **MCP**, **A2A**, **REST API**, **webhooks** ko **CLI na nesa** — duk wani wakili mai ƙwarewa (ko lambar shirinka) zai samu mabuɗan sarrafa ɗaukacin ƙofar shiga: routing, providers, combos, cache, compression, memory — kai tsaye. Ana samar da HTTP endpoints da ke ƙasa a ƙarƙashin `http://localhost:20128`.
Haɗin mu'amala
Endpoint / umarni
Yi amfani da shi don
🧰 MCP (stdio)
omniroute --mcp
Haɗawa da Claude Desktop, Cursor, ko kowane MCP client
🌊 MCP (HTTP)
/api/mcp/stream
MCP na nesa — kayan aiki 110, scopes 33 (aiwatarwa na zaɓi ne), cikakken tarihin bincike
📡 MCP (SSE)
/api/mcp/sse
Hanyar jigilar MCP mai gudana kai tsaye
🤝 A2A
/.well-known/agent.json
Wakili-zuwa-wakili, JSON-RPC 2.0 + SSE, ƙwarewa 6
🌐 REST API
/v1/*
Mai dacewa da OpenAI — hira, embeddings, hotuna, sauti, OCR
🔔 Webhooks
/api/webhooks
Tura abubuwan da suka faru na buƙata / quota zuwa Slack, Discord, Telegram ko kowane URL
🛰️ CLI na Nesa
omniroute connect
Sarrafa instance na nesa da scoped access tokens
```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
```
📖 [Sabar MCP](docs/frameworks/MCP-SERVER.md) · [Sabar A2A](docs/frameworks/A2A-SERVER.md) · [Ka’idojin Wakilai](docs/frameworks/AGENT_PROTOCOLS_GUIDE.md)
## 🗜️ Ajiye 15–95% na Tokens — Kai tsaye
### 📖 Yadda yake aiki — pipeline, gine-gine da lissafin tanadi
Haɗin tsoho yana gudanar da `RTK → Caveman`. Idan duka biyun suka yi aiki a kan payload ɗin tool/context iri ɗaya, tanadin yana ninkuwa:
```txt
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
```
Code blocks, URLs, JSON da tsararren bayanai suna samun **kariya koyaushe** daga engine na kiyayewa.
> **Me ya sa za a yi amfani da tokens masu yawa alhali kaɗan za su yi aikin?** Kowace buƙata tana bi ta pipeline na matsawar OmniRoute **a bayyane ba tare da tsangwama ba** — babu sauye-sauyen abokin ciniki. Yanzu ya zama **tarin engines 12 masu iya haɗuwa** waɗanda ke aiki bisa tsari kuma ake gauraya su gwargwadon kowane haɗin routing — 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).
### 🧱 Tarin engines 12
Engines suna aiki bisa tsarin pipeline; ana iya kunna ko kashe kowannensu da kansa, kuma a saita shi ga kowane haɗi:
#
Engine
Abin da yake yi
1
Session-Dedup
Yana cire abun cikin da aka maimaita a tsakanin saƙonni (mai dogaro da abun ciki, tsakanin saƙonni)
2
CCR
Yana adana manyan blocks a bayan alamomin ɗowa, ana samo su idan an buƙata
3
Lite
Gyaran whitespace + image-URL (tushen aiki mai ƙarancin latency)
JSON mai fifita rashin asara + matsawar bayanan bincike mai iyaka don sakamakon shell/patch/search/build (Responses API)
6
Headroom
Taƙaita arrays na JSON zuwa tsarin jadawali ba tare da asara ba (~30%) ta hanyar codec na GCF da aka haɗa
7
Relevance
Kimanta jimlolin da aka ciro bisa ga tambayar mai amfani ta ƙarshe
8
Caveman
Matsawar rubutu bisa dokoki (~65–75% a sakamako)
9
Aggressive
Taƙaitawa + tsufar tsofaffin saƙonni a hankali
10
LLMLingua-2
Zaɓen sassan ma'ana ta ML ta hanyar MobileBERT ONNX — mai kare code, async
11
Ultra
Zaɓen tokens ta heuristic tare da matakin ƙaramin model (SLM) na zaɓi
12
OmniGlyph
Tsarin gwaji na mayar da context zuwa hoto don Claude Fable 5 da aka auna a haɗin Anthropic kai tsaye; transformers na GPT 5.6 suna ci gaba da ƙin aiki ta tsoho har sai an sami takardun tabbatarwa daga mai samarwa. Profiles na matsawa guda huɗu (aggressive na tsoho, balanced, coding-safe, passthrough) (mafi tsauri; sai an zaɓa)
Ana kiyaye Code blocks, URLs da tsararren bayanai **koyaushe** daidai byte-da-byte. **Presets na dannawa sau ɗaya** suna haɗa engines:
Yanayi
Tanadi
Mafi dacewa da
🪶 Lite
~15%
Tsohon zaɓi mai aminci da ke kunne koyaushe
🪨 Standard (Caveman)
~30%
Yin coding na yau da kullum
⚡ Aggressive
~50%
Dogayen sessions masu yawan amfani da tools
🔥 Ultra
~75%
Matsakaicin tanadi
🧰 RTK
60–90%
Sakamakon shell/test/build/git
🔗 Stacked (RTK → Caveman)
78–95%
Haɗaɗɗun prompts + logs na tools
**Misali na ainihi — yanayin Standard:**
> **Kafin (tokens 69):** _"Dalilin da zai sa React component ɗinka yake sake rendering shi ne mai yiwuwa kana ƙirƙirar sabon object reference a kowane render cycle. Idan ka tura inline object a matsayin prop, shallow comparison na React yana ganinsa a matsayin object daban kowane lokaci, wanda ke jawo re-render. Ina ba da shawarar amfani da useMemo don memoize object ɗin."_
>
> **Bayan (tokens 19):** _"Sabon object ref a kowane render. Inline object prop = sabon ref = re-render. Saka shi cikin useMemo."_
>
> **Amsa iri ɗaya. An rage tokens da 72%. Babu asarar daidaito.** ✅
**Misalin PT-BR — yanayin [Troglodita](https://github.com/leninejunior/troglodita):**
> **Kafin (tokens 42):** _"Matsalar ita ce ana sake render ɗin component ɗin saboda ana ƙirƙirar sabon object reference a kowane zagayen render. Ina ba da shawarar amfani da useMemo."_
>
> **Bayan (tokens 12):** _"Sake render: sabon ref a kowane zagaye (an sake ƙirƙirar inline object). Yi amfani da `useMemo`."_
>
> **Amsa iri ɗaya. An rage tokens da ~70%. Daidaiton fasaha bai sauya ba.** ✅
### 🎚️ Bayan engines — salon fitarwa, dial mai daidaitawa & sarrafawa ga kowace request
Engines 12 da ke sama suna rage abin da ke shiga **ciki**. Wasu matakai uku suna tsara **yadda**, **lokacin**, da abin da ke **fitowa**:
- **🪄 Salon Fitarwa** _(jagoranci ta output-axis)_ — suna saka deterministic, cache-safe umarnin tsara amsa; ana iya haɗa su, kowanne yana da ƙarfin `lite` / `full` / `ultra`. Ƙara salo yana buƙatar registry entry na layi guda:
- **Taƙaitaccen bayani** — cire ciko / articles / nuna shakku; kiyaye ainihin bayanin fasaha.
- **Ƙarancin code** — YAGNI na “lazy senior dev”: mafi ƙarancin canjin da ke aiki, babu scaffolding da ba a nema ba.
- **Ponytail (lazy senior dev)** — bi matakan YAGNI, gyara tushen matsalar, yi mafi ƙarancin diff da ke aiki.
- **Ina da ADHD (aiki da farko)** — fara da mataki na gaba, sanya wa matakai lambobi, mataki guda takamaimai na gaba, babu gabatarwa.
- **Taƙaitaccen CJK (文言)** — salon Sinanci na gargajiya mai matuƙar taƙaitawa (an iyakance shi ga locale na `zh`).
- **🎯 Adaptive context-budget** _(dial ɗin)_ — maimakon threshold guda na tokens mai kunnawa/kashewa, yana ƙara amfani da engines mafi arha kuma marasa rasa bayani ne kawai gwargwadon buƙata domin **su dace da context window na model**. Policy: `reserve-output` (tsoho, mai la’akari da model) · `percentage` · `absolute`. Mode: `floor` (tabbatar da dacewa) · `replace-autotrigger` (zaɓinka kai tsaye ne zai yi rinjaye) · `off` (legacy threshold).
- **🎛️ Inda ake yanke shawarar compression** _(fifiko, sama → ƙasa)_ — header na `x-omniroute-compression` ga kowace request › routing-combo override › active named profile › adaptive / auto-trigger › panel default › off. Ana maimaita tsarin da aka yi amfani da shi a cikin response header na `X-OmniRoute-Compression: ; source=`.
Yi auto-trigger ta threshold na tokens, kunna adaptive dial, tsayar da named profile, saita na wucin-gadi ga kowace request, ko sanya pipeline ga kowane routing combo — duk wanda ya dace da aikin. Wani **eval harness** na offline da ake shiga da son rai (`npm run eval:compression`) yana auna fidelity da savings a kan pinned corpus kafin ka ɗaukaka wani 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)
# ⚡ Farawa Cikin Sauri
**1) Shigar & gudanar**
```bash
npm install -g omniroute
omniroute
```
> 💡 Kana ganin `npm warn ERESOLVE` ko gargaɗin peer-dep? [Ba su da illa](docs/guides/TROUBLESHOOTING.md#npm-install-warnings-eresolve--peer--deprecated).
> **Kana amfani da npm 11 ko sabo?** npm na iya hana package lifecycle scripts sai an ba su izini. Ana buƙatar `postinstall` na OmniRoute (`node scripts/build/postinstall.mjs`) domin shirya native runtime files nasa. Ba wa packages da aka ambata a gargaɗin npm izini lokacin global install. Ga jerin packages da OmniRoute 3.8.51 ya bayar:
>
> ```bash
> npm install -g --allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild omniroute
> ```
>
> Domin sake amfani da wannan allowlist a global installs na gaba, saita shi sau ɗaya, sannan ka yi install 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 dependencies na iya sauyawa tsakanin releases; idan npm ya bayar da wani jerin dabam, yi amfani da sunayen packages daga wannan gargaɗin. Ba wa package izini yana ba install scripts nasa damar gudana.
> **Kana amfani da Gemini Web ko wani web-cookie provider?** npm package ɗin yana ɗauke da
> Playwright amma ba ya ɗauke da Chromium binary nasa. Duba bayanin
> [saita Playwright Chromium](docs/guides/TROUBLESHOOTING.md#gemini-web-and-playwright-chromium)
> kafin yin request na farko zuwa web-provider.
Dashboard yana `http://localhost:20128` · API yana `http://localhost:20128/v1`.
**2) Haɗa provider da ya cancanta ta amfani da asusunka**
Dashboard → **Providers** → zaɓi provider wanda sharudda da quota nasa na yanzu suka dace da amfaninka → ƙara API key nasa ko kammala tsarin asusunsa. Free tiers na iya buƙatar signup, approval, ko payment method. Duba [Jagorar Free Tiers](docs/getting-started/FREE-TIERS-GUIDE.md); ba a tabbatar da keyless availability ba, kuma providers masu alamar `tos: avoid` ba sa shiga `auto` ta tsohuwa.
**3) Nuna wa coding tool ɗinka hanya**
```txt
Base URL: http://localhost:20128/v1
API Key: [kwafa daga Dashboard → Endpoints]
Model: auto (yana routing tsakanin eligible connections — ko zaɓi provider/model)
```
**4) Tabbatar yana aiki**
```bash
curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"
```
Ya kamata ka ga jerin models da ka haɗa. 🎉 Shi ke nan — fara coding, kuma OmniRoute zai yi auto-routing & fallback a madadinka.
Idan client ɗinka ba zai iya aika custom headers ba, OmniRoute kuma yana samar da tokenized compatibility aliases:
```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 clients da ba za su iya haɗa `Authorization: Bearer ...` ba. Header auth har yanzu shi ne tsarin 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 ɗaukar gwaji don ayyana gwaje-gwaje tsayayyu sama da 39,000 a cikin fayilolin gwaji sama da 5,100 da ake bibiyarsu
# ⭐ Manyan Masu Ba da Gudummawa
> Ƙwararrun al'ummar buɗaɗɗen tushe masu kishin aiki ne suka tsara OmniRoute. Waɗannan mutane sun ba da gudummawa ta musamman wadda take tasiri kai tsaye ga inganci, kwanciyar hankali, da yaɗuwar aikin. **Mun gode.**
### Masu ba da gudummawa na waje bisa buƙatun ja da aka haɗe
An tsayar da shi a kan ƙarshen release/v3.8.50 mai aiki, wato dafb4ae808, tare da haɗe-haɗe har zuwa 2026-08-24 05:26:03 UTC. Ƙidayar GitHub GraphQL mai shafuka ta ƙunshi PRs 5,911 da aka haɗe: 2,707 daga mai ma'ajiyar, 179 daga Dependabot, da PRs na waje 3,025 daga masu ba da gudummawa daban-daban 535. “Layukan da aka canza” na nufin ƙarin layuka + gogewar layuka na GitHub, kuma ya haɗa da fayilolin da aka samar, lockfiles, kundin bayanai, fassarori da takardu; ma'aunin yawan sauye-sauye ne, ba LOC da aka rubuta ba. An riƙe masu kunnen doki a iyakar jerin.
### Commits da aka danganta da GitHub
Bob.Hou 🏅 commits 51 da aka danganta da GitHub · kunnen doki a #10
Xiangzhe 🏅 commits 51 da aka danganta da GitHub · kunnen doki a #10
An sake dubawa a 2026-08-24 06:14:31 UTC: commits da aka danganta da GitHub waɗanda Contributors API na ma'ajiyar ya bayar don tsohuwar reshen release/v3.8.50. API ɗin ya dawo da shaidu 525 (masu amfani 415, bots 2, marasa suna 108); wannan teburin bai haɗa da mai kula da aikin, bots da marasa suna ba, kuma ya riƙe matsayin kunnen doki. Ya bambanta da duka jerin matsayin merged-PR na sama da ƙidayar mutane 639 ta metadata na Git da ke ƙasa.
> 🙏 Sabbin fasaloli, gyaran kurakurai, da inganta ababen more rayuwa da waɗannan masu ba da gudummawa suka yi, **ɓangare ne na asali** na abin da ke sa OmniRoute ya zama abin dogaro kuma mai yalwar fasaloli. Kowace pull request, kowane test case, da kowane fayil na fassarar i18n suna da muhimmanci. Mutane irinsu ne suke gina manhajar buɗaɗɗiyar tushe.
---
## 💖 Masu Tallafawa
Godiya ta musamman 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 a ɓoye sunayensu 💛An sake tabbatar da Masu Tallafawa na GitHub na jama'a a ranar 2026-08-24. Matsayin activeOnly na GitHub ne ke ƙayyade alamun masu aiki da ke sama; ana ci gaba da gode wa masu tallafawa na sau ɗaya da aka bayyana ga jama'a a baya, yayin da masu tallafawa masu zaman kansu ke ci gaba da kasancewa ba tare da bayyana sunayensu ba.💖 Zama mai tallafawa → — kowace dala tana taimaka wa OmniRoute ya ci gaba da kasancewa kyauta kuma mai cin gashin kansa.
## 👥 Masu Ba da Gudummawa Sama da 600
[](https://github.com/diegosouzapw/OmniRoute/graphs/contributors)
An bincika a ranar 2026-08-24 a tabbataccen tushe ac02c5b42f, sannan aka sake dubawa a ƙarshen release/v3.8.50 mai gudana mai alamar dafb4ae808: sanannun asalin Git na mutane 639 da aka daidaita — 407 sun bayyana a matsayin marubutan commit (ciki har da mai kula da aikin), yayin da 232 suka bayyana ne kawai a cikin bayyanannun bayanan ƙarshe na Co-authored-by. Ƙidayar tana daidaita sunayen noreply na GitHub, tana cire asalin bot/agent/service/placeholder guda 26, kuma ba ta haɗa adireshin imel na yau da kullum kawai saboda sunayen nuninsu sun yi daidai.
### 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 Reshentawa da Fitar da Siga](docs/ops/BRANCHING_MODEL.md)
3. Ƙirƙiri reshen fasalinka (`git checkout -b feat/amazing-feature`)
4. Yi commit na canje-canjenka (`git commit -m 'feat: add amazing feature'`)
5. Tura zuwa reshen (`git push origin feat/amazing-feature`)
6. Buɗe Pull Request tare da **base = wannan reshen `release/vX.Y.Z`**
Duba [CONTRIBUTING.md](CONTRIBUTING.md) don cikakkun jagorori.
### Fitar da Sabuwar Siga
```bash
# Ƙirƙiri release — 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 sigar TypeScript ta aikin Go mai suna **[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)** — daga nan kuma, kowane ƙaramin tsari da ke ƙasa ya samu zaburarwa daga wani aikin buɗaɗɗen tushe da ya riga shi isa can. Kowannensu ya tsara wani takamaiman ɓangare na OmniRoute. Wannan ita ce godiyarmu gare su duka. 🙏
> ⭐ An tabbatar da adadin taurari daga GitHub REST API a ranar 24 ga Agusta, 2026 — ku je ku ba waɗannan ayyukan tauraro. Adadin hoto ne na ainihin bayanai na wannan rana, kuma a bisa dabi'a zai canza.
### 🧬 Asali da mashiga
Asalin aikin da aka gina wannan reshen a kansa — an faɗaɗa shi a nan da APIs masu nau'o'in hanyoyi da yawa da kuma cikakken sake rubutawa da TypeScript.
Ƙofar AI wadda bayanan farashinta na jama'a ke samar da bayanai ga daidaitawar bin diddigin kuɗinmu, kuma samfurinta na daidaita masu samarwa ya taimaka wajen tsara hanyar tura buƙatunmu.
An daidaita tushen MIT zuwa gadar ChatGPT Web → Codex Responses da aka haɗa kai tsaye, ciki har da adaftocin zaman burauza, tsara amsa, amfani da binciken yanar gizo.
An sauya tsarin zuwa dawo da rafi, laƙabban rashin-tunani, binciken yanar gizo na madadin, iyakokin taga mai zamiya, ɓoye muhimman bayanan rajista da ƙarfafa hanyoyin ƙaddamarwa.
An daidaita taswirorin samfurin Grok ɗinsa, janaretan Statsig na ƙirƙirarren-TypeError, tsoffin saitunan buƙata da na'ura, da mai sarrafa martanin NDJSON sosai cikin mai aiwatar da Grok Web na OmniRoute.
Babban tushen lambar da aka gada a bayan grok2api-merged; an adana aiwatarwar samfurinsa, takensa, payload, Statsig da mai sarrafawa a cikin zuriyar Grok Web.
Asalin tushen MIT na payload da tsoffin saitunan na'urar Grok, janaretan Statsig, da mai sarrafa result.response da aka gada ta TQZHR da grok2api-merged.
Tushen da aka gada wanda grok2api-merged ya ambata saboda shimfiɗar proxy-pool ɗinsa; OmniRoute yana adana wannan sanarwar zuriya amma ba ya iƙirarin sauya proxy-pool cikin mai aiwatar da Grok Web mai iyakantaccen fanni.
Aiwatarwar Grok Web ta asali ta yi amfani da ƙirar sabar HTTP/burauza ɗinsa; hanyar HTTP kai tsaye ta samo asali ne daga GrokProxy, don haka ba a iƙirarin sauya wata lamba mai zaman kanta ba.
Shahararren aikin "me ya sa a yi amfani da token da yawa alhali kaɗan za su yi aikin" — falsafarsa ta salon maganar ɗan kogo ce ke ƙarfafa daidaitaccen yanayin matsawarmu da ƙa'idodi sama da 30 na cire kalmomin cikawa/taƙaitawa.
Binciken matsa prompt (LLMLingua / LLMLingua-2) — ya zaburar da injinmu na llmlingua wanda yake asynchronous, mai kiyaye code, kuma mai ci gaba da aiki idan ya gaza.
Matsa token na PT-BR — yana ƙarfafa kundin harshenmu na pt-BR: rage maimaita ma'ana da cire kalmomin cikawa da aka daidaita don nahawun Fotigal na Brazil.
Shahararriyar ƙwarewar YAGNI ta "malalacin babban mai haɓaka software" — ta zaburar da Salon Fitarwarmu na less-code: jagorantar zuwa mafi ƙarancin canjin da ke aiki wanda ke rage code da aka _ƙirƙira_ (ɗan'uwan Caveman na salon rubutu ta ɓangaren fitarwa).
Matsa fitarwa mai fahimtar abun ciki bisa kowane nau'in fayil, tare da janyewa idan an samu gazawa — ya tabbatar da rarrabawarmu bisa nau'i da tsallakewa idan ribar ta yi ƙasa da mafi ƙaranci.
JSON na ginshiƙai na Rust + dawo da bayanai bisa adireshin abun ciki + cire maimaituwa tsakanin saƙonni — ya tabbatar da ƙirar injunanmu na headroom/ccr/session-dedup da ƙa'idar cache mai karko cewa "matsatstsen tsari bai dogara da matsayi ba".
Kamewa/binciken MITM na zirga-zirgar mataimakin-rubuta-lamba ↔ 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 taken buƙata — da aiwatarwa masu zaman kansu na clean-room waɗanda suka dogara da ƙa'idodin yarjejeniya na jama'a. Fuskokin wucewa-ta-mai-masauki 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 maye gurbin ba.
Jagorantar wakili na bayyane bisa kowane tsari — ya zaburar da rushewar MITM mai jure durƙushewa, iyakokin-lokacin zaman-ban-zama na socket, danganta tsari ta /proc da kamawar TPROXY.
Jerin ma'ajiyoyin da aka tace waɗanda ke da aminci ta tsohuwa, wanda ke jagorantar zaɓuɓɓukan tsaronmu (Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink).
Sake taswirar samfurinsa mai la'akari da asusu, tabbatar da hanyar fayil mai aiwatarwa da halayen lakabin tsari sun taimaka wajen tsara lokacin-gudanarwa na Antigravity na OmniRoute.
Ya gano fuskar ƙimar Grok Build; daga nan OmniRoute ya tabbatar kuma ya gyara tsarin bayanan kai tsaye da kansa.
## 📄 Lasisi
Lasisin MIT - duba [LICENSE](LICENSE) don ƙarin bayani.
---
**[⬆ Koma sama](#-omniroute)** · An gina shi da ❤️ domin al'ummar AI ta buɗaɗɗen tushe.
OmniRoute v3.8.52 · Node ≥22.22.2 · Lasisin MIT · omniroute.online
> Taƙaitaccen bayani mai motsi na shafin `/dashboard/free-tiers` kai-tsaye. Cikakkiyar hanyar ƙididdiga (cire maimaitawar rumbuna, matakan credits, sharuɗɗan masu samar da sabis): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
> Ana sake binciken waɗannan alkaluma kowane mako biyu ta hanyar kwatanta su da kundin kai-tsaye kuma **suna motsawa ta ɓangarorin biyu** — idan mai samar da sabis ya kawo ƙarshen matakin kyauta, adadin yana raguwa; idan sabo ya shigo, yana ƙaruwa. Muna wallafa abin da kundin yake ƙididdigewa a zahiri, ba mafi kyawun yanayin da aka ɗaga adadinsa ba.
```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 hanyar da ta cancanta. Sabuwar girkawa na iya kasancewa ba ta da wuraren zuwa marasa maɓalli da suka cancanta, kuma mai samarwa mara maɓalli na iya ƙin amincewa da manhajojin ɓangare na uku. Masu samarwa da aka yi wa alamar `tos: avoid`, ciki har da OpenCode Free da Kiro, ba a saka su cikin zaɓin hanya na atomatik ta tsohuwa; haɗa asusu ba ya soke wannan saitin. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md) kafin zaɓar mai samarwa.
📦 Skrifofin farawa cikin sauri na kwafa-da-liƙawa don **Python, Node.js, PHP, da cURL** → [`examples/quickstart/`](examples/quickstart/)
> **Combo** jerin models ne da OmniRoute ke bi ta cikinsu **ta atomatik**. Idan quota ta ƙare, provider ya gaza, ko farashi ya yi tashin gwauron zabi, combo na iya matsawa zuwa model mai inganci na gaba wanda ya cancanta. 🛡️
### ⚡ Babu saiti — kawai yi amfani da `auto`
Babu buƙatar ƙirƙirar combo. Saita model ɗinka zuwa `auto` (ko wani nau'insa), sannan OmniRoute ya gina combo na kama-da-wane daga providers ɗin da ka haɗa, tare da kimanta su kai-tsaye:
📖 [Injin Auto-Combo](docs/routing/AUTO-COMBO.md) · [Jagorar Juriya](docs/architecture/RESILIENCE_GUIDE.md)
📊 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)
Maɓalli (bazuwar): `5d865059-bc44-483a-962d-43ceb80126eb`
Kwafi-da-manna na Pix:
```
00020101021126580014br.gov.bcb.pix01365d865059-bc44-483a-962d-43ceb80126eb5204000053039865802BR5922OMNIROUTE CONTRIBUICAO6006BRASIL62070503***630475DD
```
📖 [Izini](docs/architecture/AUTHZ_GUIDE.md) · [Matakan Kariya](docs/security/GUARDRAILS.md) · [Bin Ka’idoji](docs/security/COMPLIANCE.md)
Haɗin tsoho yana gudanar da `RTK → Caveman`. Idan duka biyun suka yi aiki a kan payload ɗin tool/context iri ɗaya, tanadin yana ninkuwa:
```txt
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
```
Code blocks, URLs, JSON da tsararren bayanai suna samun **kariya koyaushe** daga engine na kiyayewa.
> **Me ya sa za a yi amfani da tokens masu yawa alhali kaɗan za su yi aikin?** Kowace buƙata tana bi ta pipeline na matsawar OmniRoute **a bayyane ba tare da tsangwama ba** — babu sauye-sauyen abokin ciniki. Yanzu ya zama **tarin engines 12 masu iya haɗuwa** waɗanda ke aiki bisa tsari kuma ake gauraya su gwargwadon kowane haɗin routing — 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).
### 🧱 Tarin engines 12
Engines suna aiki bisa tsarin pipeline; ana iya kunna ko kashe kowannensu da kansa, kuma a saita shi ga kowane haɗi:
