# 🚀 OmniRoute — Ƙofar AI Kyauta
**Diego Souza ne ya ƙirƙira shi ([Diego Souza](https://github.com/diegosouzapw))**
## 💰 ~1.62B Tokens / Wata a Faɗin Matakan Kyauta na Masu Bayarwa Na Uku
> **Ku kawo asusun masu bayarwa na ku.** Wannan ƙiyasin jimilla ne daga matakan kyauta na masu bayarwa na uku daban-daban da suka cancanta, ba kyautar token daga OmniRoute ba. Yi rajista, samo bayanan shiga inda ake buƙata, sannan ku haɗa masu bayarwar da za ku iya amfani da su; kowane mai bayarwa ne ke ƙayyade iyakokinsa, samuwarsa, da sharuɗɗansa.
>
> Tara matakan kyauta da hannu yana da wahala — SDK da yawa, iyakokin ƙima da yawa, kuma babu masaniya kan adadin da kuke da shi a zahiri. OmniRoute yana tattara **shigarwar matakin kyauta 465 a cikin maɓallan tafkin maimaitattu 34** kuma yana ƙididdige babban adadin token daga **tafkunan 17 masu kasafin wata mai kyau da aka wallafa tare da iyakokin Groq biyar na kowane samfurin**, bayan cire maimaitawa ta amfani da tafkin da aka raba. Ƙididdigar da ke buɗewa ne kawai bayan tabbatar da asalin yanki (a yau: ModelScope) ana nuna su daban, +~6M bayan tabbatar da asalin yanki, kuma ba a haɗa su cikin babban adadin ba. Ana ci gaba da nuna sakamakon a dashboard (`/dashboard/free-tiers`).
> Taƙaitaccen bayani mai motsi na shafin `/dashboard/free-tiers` na ainihi. Cikakkiyar hanyar aiki (cire maimaitawar tafki, matakan ƙiredit, sharuɗɗan masu bayarwa): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
> Ana sake duba waɗannan alkaluma kowane mako biyu bisa kundin bayanan ainihi kuma **suna iya hawa ko sauka** — idan mai bayarwa ya kawo ƙarshen matakin kyauta, adadin yana raguwa; idan sabo ya zo, yana ƙaruwa. Muna wallafa abin da kundin bayanan ke ƙididdigewa a zahiri, ba wani yanayi mafi kyau da aka zagaye zuwa sama ba.
⭐ Yi wa ma'ajiyar alama idan OMNIROUTE ya taimaka muku ku rage kuɗi kuma ku sauƙaƙa aikinku.
[](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 — ku fara samun sabbin masu bayarwa, fitarwa da dabaru:**
[](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 bayarwa, taswirar hanya da 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) / [Ƙofar shiga](https://portal.sthub.com.br/communities/groups/st-hub/channels/Omniroute-World-8kRjmK)**
## 📈 Ƙofar Sadarwa na Ci gaba da Faɗaɗa
## 🆓 Shigar, haɗa mai bayarwa, sannan ka bi ta wurin ƙarshen hanya guda
```bash
# Bayan ka haɗa mai bayarwa, kwafi maɓallin OmniRoute naka 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 kasancewa ba ta da wasu wuraren makoma marasa maɓalli da suka cancanta, kuma mai bayarwa marar maɓalli na iya ƙin karɓar abokan ciniki na ɓangare na uku. Masu bayarwa masu alamar `tos: avoid`, har da Kiro, ana cire su daga turawa ta atomatik bisa tsoho; haɗa asusu ba ya sauya wannan saiti. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md) kafin zaɓar mai bayarwa.📦 Rubutun farawa cikin sauri na kwafi-da-manna 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.
## 🎯 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 hanya & cikakkun bayanai kan 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 abubuwan baya-bayan nan daga **v3.8.20 → v3.8.54**. Cikakken tarihin yana cikin [`CHANGELOG.md`](CHANGELOG.md).
- **⚖️ Kewayawa ta `quota-weighted`** — dabarar haɗawa ta 20 tana tsallake asusun da suka ƙare, sannan ta zaɓa daga sauran gwargwadon ragowar quota ÷ nauyin ayyukan da ke gudana, tare da ci gaba da ɗaure tattaunawar da ake da ita. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **🧰 Yanayin mara UI** — `omniroute serve --headless` (ko `OMNIROUTE_HEADLESS=1`) yana gudanar da injin wakilin `/v1/*` kaɗai, yayin da dashboard da tsarin da dashboard kawai ke amfani da su suke a kashe. → [Headless Mode](docs/guides/HEADLESS.md)
- **🔎 Gano samfuri** — `/v1/models` yana tacewa ta iyawa, mahallin, nau'i da rubutu, kuma `POST /v1/models/query` yana dawo da taƙaitaccen jerin zaɓuɓɓuka tabbatattu tare da ganin abubuwa iri ɗaya ga kowane maɓalli. → [API Reference](docs/reference/API_REFERENCE.md)
- **🔑 Sarrafa kewayawa ta kowane maɓalli** — liƙa maɓallin API zuwa samfuri ɗaya ko haɗi ɗaya ta `forcedModel`, kuma ƙara ko cire samfura da haɗin maɓalli a lokaci guda (`/api/keys/{id}/access`). → [API Reference](docs/reference/API_REFERENCE.md) · [OpenAPI](docs/openapi.yaml)
- **🛡️ Ingantattun sarrafa PII** — zaɓi bisa nau'i, har zuwa tsarin rufe bayanai na musamman 20 da aka tantance, da ƙididdigar ganowa bisa kowane nau'i; rufe bayanan kansa har yanzu sai an zaɓa. → [Guardrails](docs/security/GUARDRAILS.md)
- **🌍 Harsuna 67** — dashboard, madubin takardu da CLI, tare da `npm run i18n:add-locale` wanda ke ƙara harshe a ko'ina ta umarni ɗaya. → [i18n Guide](docs/guides/I18N.md)
- **🎛️ OmniConductor** — wakilcin A2A mai shigowa zuwa rundunar wakilanka, ƙwarewar Conductor a kan Agent Card, da wani ɓangaren dashboard mai tattaunawar murya ta Faro push-to-talk. → [A2A Server](docs/frameworks/A2A-SERVER.md)
- **🛂 Shigarwa mai daidaitawa da kariyar wuce gona da iri** — buƙatun hira masu nauyi suna shiga layi maimakon su dawo da 503, tare da hayar RPM mai juyawa ta atomatik ga kowace haɗi. → [Resilience Guide](docs/architecture/RESILIENCE_GUIDE.md)
- **🗂️ Tsarin `/v1/models` na asali** — rukuni ɗaya mai ci gaba da aka tsara bisa mai bayarwa ga kowane mai bayarwa (haɗe-haɗe suna zuwa farko), kuma yana daidaita a duk tushen kataloji. → [API Reference](docs/reference/API_REFERENCE.md)
- **🗜️ Ƙarfafa matse bayanai** — kariyar faɗaɗawa tana aiki ta tsohuwa, Caveman packs don DE / FR / JA da Sinanci (wényán), da RTK filters don Gradle & .NET. → [Compression](docs/compression/COMPRESSION_ENGINES.md)
- **💸 Gaskiyar kuɗin farashi madaidaici** — masu bayar da biyan kuɗi / coding-plan suna bayyana da **$0** a nazarin kuɗi; kasafin kuɗi, quota da kewayawa suna ci gaba da yin ƙiyasin kuɗi. → [API Reference](docs/reference/API_REFERENCE.md)
- **⚖️ Kewayawar Quota-Share** — raba quota na asusun da aka haɗa cikin adalci tsakanin maɓallan da aka tara, ta hanyar amfani da albarkatu yadda ya kamata inda ake ba da sassan da ba sa aiki ga wasu. → [Resilience Guide](docs/architecture/RESILIENCE_GUIDE.md)
- **🤖 Saitin CLI/wakili da umarni ɗaya** — umarnin `setup-*` guda 15 da aka yi rajista; `omniroute run` yana ƙaddamar da CLI 7 (Claude Code, Codex, Aider, Goose, OpenCode, Qwen Code, Gemini CLI); `omniroute configure` yana tallafawa wurare 11 tare da mai zaɓar mai bayarwa+samfuri mai hulɗa da abubuwan da aka fi so bisa kowane mahallin. → [CLI Integrations](docs/guides/CLI-INTEGRATIONS.md)
- **🛰️ Yanayin nesa** — sarrafa OmniRoute na nesa ta alamun da aka takaita (`connect` / `contexts` / `tokens`) tare da mataimakin OAuth na `antigravity` don girke-girken VPS. → [Remote Mode](docs/guides/REMOTE-MODE.md)
- **🧭 Kewayawa ta atomatik mafi wayo** — haɗe-haɗen `auto/:`, **Fusion** (kwamitin samfura + mai yanke hukunci), kewayawa mai sanin aiki, da sauye-sauyen samfuri / yanayi / kasafin USD bisa kowace buƙata. → [Auto-Combo](docs/routing/AUTO-COMBO.md)
- **🗜️ Matse bayanai mai ɗaukar ƙari** — injuna 12 masu haɗuwa + Compression Studios: LLMLingua-2, Ultra mai matakai biyu, omniglyph, ƙofar amincin kowane mataki, GCF v3.2, da editan ja-da-sake-tsara. → [Compression](docs/compression/COMPRESSION_ENGINES.md)
- **🕵️ Bayyanannen warware MITM (TPROXY)** — CLI na kamawa waɗanda ke yin watsi da masu canjin yanayin 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** — taken kuɗi/amfani na `X-OmniRoute-*` a kowane ƙarshen API, taken ajiyar kuɗin cache-HIT, da ƙayyadaddun kashe USD na kowane maɓalli. → [API Reference](docs/reference/API_REFERENCE.md)
- **🧠 Ƙwaƙwalwar da kake sarrafawa** — a kashe take ta tsohuwa, quantization na vector int8 da aka kunna da zaɓi + raguwar nau'i, da `x-omniroute-no-memory` bisa kowace buƙata. → [Memory](docs/frameworks/MEMORY.md)
- **🛡️ Tsaro** — kariyar allurar umarni a kowace hanyar LLM (red-team suite), kariyar rufe bayanan sirri da aka kunna da zaɓi (tana ɓoye maɓallan API/asirin da suka zube ta dukkan hanyoyi biyu), binciken yanar gizo na DuckDuckGo kyauta a matsayin mafita ta ƙarshe, da ƙofar shiga OIDC ta zaɓi don dashboard (shiga da kalmar sirri koyaushe yana nan). → [Guardrails](docs/security/GUARDRAILS.md)
- **🖼️ Sabbin ƙarshen API** — `/v1/ocr` (Mistral OCR) da `/v1/audio/translations` (mai salo irin na Whisper) sun cika ɓangaren kafofin watsa labarai. → [API Reference](docs/reference/API_REFERENCE.md)
- **🎨 Ƙirƙirar hoto / bidiyo / sauti** — API ɗaya don kafofin watsa labarai: xAI Grok Imagine & Novita AI video, ComfyUI, Magnific, Adobe Firefly, Segmind, da masu bayar da magana kamar ElevenLabs. → [API Reference](docs/reference/API_REFERENCE.md)
- **🌍 Girke-girke da gudanarwa** — `basePath` na reverse-proxy, gano harshen mai bincike ta atomatik, bin diddigin na'ura bisa kowane maɓalli, amincewar MITM ba tare da root ba, da fassarar zh-TW. → [Environment](docs/reference/ENVIRONMENT.md)
- **🤝 Ƙarin masu bayarwa da wakilai** — wakilan gajimare (Codex Cloud, Cursor, Devin, Jules), Grok Build (xAI) tare da mai bincike + shiga OAuth, katin Ollama na matakin farko, Claude Opus 5 & Sonnet 5, haɗin gwiwar hukuma da Kimi (Code/Web/Moonshot), Zed, Requesty, SenseNova, Yuanbao, Agnes AI… da sabunta **katalojin masu bayarwa 388**. → [Providers](docs/reference/PROVIDER_REFERENCE.md)
- **📡 Bayyananniyar kewayawa** — kowace amsa tana ɗauke da taken `X-OmniRoute-Decision` mai bayyana dabarar/mai bayarwa/jinkirin da ya ba da ita, sabuwar dabarar haɗi ta `cache-optimized` + abin `cacheAffinity` na Auto-Combo suna mayar da maimaitattun buƙatu zuwa haɗin da ke riƙe da prefix da aka adana, kuma ƙarshen API mai karatu-kawai `/v1/auto-combo/{channel}/candidates` yana bayyana rukunin zaɓaɓɓun kai tsaye na tashar `auto/*`. → [Auto-Combo](docs/routing/AUTO-COMBO.md).
- **⚡ Ayyukan aiki na gida da kayan more rayuwa** — Redis na gida da ake kunna da dannawa ɗaya, masu tura relay na Cloudflare Workers / Deno Deploy, Bifrost da Mux a matsayin ayyukan da aka saka kuma ake sa ido a kansu. → [Ayyukan da Aka Saka](docs/frameworks/EMBEDDED-SERVICES.md)
- **🧩 Haka kuma yana cikin kunshin** — tsarin plugins + kasuwa, tsarin ƙwarewar Omni/Agent/GitHub, haɗin Obsidian vault (kayan aikin MCP 22), APIs na Batch & Files masu dacewa da OpenAI, ma'ajiyar amsoshin semantic, tsarin gamification mai allunan jagora, gano wakilan ACP (wakilai 15 da aka riga aka gina), fitar da log zuwa BigQuery bisa jadawali, `auto/chaos` don rarraba ayyuka ga samfuran AI da yawa a layi ɗaya, gadar bot ta Telegram, mai sarrafa sigar manhaja a ciki, da martabobin masu samarwa kyauta na LMArena-ELO. → [Takardu](docs/README.md)
## 🤖 CLI & Wakilan Lambar Da Suka Dace
> Saitin guda ɗaya — `http://localhost:20128/v1` — kuma **duk** AI IDE ko CLI suna aiki da samfura kyauta & masu arha.
**Kaddamar da kowanne CLI da aka tallafa ta OmniRoute da umarni guda daya** — babu fayilolin saituna da za a rubuta,
an saka bayanan izini ga kowanne tsari, Qwen/Gemini suna samun gida mai zaman kansa 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 hulɗa sannan ka rubuta saitin kayan aikin:
omniroute configure codex # haka ma: claude opencode qwen aider goose gemini cline continue kilo 5dive
```
Duk wani umarni yana mutunta yanayin haɗin nesa (`omniroute connect `), `--dry-run`
yana nuna ainihin muhalli/huɗɗa ba tare da aiwatarwa ba, kuma `--api-key-env NAME` yana kare sirri daga tarihin shell ɗinka. → [CLI Integrations](docs/guides/CLI-INTEGRATIONS.md)
## 🌐 Masu Samar da AI 388 — 153 Kundin Ya Yi Wa Alama a Matsayin Kyauta
> **Masu samarwa 388 da aka yi rajista** a cikin tarin hirarraki, kafofin watsa labarai, bincike, na gida, wakilan girgije da tsarin da aka amince da su, ciki har da **153 masu ɗauke da bayanan gano `hasFree: true`**. Rijistar samfuran hira ta ƙunshi **masu samarwa 239 / nau’ikan haɗin mai samarwa da samfuri 3,059 daban-daban / ID ɗin samfura 1,475 na asali**; yayin da kundin kasafin kyauta na daban ya ƙunshi **layukan kowane samfuri 471**, **rukunai masu maimaituwa 34** da **masu samarwa 52 masu maimaituwa/ba sa buƙatar maɓalli kuma kyauta har abada**. Waɗannan ma’aunai ne daban bisa ƙira; ma’anoni da ƙididdigar da aka cire maimaitawar rukunai suna cikin [Marejen Mai Samarwa](docs/reference/PROVIDER_REFERENCE.md) da [Matakan Kyauta](docs/reference/FREE_TIERS.md).
### 🏢 Duk manyan dakunan gwaje-gwaje — ta hanyar hanya guda
OpenAI
Anthropic
Gemini
xAI Grok
DeepSeek
Mistral
Qwen
Meta Llama
Groq
NVIDIA
MiniMax
Cohere
Perplexity
HuggingFace
Together
Fireworks
Cloudflare
Baidu
…da ƙarin 350+ — kowane gunki yana warwarewa kai tsaye daga kundin masu samarwa na dashboard. 📖 [Marejen Mai Samarwa](docs/reference/PROVIDER_REFERENCE.md)
### 🆓 Kyauta Har Abada — $0, babu katin biya
OpenCode Zen DeepSeek V4, Nemotron 3 Babu iyakar token
Kilo Code Mai zaɓin hanya ta atomatik, 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 KYAU kyauta mara iyaka
Pollinations GPT, Llama, Claude Ba a buƙatar maɓalli
Cloudflare AI Samfura 50+ Neurons 10K/rana
NVIDIA NIM GLM, MiniMax Kimanin RPM 40 kyauta
Cerebras GLM 4.7, GPT-OSS Kiredit na $5 na amfani sau ɗaya; ana buƙatar kati
OpenRouter :free models +$10 → RPM mafi girma
📖 Cikakken kundin da injina za su iya karantawa → [`docs/reference/PROVIDER_REFERENCE.md`](docs/reference/PROVIDER_REFERENCE.md)
## 🖥️ Inda OmniRoute Ke Gudu - Ko'ina
> app iri ɗaya, injin ku, dokokin ku. Daga shigarwar npm na duniya zuwa** wayarka** ta hanyar Termux.
Platform
bayanai
📦 npm (duniya)
npm shigar -g omniroute
Umarni ɗaya, kowane OS
⚡ Bun (duniya)
bun ƙara -g omniroute
Same registry tarball, saurin shigarwa
🐳 Docker
docker run … diegosouzapw/omniroute
Multi-arch AMD64 + ARM64
🖥️ Desktop (Electron)
npm run electron:build
Native taga + tsarin tray — Windows / macOS / Linux
🎩 Menu-bar (OmniRouteTray)
brew shigar --cask zoispag/tap/omniroute-tray
& yana sabunta uwar garken ta atomatik — macOS
💪 ARM
na asali arm64
Raspberry Pi, ARM sabobin, Apple Silicon
📱 Android (Termux)
pkg shigar nodejs && npx -y omniroute
Yana gudanar da akan wayarka , 24/7, babu tushen
📲 PWA
"Ƙara zuwa Fuskar allo"
Cikakken allo, offline, wanda za'a iya shigarwa daga browser
### 🧩 Sabuwa: OmniRoute a cikin VS Code ta asalin Copilot Chat
> Babu sabon labarun gefe, babu sabon hira UI - kowane samfurin OmniRoute hidima yana nunawa daidai a cikin**Copilot Chat model picker da kuka riga amfani** . Tun da lambar VS 1.122, samfuran masu ba da sabis suna aiki ba tare da shiga GitHub ko biyan kuɗin Copilot ba - yanayin wakili, kiran kayan aiki da hangen nesa, kyauta.
Shigar da** [OmniCopilot](https://github.com/diegosouzapw/OmniCopilot)** tsawo, nuna shi a uwar garken OmniRoute ɗinku (tsoho zuwa `localhost:20128`), sannan buɗe Copilot Chat → samfurin picker →** Sarrafa Samfura…** →**OmniRoute** .
Daga ciki editan: bude** kari** duba, bincika** "OmniRoute"** , danna** Shigar** - yana aiki iri ɗaya akan shagunan biyu. Tushen, al'amurra da buguwar runbook kai tsaye a [diegosouzapw/OmniCopilot](https://github.com/diegosouzapw/OmniCopilot).
📖 [VS Code Copilot Jagorar Taɗi](docs/guides/VSCODE-COPILOT.md) - saitin, abin da mai ɗauka ya nuna, dashboard-in-a-tab, warware matsalar
### 🎩 Sabuwa: OmniRouteTray — ƙofar ku, zaune a mashaya menu
> `omniroute serve` ta fi farin ciki idan ana kunna ta koyaushe.** [OmniRouteTray](https://github.com/zoispag/omniroute-tray)** yana juya wannan zuwa saitin menu-bar app don macOS: yana farawa sabar, yana kiyaye shi a duk lokacin sake yi, sabunta shi a wurin, kuma yana sanya kasafin kuɗin ku na rayuwa dannawa ɗaya nesa -** babu tagar taga a bude, babu `npm install -g omniroute` zuwa babysit.**
An gina shi tare da [Tauri v2](https://v2.tauri.app/) (tsatsa mai girman girman kuskuren zagaye), yana jigilar nasa sa hannun Node 24 lokacin aiki kuma yana sarrafa shigar OmniRoute mallakar app, don haka ba zai taɓa yaƙar `node`/`bun` ɗin ku na duniya ba. Yana** yana raba tsarin tsarin `~/.omniroute/` ku da kuma bayanan bayanai** - don haka OmniRoute ɗaya ne da kuka riga kuka gudu, kawai tare da hula. 🎩
Abin da yake aikatawa
Yaya
🟢 Yana Kula da uwar garken
Spawns omniroute bautar , ya ɗauki misali mai gudana maimakon kwafin shi
📊 Amfani kai tsaye a kallo
Sanduna keɓe masu bayarwa, iyakoki Claude session/weekly tare da sake saitin kirgawa, raguwar farashi na kwanaki 30
🔄 Sabuntawa ta atomatik a wurin
Tsarin shigarwa, musanya atomatik, sake dawowa akan gazawa - koyaushe akan sabon sakin
🚀 Fara shiga
Ƙaddamar da zaɓi a shiga; tire-kawai, babu alamar tashar jirgin ruwa
🩺 Doctor & rajistan ayyukan
Dannawa guda ɗaya bincike da shiga sabar uwar garke
```sh
brew install --cask zoispag/tap/omniroute-tray
```
An fi son saukewa? Dauki sabon .dmg daga
Saki . Source, al'amurra da ginawa
docs live at zoispag/omniroute-tray.
💛 Aikin al'umma ta @zoispag - ba sakin OmniRoute na hukuma ba.
> 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)
## 🗜️ Ajiye 15–95% na Tokens — Ta atomatik
### 📖 Yadda yake aiki — bututun aiki, gine-gine da lissafin tanadi
Haɗin tarawa na tsoho yana gudanar da `RTK → Caveman`. Idan duka biyun suka yi aiki kan payload ɗin kayan aiki/mahallin guda, tanadin yana taruwa:
```txt
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
```
Tubalan lamba, URLs, JSON da tsararren bayanai suna **kare su koyaushe** ta injin adanawa.
> **Me ya sa za a yi amfani da tokens da yawa alhali kaɗan sun isa?** Kowace buƙata tana ratsa bututun matsawa na OmniRoute **a bayyane ba tare da canji ba** — babu canje-canje ga abokin ciniki. Yanzu ya zama **tarin injuna 12 masu haɗuwa** waɗanda ke gudana cikin jere kuma ana haɗa su yadda ya dace bisa tsarin routing — yana ginuwa kan dabaru 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 injuna 12
Injunan suna gudana bisa tsarin bututun aiki; ana iya kunna ko kashe kowanne daban, kuma a tsara shi bisa kowane haɗi:
#
Inji
Abin da yake yi
1
Session-Dedup
Yana cire abun da aka maimaita tsakanin juyawa (wanda abun ciki ya yi adireshi, tsakanin juyawa)
2
CCR
Yana adana manyan tubalai a bayan alamomin dawo da su, sannan a ɗauko su idan an buƙata
3
Lite
Yana rage sararin rubutu + URLs na hotuna (tushen da ba ya nauyaya latency)
JSON mai fifita rashin asara + matsawar bayanan gano matsala mai iyaka don sakamakon shell/patch/search/build (Responses API)
6
Headroom
Matsawar tsararrun arrays na JSON ba tare da asara ba (~30%) ta hanyar codec na GCF da aka haɗa
7
Relevance
Yana cire jimloli bisa ƙimarsu dangane da tambayar mai amfani ta ƙarshe
8
Caveman
Matsawar rubutun bayani bisa ƙa’idoji (~65–75% a kan fitarwa)
9
Aggressive
Taƙaitawa + tsufa a hankali na tsoffin juyawa
10
LLMLingua-2
Yanke ma’anar ML ta hanyar MobileBERT ONNX — mai kare lamba, asynchronous
11
Ultra
Rage tokens bisa heuristics tare da zaɓin matakin ƙaramin samfuri (SLM)
12
OmniGlyph
Matsar gwaji ta hanyar rikodin mahallin a matsayin hoto don Claude Fable 5 da aka auna a kan layin Anthropic kai tsaye; transformers na GPT 5.6 suna ci gaba da rufe aiki idan babu tabbacin mai bayarwa. Bayanan matsawa guda huɗu (tsoho mai tsanani, daidaitacce, mai kare coding, passthrough) (mafi tsanani; sai an kunna da gangan)
Tubalan lamba, URLs da tsararren bayanai ana **adana su koyaushe** daidai da bytes. **Shirye-shiryen dannawa ɗaya** suna haɗa injunan:
Yanayi
Tanadi
Mafi dacewa da
🪶 Lite
~15%
Tsohon zaɓi mai aminci da ke aiki koyaushe
🪨 Standard (Caveman)
~30%
Coding na yau da kullum
⚡ Aggressive
~50%
Dogayen zaman da kayan aiki suka fi yawa
🔥 Ultra
~75%
Matsakaicin tanadi
🧰 RTK
60–90%
Sakamakon shell/test/build/git
🔗 Stacked (RTK → Caveman)
78–95%
Haɗaɗɗun prompts + logs na kayan aiki
**Misali na gaske — yanayin Standard:**
> **Kafin (tokens 69):** _"Dalilin da ya sa React component ɗinka ke sake yin render wataƙila shi ne saboda kana ƙirƙirar sabon object reference a kowane zagayen render. Idan ka ba da object na layi kai tsaye a matsayin prop, kwatancin React na shallow yana ganin sa a matsayin wani object daban a kowane lokaci, wanda ke jawo sake yin 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 = sake render. Kunna shi cikin useMemo."_
>
> **Amsa ɗaya ce. An rage tokens da 72%. Babu asarar daidaito ko kaɗan.** ✅
**Misalin PT-BR — yanayin [Troglodita](https://github.com/leninejunior/troglodita):**
> **Kafin (alamomi 42):** _"Matsalar ita ce ɓangaren yana sake yin render saboda ana ƙirƙirar sabon reference na abu a kowane zagayen render. Zan ba da shawarar amfani da useMemo."_
>
> **Bayan (alamomi 12):** _"Sake render: sabon ref a kowane zagaye (an sake ƙirƙirar abu na ciki). Yi amfani da `useMemo`."_
>
> **Amsa ɗaya ce. ~70% ƙasa da alamomi. Daidaiton fasaha bai canza ba.** ✅
### 🎚️ Bayan injuna — salon fitarwa, madaidaicin daidaitawa & sarrafawa ta kowace buƙata
Injunan 12 da ke sama suna rage abin da ke **shiga**. Ƙarin matakai uku suna tsara **yadda**, **yaushe**, da abin da ke **fitowa**:
- **🪄 Salon Fitarwa** _(jagorar ɓangaren fitarwa)_ — suna shigar da umarnin tsara amsa masu tabbas kuma masu aminci ga cache; ana iya haɗa su, kowannensu a ƙarfin `lite` / `full` / `ultra`. Ƙara salo abu ne na layi ɗaya a cikin rajista:
- **Taƙaitaccen rubutu** — cire cike gurbi / kalmomin haɗi / kalmomin nuna shakka; a kiyaye ainihin ma'anar fasaha.
- **Ƙaramin lamba** — YAGNI na "ƙwararren mai haɓakawa malalaci": ƙaramin canji mai aiki, ba tare da ƙarin tsarin da ba a nema ba.
- **Wutsiyar doki (ƙwararren mai haɓakawa malalaci)** — hau matakan YAGNI, gyara tushen matsala, da mafi ƙaramin bambancin aiki.
- **Ina da ADHD (aiki da farko)** — mataki na gaba ya zo farko, a ƙidaya matakai, mataki guda mai ma'ana na gaba, ba tare da gabatarwa ba.
- **Taƙaitaccen CJK (文言)** — salon Sinanci na gargajiya mai tsananin taƙaitawa (ana iyakance shi ga `zh`).
- **🎯 Kasafin mahallin mai daidaitawa** _(madaidaicin daidaitawa)_ — maimakon ƙofa guda ta alamar kunnawa/kashewa, a ƙara injunan da suka fi araha kuma suka fi kiyaye asali ne kawai gwargwadon bukata, domin **a dace da girman mahallin samfurin**. Manufofi: `reserve-output` (na asali, mai sanin samfurin) · `percentage` · `absolute`. Yanayi: `floor` (tabbatar da dacewa) · `replace-autotrigger` (zaɓinka na bayyane ya fi ƙarfi) · `off` (ƙofar gargajiya).
- **🎛️ Inda ake yanke shawarar matsawa** _(fifiko, daga sama → ƙasa)_ — taken `x-omniroute-compression` na kowace buƙata › sauya saitin haɗin routing › bayanin martaba mai suna mai aiki › adaptive / auto-trigger › tsoffin saitunan panel › off. Tsarin da aka yi amfani da shi yana dawowa a cikin taken amsa `X-OmniRoute-Compression: ; source=`.
A kunna auto-trigger ta ƙofar alamomi, a juya madaidaicin daidaitawa, a kulle bayanin martaba mai suna, a saita buƙata guda, ko a ware pipeline ga kowane haɗin routing — duk wanda ya dace da nauyin aiki. Wani **eval harness** na zaɓi da ke aiki ba tare da intanet ba (`npm run eval:compression`) yana auna aminci da tanadi a kan tarin bayanai da aka kulle kafin ka fitar da 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 Cikin Sauri
**1) Sanya kuma kunna**
```bash
npm install -g omniroute
omniroute
```
> 💡 Ka ga `npm warn ERESOLVE` ko gargadin peer-dep? [Ba su da illa](docs/guides/TROUBLESHOOTING.md#npm-install-warnings-eresolve--peer--deprecated).
> **Kana amfani da npm 11 ko sama da haka?** npm na iya toshe rubutun tsarin rayuwar package sai an ba su izini. `postinstall` na OmniRoute (`node scripts/build/postinstall.mjs`) ya zama dole domin shirya fayilolin runtime na asali. Ba wa packages da aka ambata a gargadin npm izini yayin shigarwa gaba ɗaya. Ga jerin packages da OmniRoute 3.8.54 ya bayar:
>
> ```bash
> npm install -g --allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild omniroute
> ```
>
> Domin sake amfani da wannan jerin izini a shigarwar gaba ɗaya na gaba, saita shi sau ɗaya, sannan ka yi shigarwa 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 dogaro na iya canzawa tsakanin fitarwa; idan npm ya bayar da wani jerin daban, yi amfani da sunayen packages da ke cikin wannan gargadin. Ba wa package izini yana ba da damar rubutun shigarwarsa su gudana.
> **Kana amfani da Gemini Web ko wani mai samarwa mai amfani da kukis na yanar gizo?** Package na npm ya haɗa da
> Playwright amma ba ya haɗa da binary na Chromium. Duba bayanin
> [saitin Playwright Chromium](docs/guides/TROUBLESHOOTING.md#gemini-web-and-playwright-chromium)
> kafin yin buƙatar mai samarwa na yanar gizo ta farko.
Dashboard yana `http://localhost:20128` · API yana `http://localhost:20128/v1`.
**2) Haɗa mai samarwa da ya cancanta ta amfani da asusunka**
Dashboard → **Masu Samarwa** → zaɓi mai samarwa wanda sharuɗɗansa na yanzu da adadin amfani suka dace da yanayin amfani naka → ƙara mabuɗin API ɗinsa ko kammala tsarin asusunsa. Matakan kyauta na iya buƙatar rajista, amincewa, ko hanyar biyan kuɗi. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md); ba a tabbatar da samuwa ba tare da mabuɗi ba, kuma masu samarwa da aka yi wa alamar `tos: avoid` an cire su daga `auto` ta tsohuwa.
**3) Nuna kayan aikin coding ɗinka**
```txt
Base URL: http://localhost:20128/v1
API Key: [kwafa daga Dashboard → Endpoints]
Model: auto (yana routing tsakanin haɗe-haɗen da suka cancanta — ko zaɓi provider/model)
```
**4) Tabbatar cewa yana aiki**
```bash
curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"
```
Ya kamata ka ga an jera samfurorin da ka haɗa. 🎉 Shi ke nan — fara coding, OmniRoute zai yi routing da fallback ta atomatik a madadinka.
Idan client ɗinka ba zai iya aika taken da aka keɓance ba, OmniRoute kuma yana bayar da aliases na dacewa masu ɗauke da token:
```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 ne kawai ga clients da ba za su iya haɗa `Authorization: Bearer ...` ba. Tabbatarwa ta header ita ce 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.
OAuth 2.0 (PKCE) + JWT + Maɓallan API + ingantaccen MCP mai iyakantaccen izini · AES-256-GCM yayin adanawa · DOMPurify
ɓoyewa
wreq-js — kwaikwayon sawun yatsa na JA3 / JA4 TLS, wakili mai matakai 3
Juriya
Mai katse da’ira, ja da baya mai ƙaruwa a jere, rigakafin taruwar buƙatu, gyaran kai ta atomatik na auto-combo
Rajista
pino — rajistocin JSON masu tsari tare da mahallin buƙata
Gwaji
Mai gudanar da gwajin Node.js + Vitest — sanarwar gwaje-gwaje na tsaye sama da 60,000 a cikin fayilolin gwaji sama da 8,400 da aka bibiyu (naúra, haɗewa, E2E, tsaro, tsarin muhalli)
Dabarar rufe gwaje-gwaje ga sanarwar gwaje-gwaje na tsaye sama da 60,000 a cikin fayilolin gwaje-gwaje sama da 8,400 da ake bibiyarsu
# ⭐ Manyan masu ba da gudummawa
> Al’ummar buɗaɗɗen tushe mai ƙwazo ce ke tsara OmniRoute. Waɗannan mutane sun ba da gagarumar gudummawa wadda ta shafi inganci, daidaito, da yaɗuwar aikin kai tsaye. **Mun gode.**
### Masu ba da gudummawa na waje bisa ga pull requests da aka haɗa
An gudanar da ƙidayar a 2026-11-03 03:01:19 UTC tare da sabuwar alamar release/v3.8.53 mai 05bc048d6c. Ƙidayar GitHub GraphQL mai shafuka ta ƙunshi PRs 9,947 da aka haɗa: 4,130 daga mai aikin, 240 daga Dependabot, 6 daga wasu bots/apps, da PRs 5,571 na waje daga masu ba da gudummawa 883 daban-daban. “Layukan da aka canza” su ne ƙarin layuka + gogewar layuka na GitHub, kuma sun haɗa da fayilolin da aka samar, lockfiles, catalogs, fassarori da takardun bayani; wannan motsin canje-canje ne, ba LOC da marubuci ya rubuta ba. PRs 53 sun bayar da rahoton bambance-bambancen GitHub sama da layuka 500,000 (misali #13399, ƙarin provider guda ɗaya, yana lissafa fayiloli 2,347 da aka canza), abin da ya ƙara wasu jimilloli da ke sama. Ana sanya waɗanda suka yi kunnen doki a matsayi guda.
### Commits da GitHub ya danganta
An sake bincikawa a 2026-11-03 02:09:16 UTC: commit ɗin da aka danganta da GitHub waɗanda Contributors API na ma'ajiyar ya bayar don reshen tsoho na release/v3.8.53. API ɗin ya dawo da bayanan mutane 903 (masu amfani 429, bots 2, da waɗanda ba a san su ba 472); wannan teburin ya cire mai kula, bots da waɗanda ba a san su ba, kuma ya riƙe waɗanda suka yi kunnen doki. Ya bambanta da duka martabar PR da aka haɗa a sama da kuma ƙidayar metadata na Git da ke ƙasa.
> 🙏 Abubuwan da waɗannan masu ba da gudummawa suka ƙirƙira, gyaran kurakurai, da ingantawar ababen more rayuwa, duk **ginshiƙi ne na** abin da ke sa OmniRoute ya kasance abin dogaro kuma mai cike da fasali. Kowace pull request, kowane yanayin gwaji, da kowane fayil ɗin fassarar i18n suna da muhimmanci. Mutane irinsu ne ke 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 Fiye da 1,000
[](https://github.com/diegosouzapw/OmniRoute/graphs/contributors)
An gudanar da bincike a 2026-11-02 kan sigar ƙarshe ta release/v3.8.53 mai lambar 1c7135e0fb (commit 7,972): ainihin sunayen Git na mutane 1,074 da aka daidaita — 759 sun bayyana a matsayin marubutan commit (ciki har da mai kula da aikin), yayin da 315 suka bayyana ne kawai a cikin ƙarin bayanan Co-authored-by. Ƙididdigar tana amfani da .mailmap, tana kwatanta adiresoshin imel ba tare da la’akari da manya ko ƙananan haruffa ba, tana haɗa adiresoshin GitHub noreply masu lamba da marasa lamba ne kawai idan suna wakiltar handle iri ɗaya, tana cire sunaye 29 na bots/agents/ayyukan sabis/sunaye na wucin gadi, kuma ba ta haɗa adiresoshin imel na yau da kullum kawai saboda sunayen da ake nunawa sun yi daidai ba. Binciken 2026-08-24 ya wallafa 639; sake gudanar da wannan hanya kan tushen binciken ɗin nan ac02c5b42f ya ba da 619, don haka ƙarin ya samo asali ne daga sababbin masu ba da gudummawa, ba daga sassauta hanyar lissafi ba.
### Yadda ake Ba da Gudummawa
1. Yi fork na ma'ajiyar
2. Yi branch daga **sigar `release/vX.Y.Z` mai aiki** (ba daga `main` ba) — duba [Tsarin Branch da Saki](docs/ops/BRANCHING_MODEL.md)
3. Ƙirƙiri branch ɗin fasalinka (`git checkout -b feat/amazing-feature`)
4. Yi commit na sauye-sauyenka (`git commit -m 'feat: add amazing feature'`)
5. Tura zuwa branch ɗin (`git push origin feat/amazing-feature`)
6. Buɗe Buƙatar Haɗawa tare da **base = wannan branch ɗin `release/vX.Y.Z`**
Duba [CONTRIBUTING.md](CONTRIBUTING.md) don cikakkun jagorori.
### Sakin Sabuwar Siga
```bash
# Ƙirƙiri saki — npm publish yana faruwa ta atomatik
VERSION=x.y.z
gh release create "v${VERSION}" --title "v${VERSION}" --generate-notes
```
## 📊 Taurari
## 🌍 StarMapper
## 🙏 Godiyarwa
OmniRoute ya tsaya ne a kan kafaɗun manyan ayyuka. Ya fara ne a matsayin cokali daga **[9router](https://github.com/decolua/9router)** da kuma fassarar aikin Go **[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)** zuwa TypeScript — kuma daga nan, kowane tsarin da ke ƙasa ya samo wahayi daga wani aikin buɗaɗɗen tushe da ya riga ya fara wannan aiki. Kowannensu ya tsara wani takamaiman ɓangare na OmniRoute. Wannan ita ce godiyarmu gare su duka. 🙏
> ⭐ An tabbatar da adadin taurari daga GitHub's REST API a ranar 3 ga Nuwamba, 2026 — ku je ku ba waɗannan ayyukan tauraro. Waɗannan adadi hoton lokaci ne na takamaiman kwanan wata kuma za su canza a zahiri.
### 🧬 Asali da gateway
Ƙofar AI wadda bayanan farashinta na jama'a ke ciyar da daidaita bin diddigin kuɗaɗenmu, yayin da tsarin daidaita masu samarwa nata ya ba da bayani ga tsarin tura buƙatunmu.
An daidaita tushen MIT ɗinsa zuwa gadar ChatGPT Web → Codex Responses da aka haɗa a ciki, har da adaftocin zaman burauza, tsara martani, amfani da binciken yanar gizo.
An shigar da tsare-tsarensa cikin dawo da rafuka, laƙaban no-thinking, binciken yanar gizo na madadin, iyakokin taga mai zamewa, ɓoye bayanan log da ingantattun hanyoyin ƙaddamarwa.
An daidaita taswirar samfuransa na Grok, janareta na fake-TypeError Statsig, tsoffin saitunan buƙata da na'ura, da mai sarrafa martanin NDJSON cikin mai aiwatar da Grok Web na OmniRoute.
Babban tushen lambar da aka gada a bayan grok2api-merged; an adana aiwatarwarsa ta samfur, take, bayanan kaya, Statsig da mai sarrafawa a cikin jerin asalin Grok Web.
Tushen MIT da ke ƙasa don tsoffin saitunan kayan kaya da na'ura na Grok, janareta na Statsig, da mai sarrafa result.response da aka gada ta TQZHR da grok2api-merged.
Wani tushen da aka gada wanda grok2api-merged ya yaba masa saboda tsarin rumbun wakili; OmniRoute ta adana wannan sanarwar asali amma ba ta yi iƙirarin shigar da rumbun wakili cikin mai aiwatar da Grok Web mai iyaka ba.
An duba tsarin HTTP/burauza na asalin aiwatarwar Grok Web ɗinsa; hanyar HTTP kai tsaye ta samo asali daga GrokProxy, don haka ba a yi iƙirarin wani shigarwar lamba mai zaman kanta ba.
Aikin nan mai suna "me ya sa a yi amfani da token da yawa alhali kaɗan ya isa" da ya bazu sosai — falsafar maganar kogo ta samar da tushen yanayin matsawa na yau da kullum da ƙa'idojin cike/taƙaita sama da 30.
Matsawar fitarwar umarni mai saurin gaske — ya ba mu ra'ayin injin RTK, DSL na tace JSON, dawo da fitarwa ta asali da kuma tsarin RTK → Caveman mai matakai.
Binciken kimiyya kan matsawar prompt (LLMLingua / LLMLingua-2) — ya ba mu ra'ayin injin llmlingua ɗinmu mai aiki a bayan fage, mai kiyaye lamba, kuma mai ci gaba idan aka samu kuskure.
Matsawar token na PT-BR — yana ƙarfafa fakitin harshen pt-BR ɗinmu: rage maimaita ma'ana da cire kalmomin cike da aka daidaita da nahawun Fotugisanci na Brazil.
Ƙwarewar mai shirya lamba mai suna "lazy senior dev" YAGNI-coder da ta bazu sosai — ta ba mu ra'ayin salon fitarwar less-code: jagorantar ƙaramin canjin da ke aiki, wanda ke rage lambar _da aka samar_ (ɗan'uwan Caveman na ɓangaren fitarwa ga maganar da aka taƙaita).
Tsarinsa na taƙaitaccen jadawali da tsarin bayanin martaba na gama-gari sun ba da bayanai ga taƙaita bayanan teburin OmniRoute da tsarin codec na Headroom.
Matsawar fitarwa mai fahimtar abun ciki, ta kowane nau'in fayil, tare da dakatarwa idan an samu kuskure — ya tabbatar da rarrabawa ta nau'i da tsallakewa idan ribar ta yi ƙasa da mafi ƙaranci.
JSON na ginshiƙai a Rust + dawo da bayanai bisa adireshin abun ciki + cire maimaitawa tsakanin saƙonni — ya tabbatar da ƙirar injinanmu na headroom/ccr/session-dedup da ƙa'idar cewa "tsarin da aka matsa ba ya dogara da matsayinsa" kuma ya dace da ma'ajiyar cache.
Tsangwama da nazarin zirga-zirgar coding-assistant ↔ LLM ta MITM sun taimaka wajen tsara buƙatun farko na Traffic Inspector. An maye gurbin modules huɗu da aka samo a baya — haɗa SSE, daidaita tattaunawa, ɓoye sirri da tsabtace headers — da aiwatarwa masu zaman kansu, waɗanda aka gina daga tushe ba tare da duba asalin aiwatarwa ba, bisa ƙa'idodin yarjejeniyar jama'a. Fuskokin host-passthrough guda biyu (passthrough.ts da _internal/bypass.cjs) sun kasance aiwatarwa na cikin OmniRoute da aka rarrabe da kansu; ba a sake rubuta su a matsayin wani ɓangare na wannan maye gurbin ba.
Tsarin routing na proxy mai bayyana ga kowane tsari — ya zaburar da rufe MITM mai tsira daga rushewa, iyakokin rashin aiki na socket, danganta tsari ta /proc da kama TPROXY.
Jerin libraries da aka zaɓa masu tsaro ta tsohuwa, wanda ke jagorantar zaɓin tsaronmu (Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink).
Sake tsara models bisa la'akari da account, tantance executable-path da halayyar plan-label ɗinsa sun taimaka wajen tsara runtime na Antigravity na OmniRoute.
Ya gano quota surface na Grok Build; daga nan OmniRoute ya tabbatar da tsarin wire na ainihi kuma ya gyara shi da kansa.
## 📄 Lasin
Lasin MIT - duba [LICENSE](LICENSE) don ƙarin bayani.
---
**[⬆ Komawa sama](#-omniroute)** · An gina shi da ❤️ domin al'ummar AI mai buɗaɗɗen tushe.
Diego Souza ne ya ƙirƙira ta Diego Souza · OmniRoute v3.8.54 · Node ≥22.22.2 · Lasin MIT · omniroute.online
> Taƙaitaccen bayani mai motsi na shafin `/dashboard/free-tiers` na ainihi. Cikakkiyar hanyar aiki (cire maimaitawar tafki, matakan ƙiredit, sharuɗɗan masu bayarwa): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**.
>
> Ana sake duba waɗannan alkaluma kowane mako biyu bisa kundin bayanan ainihi kuma **suna iya hawa ko sauka** — idan mai bayarwa ya kawo ƙarshen matakin kyauta, adadin yana raguwa; idan sabo ya zo, yana ƙaruwa. Muna wallafa abin da kundin bayanan ke ƙididdigewa a zahiri, ba wani yanayi mafi kyau da aka zagaye zuwa sama ba.
```bash
# Bayan ka haɗa mai bayarwa, kwafi maɓallin OmniRoute naka 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 kasancewa ba ta da wasu wuraren makoma marasa maɓalli da suka cancanta, kuma mai bayarwa marar maɓalli na iya ƙin karɓar abokan ciniki na ɓangare na uku. Masu bayarwa masu alamar `tos: avoid`, har da Kiro, ana cire su daga turawa ta atomatik bisa tsoho; haɗa asusu ba ya sauya wannan saiti. Duba [Jagorar Matakan Kyauta](docs/getting-started/FREE-TIERS-GUIDE.md) kafin zaɓar mai bayarwa.
📦 Rubutun farawa cikin sauri na kwafi-da-manna don **Python, Node.js, PHP, da cURL** → [`examples/quickstart/`](examples/quickstart/)
> **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:
📖 [Injin Auto-Combo](docs/routing/AUTO-COMBO.md) · [Jagorar Juriya](docs/architecture/RESILIENCE_GUIDE.md)
📊 Cikakkiyar hanya & cikakkun bayanai kan 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 tarawa na tsoho yana gudanar da `RTK → Caveman`. Idan duka biyun suka yi aiki kan payload ɗin kayan aiki/mahallin guda, tanadin yana taruwa:
```txt
combined = 1 − (1 − RTK) × (1 − Caveman_input)
average = 1 − (1 − 0.80) × (1 − 0.46) = 89.2%
range = 78.4 – 94.6%
```
Tubalan lamba, URLs, JSON da tsararren bayanai suna **kare su koyaushe** ta injin adanawa.
> **Me ya sa za a yi amfani da tokens da yawa alhali kaɗan sun isa?** Kowace buƙata tana ratsa bututun matsawa na OmniRoute **a bayyane ba tare da canji ba** — babu canje-canje ga abokin ciniki. Yanzu ya zama **tarin injuna 12 masu haɗuwa** waɗanda ke gudana cikin jere kuma ana haɗa su yadda ya dace bisa tsarin routing — yana ginuwa kan dabaru 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 injuna 12
Injunan suna gudana bisa tsarin bututun aiki; ana iya kunna ko kashe kowanne daban, kuma a tsara shi bisa kowane haɗi:
