# 🚀 OmniRoute — مفت AI گیٹ وے
**تخلیق کار [Diego Souza](https://github.com/diegosouzapw)**
## 💰 فریقِ ثالث کے مفت درجات میں تقریباً 1.62B ٹوکنز / ماہ
> **اپنے فراہم کنندہ کے اکاؤنٹس خود لائیں۔** یہ الگ الگ اہل فریقِ ثالث کے مفت درجات کا تخمینی مجموعہ ہے، OmniRoute کی جانب سے ٹوکنز کی کوئی گرانٹ نہیں۔ جہاں ضروری ہو، سائن اپ کریں، اسناد حاصل کریں، اور ان فراہم کنندگان کو مربوط کریں جنہیں آپ استعمال کر سکتے ہیں؛ ہر فراہم کنندہ اپنی حدود، دستیابی اور شرائط خود متعین کرتا ہے۔
>
> مفت درجات کو دستی طور پر جمع کرنا تکلیف دہ ہے — درجنوں SDKs، درجنوں شرحی حدود، اور یہ جاننے کا کوئی طریقہ نہیں کہ حقیقت میں آپ کے پاس کتنا موجود ہے۔ OmniRoute **34 بار بار آنے والی pool keys میں 465 مفت درجے کی اندراجات** کی فہرست بناتا ہے اور ٹوکن کی سرخی **مثبت شائع شدہ ماہانہ بجٹ والے 17 pools کے علاوہ فی ماڈل Groq کی پانچ caps** سے اخذ کرتا ہے، جس میں مشترکہ pool کے ذریعے تکراری اندراجات ختم کی جاتی ہیں۔ وہ quotas جو صرف علاقائی شناخت کی جانچ کے بعد دستیاب ہوتے ہیں (آج: ModelScope) الگ دکھائے جاتے ہیں، علاقائی شناخت کی تصدیق کے بعد مزید تقریباً 6M شامل ہوتے ہیں، اور انہیں کبھی بھی سرخی میں جمع نہیں کیا جاتا۔ نتیجہ dashboard (`/dashboard/free-tiers`) پر نمایاں رہتا ہے۔
> live `/dashboard/free-tiers` صفحے کا متحرک خلاصہ۔ مکمل طریقۂ کار (pool dedupe، credit tiers، provider terms): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**۔
>
> ان اعداد و شمار کا ہر دو ہفتے بعد live catalog کے مقابلے میں دوبارہ جائزہ لیا جاتا ہے اور یہ **دونوں سمتوں میں تبدیل ہوتے ہیں** — کوئی فراہم کنندہ مفت درجہ ختم کرتا ہے تو تعداد کم ہو جاتی ہے؛ کوئی نیا شامل ہوتا ہے تو بڑھ جاتی ہے۔ ہم وہی شائع کرتے ہیں جو catalog حقیقت میں حساب کرتا ہے، کبھی بھی اوپر کی طرف گول کیا ہوا بہترین مفروضہ نہیں۔
⭐ اگر OMNIROUTE نے آپ کے پیسے بچانے اور کام آسان بنانے میں مدد کی ہے تو repo کو Star دیں۔
[](https://github.com/diegosouzapw/OmniRoute)
[](https://www.star-history.com/diegosouzapw/omniroute)
[](https://olud.ai/project/diegosouzapw-omniroute.html)
### 💬 کمیونٹی میں شامل ہوں
**👋 Maintainer کو فالو کریں — نئے فراہم کنندگان، ریلیزز اور تجاویز سب سے پہلے حاصل کریں:**
[](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)
**سوالات، فراہم کنندگان سے متعلق تجاویز، روڈمیپ اور معاونت → [Discord](https://discord.gg/U47eFqAXCn) · [Telegram](https://t.me/omnirouteOficial) · WhatsApp [🌍 Global](https://chat.whatsapp.com/FvuCbrpZmQ6I85n2vW5QIC?s=cl&p=a&mlu=4) / [🇧🇷 Brasil](https://chat.whatsapp.com/KWgatljAjmbELQory59Oti?s=cl&p=a&mlu=4) / [Portal](https://portal.sthub.com.br/communities/groups/st-hub/channels/Omniroute-World-8kRjmK)**
## 📈 گیٹ وے مسلسل ترقی کر رہا ہے
## 🆓 انسٹال کریں، کسی فراہم کنندہ سے کنیکٹ کریں، پھر ایک اینڈ پوائنٹ کے ذریعے روٹ کریں
```bash
# کسی provider سے کنیکٹ ہونے کے بعد، Dashboard → Endpoints سے اپنی OmniRoute key کاپی کریں:
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` کے لیے ایک اہل route درکار ہے۔ نئی installation میں کوئی اہل keyless target موجود نہ ہو سکتا ہے، اور کوئی keyless provider third-party clients کو مسترد کر سکتا ہے۔ `tos: avoid` کے بطور نشان زد providers، بشمول Kiro، بطور ڈیفالٹ automatic routing سے خارج رہتے ہیں؛ کسی account سے کنیکٹ ہونے پر یہ ترتیب تبدیل نہیں ہوتی۔ کسی provider کا انتخاب کرنے سے پہلے [Free Tiers Guide](docs/getting-started/FREE-TIERS-GUIDE.md) دیکھیں۔📦 **Python، Node.js، PHP، اور cURL** کے لیے copy-paste quickstart scripts → [`examples/quickstart/`](examples/quickstart/)
# 💥 وعدہ
# 🤔 OmniRoute کیوں؟
## 🤝 ہمارے اوپن سورس دوستوں کا تعاون
> **کیا آپ بطور اوپن سورس دوست شامل ہونا چاہتے ہیں؟** یہ وہ کمپنیاں ہیں جو اوپن سورس کی حمایت کرتی ہیں اور OmniRoute کو متحرک رکھنے میں مدد کرتی ہیں — اور ہم عوامی طور پر بتاتے ہیں کہ ان کا دیا ہوا ہر ٹوکن کہاں جاتا ہے۔ رابطہ کریں: [diegosouza.pw@outlook.com](mailto:diegosouza.pw@outlook.com)
Kimi Moonshot AI
اس پروجیکٹ کی حمایت کرنے کے لیے ہمارے بانی اوپن سورس دوست، Kimi (Moonshot AI) کا شکریہ! Kimi وہ AI لیب ہے جو اوپن ویٹ K2 اور K3 ماڈل فیملیز کے پیچھے ہے — Kimi K3 ایک 1M-ٹوکن سیاق و سباق کی ونڈو، مقامی وژن اور فرنٹیئر لیول کی کوڈنگ فراہم کرتا ہے جو کلوزڈ ماڈلز کی قیمتوں کے ایک معمولی حصے پر دستیاب ہے، اور یہ Claude Code، Codex اور OmniRoute کے ذریعے فراہم کردہ ہر کوڈنگ ٹول کے ساتھ فوری طور پر کام کرتا ہے۔
Kimi کا تعاون کن چیزوں کو طاقت دیتا ہے: Kimi کے API کریڈٹس OmniRoute کی AI سے تصدیق شدہ ریلیز پائپ لائن کو طاقت دیتے ہیں — یعنی merge validation powered by Kimi K3 کا مرحلہ جو ہر پل ریکوئسٹ (pull request) کے بھیجے جانے سے پہلے اس کا جائزہ لیتا ہے — اس کے علاوہ روزانہ کی فیچر ڈویلپمنٹ۔ فرسٹ کلاس Kimi سپورٹ دونوں طریقوں پر دستیاب ہے: براہ راست Kimi API (kimi-k3) اور Kimi Code کوڈنگ پلان (OAuth اور API key)۔ OmniRoute، Kimi کے سپورٹ پروگرام میں پہلا برازیلی اوپن سورس پروجیکٹ بھی ہے۔ 15% اضافی کریڈٹس کے ساتھ Kimi API کلید حاصل کریں ←
Cheaper Inference cheaperinference.com
اس پروجیکٹ کی حمایت کرنے کے لیے OmniRoute کے اوپن سورس دوست، Cheaper Inference کا شکریہ! Cheaper Inference ایک لاگت کے لحاظ سے درجہ بندی شدہ گیٹ وے ہے جو 42 فرنٹیئر ماڈلز — Claude، GPT-5.x، Gemini، Kimi K3، GLM، DeepSeek، Grok اور MiniMax — کو ایک OpenAI کے ہم آہنگ اینڈ پوائنٹ کے پیچھے دوبارہ فروخت کرتا ہے، ہر درخواست کو سستے ترین اہل فراہم کنندہ کی طرف بھیجتا ہے بغیر ماڈل بنانے والے کی لسٹ پرائس سے زیادہ چارج کیے۔
OmniRoute میں فرسٹ کلاس سپورٹ: Chat Completions، مقامی /v1/responses اینڈ پوائنٹ، وژن، ٹول کالنگ اور 3 امیج ماڈلز (grok-imagine، nano-banana-pro، nano-banana-2، جو cheaperinference/<model> کے طور پر قابل رسائی ہیں)۔ ایک API کلید حاصل کریں ←
ٹیگ شدہ لنکس aff=omniroute پارٹنر لنکس ہیں۔ وہ آپ کے لیے بغیر کسی اضافی قیمت کے پروجیکٹ کے لیے فنڈز فراہم کرتے ہیں۔ 🎟️ ایفی لیٹس پرومو — ان فراہم کنندگان سے مفت سائن اپ کوپن جنہیں ہم سپانسر نہیں کرتے (پھیلانے کے لیے کلک کریں)یہ سیکشن صرف ریفرل/کوپن کوڈز کے لیے ہے۔ سپانسر شدہ شراکت داریاں اوپر 🤝 ہمارے اوپن سورس دوستوں کا تعاون میں موجود ہیں۔ OmniRoute کی یہاں درج فراہم کنندگان کے ساتھ کوئی سپانسرشپ یا شراکت داری نہیں ہے — یہ عوامی کوپن ہیں جنہیں کوئی بھی استعمال کر سکتا ہے۔
AgentRouter agentrouter.org
AgentRouter — ایفی لیٹ سائن اپ · $100 مفت کریڈٹس سائن اپ پر (مفت سرور، زیادہ لیٹنسی کی توقع رکھیں — ٹیسٹنگ کے لیے بہترین، پروڈکشن کے لیے نہیں)۔ v3.8.50 سے OmniRoute میں فرسٹ کلاس سپورٹ: Chat Completions، Anthropic کے ہم آہنگ وائر فارمیٹ اور OpenAI کے ہم آہنگ پاتھ۔ دستیاب ماڈلز میں claude-opus-4-8، claude-opus-5، gpt-5.6-sol اور بہت کچھ شامل ہیں۔ اپنے $100 حاصل کریں ←
⚠️ ایفی لیٹ لنک — OmniRoute کی اس فراہم کنندہ کے ساتھ کوئی سپانسرشپ یا شراکت داری نہیں ہے۔
کیا آپ کسی اور فراہم کنندہ کو جانتے ہیں جس کے پاس فراخدلانہ مفت سائن اپ کوپن ہے جو OmniRoute صارفین کو فائدہ پہنچاتا ہے؟ ایک ایشو (issue) کھولیں اور ہم اسے یہاں شامل کر دیں گے۔
## 🎯 کومبوز — نمایاں خصوصیت
> **کومبو** ماڈلز کی ایک زنجیر ہے جن کے درمیان OmniRoute **خودکار طور پر** روٹنگ کرتا ہے۔ اگر کوٹا ختم ہو جائے، کوئی فراہم کنندہ ناکام ہو جائے، یا اخراجات اچانک بڑھ جائیں، تو کومبو اگلے اہل اور صحت مند ماڈل پر منتقل ہو سکتا ہے۔ 🛡️
### ⚡ صفر کنفیگریشن — بس `auto` استعمال کریں
کوئی کومبو بنانے کی ضرورت نہیں۔ اپنے ماڈل کو `auto` (یا اس کی کسی قسم) پر سیٹ کریں، اور OmniRoute آپ کے منسلک فراہم کنندگان سے ایک ورچوئل کومبو بناتا ہے، جس کی لائیو اسکورنگ کی جاتی ہے:
ماڈل ID
یہ کس چیز کو بہتر بناتا ہے
auto
🎯 متوازن ڈیفالٹ (LKGP — آپ کے آخری اچھے فراہم کنندہ سے وابستہ رہتا ہے)
auto/coding
🧑💻 کوڈ تیار کرنے کے لیے معیار کو ترجیح دینے والے اوزان
auto/fast
⚡ سب سے کم تاخیر پہلے
auto/cheap
💰 فی ٹوکن سب سے سستا پہلے
auto/subscription
🎟️ صرف وہ سبسکرپشن کوٹا جس کی آپ پہلے ہی ادائیگی کرتے ہیں — بند حالت میں ناکام ہوتا ہے، کبھی قابلِ بل فال بیک استعمال نہیں کرتا (رہنما)
auto/thrifty
🪜 پہلے پلان کا کوٹا، پھر ایک وقت میں ایک درجہ طے کرتے ہوئے سب سے سستے بامعاوضہ اختیارات تک — پلان ری سیٹ ہونے کے بعد دوبارہ اسی پر واپسی (رہنما)
auto/offline
🔋 سب سے زیادہ کوٹا / شرح کی حد کی گنجائش پہلے
auto/smart
🔭 معیار پہلے + بہتر ماڈلز دریافت کرنے کے لیے 10% کھوج
auto/lkgp
📌 واضح طور پر آخری معلوم اچھے فراہم کنندہ سے وابستگی
auto/chaos
🧪 ماڈلز کے ایک پینل تک متوازی پھیلاؤ (فی فراہم کنندہ ایک، ڈیفالٹ طور پر 5)، ایک جواب واپس کرتا ہے؛ فی پینل ماڈل ایک اپ اسٹریم کال، خرابی داخل کرنا نہیں
##
### 🔀 یا اپنا بنائیں — روٹنگ کی 20 حکمتِ عملیاں
تمام **20** حکمتِ عملیاں — ہر کومبو مرحلے پر حسبِ خواہش ملائیں:
#
حکمتِ عملی
یہ کیا کرتی ہے
1
priority
پہلے ہدف کی ترتیب وار فہرست — اگلے سے پہلے ہر ایک کو مکمل استعمال کریں 🥇
2
fill-first
آگے بڑھنے سے پہلے ہر ہدف کا کوٹا مکمل طور پر استعمال کریں
3
weighted
فی ہدف وزن کے مطابق وزنی بے ترتیب انتخاب
4
round-robin
اہداف کو ترتیب سے باری باری استعمال کریں
5
p2c
دو انتخاب کی قوت پر مبنی بے ترتیب لوڈ بیلنسنگ
6
least-used
سب سے کم موجودہ لوڈ والا ہدف منتخب کریں
7
random
یکساں بے ترتیب انتخاب (نقلیں ہٹا کر)
8
strict-random
تکرار کی نقلیں ہٹائے بغیر بے ترتیب انتخاب 🎲
9
cost-optimized
لائیو کیٹلاگ قیمتوں سے فی درخواست $ کو کم سے کم کریں 💸
10
headroom
سب سے زیادہ باقی کوٹا والا ہدف منتخب کریں
11
quota-weighted
ختم شدہ اکاؤنٹس چھوڑ دیں، پھر باقی کوٹا ÷ زیرِ عمل لوڈ کے تناسب سے انتخاب کریں — موجودہ گفتگوئیں اسی ہدف سے منسلک رہتی ہیں ⚖️
12
reset-window
اس ہدف کو ترجیح دیں جس کی کوٹا ونڈو سب سے جلد ری سیٹ ہوتی ہے
13
reset-aware
کوٹا ری سیٹ کے وقت کے مطابق درجہ بندی کریں — مختصر ونڈوز پہلے 📊
14
context-relay
طویل گفتگوؤں کے لیے سیاق و سباق کو اہداف کے درمیان منتقل کریں 🧠
15
context-optimized
موجودہ سیاق و سباق کے حجم کے لیے موزوں ترین ہدف منتخب کریں
16
cache-optimized
ہر دوبارہ قابلِ استعمال پرامپٹ سابقے کو اسی اکاؤنٹ سے منسلک رکھیں — پرامپٹ کیش ہٹس کو زیادہ سے زیادہ کریں 🎯
17
lkgp
آخری معلوم اچھا راستہ — آخری کامیاب فراہم کنندہ سے منسلک رکھتا ہے، پھر قواعد پر فال بیک کرتا ہے
18
auto
ہر کنکشن میں 16 عوامل پر مبنی لائیو اسکورنگ 🤖
19
fusion
ماڈلز کے ایک پینل تک پھیلاؤ + ایک جج ایک جواب مرتب کرتا ہے 🧬
20
pipeline
مراحل کو زنجیر بنائیں — ہر ہدف کا آؤٹ پٹ اگلے کو فراہم ہوتا ہے 🔗
Auto-Combo انجن ہر امیدوار کو **16 عوامل** (صحت، کوٹا، لاگت، تاخیر، کام سے مطابقت، معیار، سیشن کی دستیابی…) کی بنیاد پر اسکور دیتا ہے — دیکھیے [`docs/routing/AUTO-COMBO.md`](docs/routing/AUTO-COMBO.md)۔
##
### 🧱 لچک پذیری پہلے سے شامل ہے (3 خود مختار تہیں)
📖 [Auto-Combo انجن](docs/routing/AUTO-COMBO.md) · [لچک پذیری کی رہنما دستاویز](docs/architecture/RESILIENCE_GUIDE.md)
## 🏆 OmniRoute کو ممتاز کیا بناتا ہے
📊 9router، OpenRouter، CLIProxyAPI اور LiteLLM کے مقابلے میں مکمل طریقۂ کار اور فیچر بہ فیچر تفصیل → [`docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md`](docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md)
## 💚 OmniRoute کی معاونت کریں
OmniRoute کو MIT لائسنس حاصل ہے اور اسے کھلے عام برقرار رکھا جاتا ہے۔ اگر یہ آپ کا وقت یا پیسہ بچاتا ہے، تو اسے خودمختار رکھنے کے طریقے یہ ہیں — جو آپ کے لیے موزوں ہو، اسے منتخب کریں۔ اسپانسرشپ کبھی بھی روٹنگ کی ترجیح پر اثرانداز نہیں ہوتی؛ اس سے صرف نمایاں حیثیت ملتی ہے، درجہ بندی نہیں۔
**🇧🇷 PIX** — فوری، کوئی فیس نہیں (برازیل)
کلید (بے ترتیب): `5d865059-bc44-483a-962d-43ceb80126eb`
Pix کاپی اور پیسٹ:
```
00020101021126580014br.gov.bcb.pix01365d865059-bc44-483a-962d-43ceb80126eb5204000053039865802BR5922OMNIROUTE CONTRIBUICAO6006BRASIL62070503***630475DD
```
₿ کرپٹو — BTC · ETH · USDT-TRC20 · USDC-Solana (توسیع کے لیے کلک کریں)
₿ BTC
Bitcoin (SegWit)
bc1qh00smz004sy85wyl28v77tenkt3ckl6eaep7fd
Ξ ETH
Ethereum (ERC20)
0x64Cf6B68A6Ff34288e89172950a2d00102337a84
₮ USDT
Tron (TRC20)
TKAF41JpuQrHbKTnsQa9svJE2T192Hvsc2
$ USDC
Solana
2emNNZzVVWQc3FQ2wk9M6qXUQmW8AKdjjL174fXR28Tu
⚠️ ہر کوائن صرف دکھائے گئے نیٹ ورک پر بھیجیں — غلط نیٹ ورک پر بھیجنے سے فنڈز ضائع ہو سکتے ہیں۔
🐛 کوئی بگ ملا یا آپ کے پاس رائے ہے؟ ایک [Discussion](https://github.com/diegosouzapw/OmniRoute/discussions) کھولیں۔
ڈویلپر نوٹس: ڈویلپر کی سہولت کے لیے پروجیکٹ npm install/postinstall کے دوران ایک مقامی .env فائل بنا سکتا ہے۔ اس فائل کو جان بوجھ کر .gitignore کے ذریعے نظر انداز کیا جاتا ہے (.gitignore دیکھیں) اور اسے کبھی بھی کمٹ نہیں کرنا چاہیے — اگر یہ غلطی سے کمٹ ہو جائے تو ظاہر ہونے والے تمام راز تبدیل کریں اور فائل کو ہسٹری سے ہٹا دیں۔ مقامی ماحول کی فائلوں اور رازوں کے انتظام سے متعلق رہنمائی کے لیے docs/DEVELOPER-ENVIRONMENT.md دیکھیں۔
## 📡 OmniRoute Radar
اوپر درج دستاویزی اور پول کی سطح پر نقل سے پاک کیٹلاگ سے مفت درجے کی بنیادی پیشکش بدستور **~1.62B ٹوکنز/ماہ** ہے۔ فراہم کنندگان کے عارضی سائن اَپ کریڈٹس پہلے مہینے کی حد کو علیحدہ طور پر بڑھا کر **~2.22B** تک لے جا سکتے ہیں۔ Radar ایک اختیاری، دستخط شدہ کیٹلاگ اوورلے ہے، جو ان لوگوں کے لیے ہے جو OmniRoute کی ریلیزز کے درمیانی عرصے میں مفت ماڈلز کی تازہ ترین دستیابی چاہتے ہیں؛ کمیونٹی کیٹلاگ اور تمام موجودہ مفت خصوصیات بدستور مفت رہیں گی۔
معاونین لائیو کیٹلاگ اور فراہم کنندگان کے اضافی مواقع حاصل کر سکتے ہیں۔ اس کی علیحدہ،
تبدیل ہونے والی بالائی حد فراہم کنندگان کی دستیابی کے لحاظ سے **زیادہ سے زیادہ تقریباً 3B ٹوکنز/ماہ** ہے۔
یہ بالائی حد ضمانت نہیں ہے: فراہم کنندگان کسی بھی وقت کوٹے، اہلیت، ماڈلز یا خطے تبدیل کر سکتے ہیں۔
Radar اختیاری ہے اور صرف GET استعمال کرتا ہے۔ OmniRoute کلائنٹ پرامپٹس، ٹریفک، فراہم کنندہ
کی کنفیگریشن، استعمال کی ٹیلی میٹری، یا اعلانات مسترد کرنے کی مقامی حالت اپ لوڈ نہیں کرتا۔ اہلیت اور
موجودہ کیٹلاگ کے بارے میں **[radar.omniroute.online/planos](https://radar.omniroute.online/planos)** پر جانیں۔
## ✨ نیا کیا ہے
> **v3.8.20 → v3.8.54** کی حالیہ جھلکیاں۔ مکمل تاریخ [`CHANGELOG.md`](CHANGELOG.md) میں موجود ہے۔
- **⚖️ `quota-weighted` روٹنگ** — 20ویں کومبو حکمتِ عملی میں ختم شدہ اکاؤنٹس کو نظرانداز کیا جاتا ہے، پھر باقی اکاؤنٹس میں دستیاب کوٹے ÷ زیرِ عمل لوڈ کے تناسب سے انتخاب کیا جاتا ہے، جبکہ موجودہ گفتگوئیں اپنے اکاؤنٹس سے منسلک رہتی ہیں۔ → [آٹو-کومبو](docs/routing/AUTO-COMBO.md)
- **🧰 ہیڈلیس موڈ** — `omniroute serve --headless` (یا `OMNIROUTE_HEADLESS=1`) صرف `/v1/*` پراکسی انجن چلاتا ہے، جبکہ ڈیش بورڈ اور صرف ڈیش بورڈ کے لیے مخصوص ذیلی نظام بند رہتے ہیں۔ → [ہیڈلیس موڈ](docs/guides/HEADLESS.md)
- **🔎 ماڈل دریافت** — `/v1/models` صلاحیت، سیاق، قسم اور متن کے مطابق فلٹر کرتا ہے، جبکہ `POST /v1/models/query` اسی فی-کلید مرئیت کے ساتھ مختصر اور متعین شارٹ لسٹ واپس کرتا ہے۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **🔑 فی-کلید روٹنگ کنٹرول** — `forcedModel` کے ذریعے کسی API کلید کو ایک ماڈل یا کومبو سے منسلک کریں، اور کسی کلید کے ماڈلز و کومبو کو جوہری طور پر شامل یا حذف کریں (`/api/keys/{id}/access`)۔ → [API حوالہ](docs/reference/API_REFERENCE.md) · [OpenAPI](docs/openapi.yaml)
- **🛡️ مزید باریک PII کنٹرولز** — فی-قسم انتخاب، زیادہ سے زیادہ 20 توثیق شدہ حسبِ ضرورت ماسکنگ پیٹرنز، اور فی-قسم شناختی کاؤنٹرز؛ ماسکنگ اب بھی اختیاری ہے۔ → [گارڈ ریلز](docs/security/GUARDRAILS.md)
- **🌍 67 زبانیں** — ڈیش بورڈ، دستاویزات کے آئینے اور CLI کے لیے؛ `npm run i18n:add-locale` ایک ہی کمانڈ سے ہر جگہ ایک زبان شامل کرتا ہے۔ → [i18n رہنما](docs/guides/I18N.md)
- **🎛️ OmniConductor** — آپ کے ایجنٹ فلیٹ کو inbound A2A تفویض، Agent Card پر Conductor skills، اور Faro push-to-talk صوتی چیٹ کے ساتھ ڈیش بورڈ پینل۔ → [A2A سرور](docs/frameworks/A2A-SERVER.md)
- **🛂 موافقانہ داخلہ اور اوورلوڈ تحفظ** — بھاری چیٹ درخواستیں 503 دینے کے بجائے قطار میں شامل ہو جاتی ہیں، جبکہ ہر کنکشن کے لیے RPM رولنگ لیزز جوہری انداز میں نافذ ہوتی ہیں۔ → [لچک پذیری رہنما](docs/architecture/RESILIENCE_GUIDE.md)
- **🗂️ معیاری `/v1/models` ترتیب** — ہر فراہم کنندہ کے لیے ایک مسلسل، فراہم کنندہ کے لحاظ سے گروپ شدہ بلاک (کومبو پہلے پن کیے گئے)، جو ہر کیٹلاگ ماخذ میں یکساں رہتا ہے۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **🗜️ کمپریشن کی مضبوطی** — بطورِ پیش فرض فعال inflation guard، DE / FR / JA اور چینی (wényán) کے لیے Caveman packs، Gradle اور .NET کے لیے RTK filters۔ → [کمپریشن](docs/compression/COMPRESSION_ENGINES.md)
- **💸 دیانت دار فلیٹ ریٹ لاگت** — subscription / coding-plan فراہم کنندگان لاگت کے تجزیات میں **$0** دکھاتے ہیں؛ بجٹ، کوٹا اور روٹنگ کا تخمینہ برقرار رہتا ہے۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **⚖️ Quota-Share روٹنگ** — مشترکہ اکاؤنٹ کے کوٹے کو pooled keys میں منصفانہ طور پر تقسیم کرتی ہے، اور کام کے دوران اس طرح کام کرتی ہے کہ غیر فعال حصے قرض دیے جا سکیں۔ → [لچک پذیری رہنما](docs/architecture/RESILIENCE_GUIDE.md)
- **🤖 ایک کمانڈ سے CLI/ایجنٹ سیٹ اپ** — 15 رجسٹرڈ `setup-*` کمانڈز؛ `omniroute run` 7 CLIs (Claude Code، Codex، Aider، Goose، OpenCode، Qwen Code، Gemini CLI) لانچ کرتا ہے؛ `omniroute configure` interactive provider+model picker اور فی-سیاق پسندیدہ انتخاب کے ساتھ 11 اہداف کو سپورٹ کرتا ہے۔ → [CLI انضمامات](docs/guides/CLI-INTEGRATIONS.md)
- **🛰️ ریموٹ موڈ** — scoped tokens (`connect` / `contexts` / `tokens`) کے ذریعے ریموٹ OmniRoute چلائیں، اور VPS تنصیبات کے لیے `antigravity` OAuth helper استعمال کریں۔ → [ریموٹ موڈ](docs/guides/REMOTE-MODE.md)
- **🧭 زیادہ ذہین خودکار روٹنگ** — `auto/:` کومبو، **Fusion** (ماڈل پینل + judge)، کام سے آگاہ روٹنگ، اور فی درخواست ماڈل / موڈ / USD-بجٹ اوور رائیڈز۔ → [آٹو-کومبو](docs/routing/AUTO-COMBO.md)
- **🗜️ قابلِ توسیع کمپریشن** — 12 قابلِ ترکیب انجن اور Compression Studios: LLMLingua-2، دو سطحی Ultra، omniglyph، فی-مرحلہ fidelity gate، GCF v3.2، اور drag-reorder editor۔ → [کمپریشن](docs/compression/COMPRESSION_ENGINES.md)
- **🕵️ شفاف MITM decrypt (TPROXY)** — ایسی CLIs کو capture کریں جو proxy env vars کو نظرانداز کرتی ہیں، اور فی-SNI CA + trust-store installer استعمال کریں۔ → [MITM/TPROXY](docs/security/MITM-TPROXY-DECRYPT.md)
- **💸 ہر جگہ لاگت کا ٹیلی میٹری** — ہر endpoint پر `X-OmniRoute-*` لاگت/استعمال ہیڈرز، cache-HIT بچت ہیڈر، اور فی-کلید USD خرچ کے کوٹے۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **🧠 آپ کے اختیار میں میموری** — بطورِ پیش فرض بند، اختیاری int8 vector quantization + typed decay، اور فی درخواست `x-omniroute-no-memory`۔ → [میموری](docs/frameworks/MEMORY.md)
- **🛡️ سیکیورٹی** — ہر LLM روٹ پر prompt-injection guard (red-team suite)، اختیاری credential-masking guardrail (دونوں سمتوں میں افشا شدہ API keys/secrets کو چھپاتا ہے)، آخری درجے کی مفت DuckDuckGo ویب سرچ، اور ڈیش بورڈ کے لیے اختیاری OIDC login gate (پاس ورڈ لاگ اِن ہمیشہ دستیاب رہتا ہے)۔ → [گارڈ ریلز](docs/security/GUARDRAILS.md)
- **🖼️ نئے endpoints** — `/v1/ocr` (Mistral OCR) اور `/v1/audio/translations` (Whisper-style)، میڈیا کی سطح کو مکمل کرتے ہیں۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **🎨 تصویر / ویڈیو / آڈیو تخلیق** — میڈیا کے لیے ایک API: xAI Grok Imagine اور Novita AI video، ComfyUI، Magnific، Adobe Firefly، Segmind، اور ElevenLabs جیسے speech providers۔ → [API حوالہ](docs/reference/API_REFERENCE.md)
- **🌍 تعیناتی اور آپریشنز** — reverse-proxy `basePath`، براؤزر-زبان کی خودکار شناخت، فی-کلید ڈیوائس ٹریکنگ، root-less MITM trust، اور zh-TW لوکلائزیشن۔ → [ماحول](docs/reference/ENVIRONMENT.md)
- **🤝 مزید فراہم کنندگان اور ایجنٹس** — cloud agents (Codex Cloud، Cursor، Devin، Jules)، browser + OAuth login کے ساتھ Grok Build (xAI)، first-class card والا Ollama، Claude Opus 5 اور Sonnet 5، Kimi کی سرکاری شراکت داری (Code/Web/Moonshot)، Zed، Requesty، SenseNova، Yuanbao، Agnes AI… اور تازہ کردہ **388-provider catalog**۔ → [فراہم کنندگان](docs/reference/PROVIDER_REFERENCE.md)
- **📡 شفاف روٹنگ** — ہر response میں `X-OmniRoute-Decision` ہیڈر شامل ہوتا ہے جو اسے فراہم کرنے والی strategy/provider/latency کا نام بتاتا ہے؛ نئی `cache-optimized` combo strategy اور Auto-Combo `cacheAffinity` factor بار بار آنے والی درخواستوں کو اس connection کی طرف واپس بھیجتے ہیں جس کے پاس cached prefix موجود ہو؛ اور صرف مطالعے کے لیے `/v1/auto-combo/{channel}/candidates` endpoint کسی `auto/*` channel کے فعال candidate pool کو ظاہر کرتا ہے۔ → [آٹو-کومبو](docs/routing/AUTO-COMBO.md)
- **⚡ مقامی کارکردگی اور انفرا —** ایک کلک پر مقامی Redis، Cloudflare Workers / Deno Deploy ریلے ڈپلائرز، اور Bifrost و Mux بطور زیرِ نگرانی ایمبیڈڈ سروسز۔ → [ایمبیڈڈ سروسز](docs/frameworks/EMBEDDED-SERVICES.md)
- **🧩 پیکیج میں مزید شامل —** پلگ اِن فریم ورک اور مارکیٹ پلیس، Omni/Agent/GitHub اسکلز فریم ورکس، Obsidian والٹ انٹیگریشن (22 MCP ٹولز)، OpenAI سے ہم آہنگ Batch اور Files APIs، سیمینٹک رسپانس کیش، لیڈر بورڈز کے ساتھ گیمیفیکیشن، ACP ایجنٹ دریافت (15 بلٹ اِن ایجنٹس)، BigQuery کو مقررہ شیڈول کے مطابق لاگ ایکسپورٹ، `auto/chaos` متوازی ملٹی ماڈل فین آؤٹ، Telegram بوٹ برج، ایپ میں موجود ورژن مینیجر، اور LMArena-ELO مفت فراہم کنندگان کی درجہ بندیاں۔ → [دستاویزات](docs/README.md)
## 🤖 ہم آہنگ CLI اور کوڈنگ ایجنٹس
> ایک ہی کنفیگریشن — `http://localhost:20128/v1` — اور **ہر** AI IDE یا CLI مفت اور کم لاگت ماڈلز پر چلتا ہے۔
＋ یہ بھی کام کرتا ہے · Agent Deck · Kiro · Command Code · Antigravity · Windsurf · AMP · کسی بھی OpenAI-compatible ٹول
📖 ہر ٹول کے لیے سیٹ اپ (کل ۳۹ ٹولز: ۲۸ CLI کوڈز + ۱۱ CLI ایجنٹس) → [`docs/reference/CLI-TOOLS.md`](docs/reference/CLI-TOOLS.md) · 🧩 اوپن کوڈ پلگ ان → [`@omniroute/opencode-provider`](https://www.npmjs.com/package/@omniroute/opencode-provider)
**OmniRoute کے ذریعے کسی بھی سپورٹڈ CLI کو ایک کمانڈ میں لانچ کریں** — کوئی کنفیگریشن فائلز نہیں لکھی جاتیں،
ہر پراسیس کے لیے اسناد (credentials) شامل کی جاتی ہیں، Qwen/Gemini کو عارضی اور الگ ہوم ملتا ہے:
```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"
# یا فراہم کنندہ اور ماڈل کو انٹرایکٹو طریقے سے منتخب کریں اور ٹول کی اپنی کنفیگریشن لکھیں:
omniroute configure codex # یہ بھی: claude opencode qwen aider goose gemini cline continue kilo 5dive
```
ہر کمانڈ فعال ریموٹ کانٹیکسٹ (`omniroute connect `) کو فالو کرتی ہے، `--dry-run`
بالکل وہی env/args دکھاتا ہے بغیر ایکزیکیوٹ کیے، اور `--api-key-env NAME` آپ کے شیل ہسٹری سے راز محفوظ رکھتا ہے۔ → [CLI انٹیگریشنز](docs/guides/CLI-INTEGRATIONS.md)
## 🌐 388 AI فراہم کنندگان — 153 کیٹلاگ میں نشان زدہ مفت
> **388 رجسٹرڈ فراہم کنندگان** کینونیکل چیٹ، میڈیا، سرچ، لوکل، کلاؤڈ-ایجنٹ اور سسٹم کلیکشنز میں شامل ہیں، جن میں **153 کے پاس `hasFree: true` دریافت میٹا ڈیٹا** موجود ہے۔ چیٹ ماڈل رجسٹری میں **239 فراہم کنندگان / 3,059 منفرد فراہم کنندہ-ماڈل جوڑے / 1,475 خام ماڈل IDs** شامل ہیں؛ جبکہ علیحدہ مفت بجٹ کیٹلاگ میں **471 فی-ماڈل قطاریں**، **34 بار بار آنے والے پولز** اور **52 بار بار آنے والے/کی لیس ہمیشہ کے لیے مفت فراہم کنندگان** شامل ہیں۔ یہ مختلف ڈینومینیٹرز جان بوجھ کر رکھے گئے ہیں؛ تعریفیں اور پول-ڈی ڈپلیکیٹ شدہ حسابات [فراہم کنندہ حوالہ](docs/reference/PROVIDER_REFERENCE.md) اور [مفت درجات](docs/reference/FREE_TIERS.md) میں موجود ہیں۔
### 🏢 ہر بڑا لیب — ایک ہی اینڈ پوائنٹ کے ذریعے
OpenAI
Anthropic
Gemini
xAI Grok
DeepSeek
Mistral
Qwen
Meta Llama
Groq
NVIDIA
MiniMax
Cohere
Perplexity
HuggingFace
Together
Fireworks
Cloudflare
Baidu
…اور 350+ مزید — ہر آئیکن ڈیش بورڈ کے فراہم کنندہ کیٹلاگ سے براہِ راست حل ہوتا ہے۔ 📖 [فراہم کنندہ حوالہ](docs/reference/PROVIDER_REFERENCE.md)
### 🆓 ہمیشہ مفت — $0، کارڈ کی ضرورت نہیںnguai
OpenCode Zen DeepSeek V4، Nemotron 3 ٹوکن کی کوئی حد نہیں
Kilo Code خودکار راؤٹر، Tencent Hy3 ہمیشہ کے لیے مفت
Requesty GPT-OSS 120B، Nemotron ہمیشہ کے لیے مفت
SiliconFlow DeepSeek V3.2 / R1 مفت درجۂ استعمال
Z.AI GLM GLM-4.7 / 4.5-Flash ہمیشہ کے لیے مفت
Baidu ERNIE ERNIE 4.0 ہمیشہ کے لیے مفت
Qoder AI Qwen3-Max، Kimi-K2 لامحدود مفت
Pollinations GPT، Llama، Claude کلید درکار نہیں
Cloudflare AI 50 سے زیادہ ماڈلز روزانہ 10K نیورونز
NVIDIA NIM GLM، MiniMax تقریباً 40 RPM مفت
Cerebras GLM 4.7، GPT-OSS ایک بار کا $5 کریڈٹ؛ کارڈ درکار ہے
### 🧩 نیا: OmniRoute VS کوڈ کے مقامی Copilot چیٹ کے اندر
> کوئی نیا سائڈبار نہیں، کوئی نیا چیٹ UI نہیں — ہر ماڈل OmniRoute پیش کرتا ہے بالکل اسی میں ظاہر ہوتا ہے**Copilot چیٹ ماڈل چننے والا آپ پہلے ہی استعمال کر رہے ہیں۔** . VS کوڈ 1.122 کے بعد سے، فراہم کنندہ ماڈل GitHub سائن ان یا Copilot سبسکرپشن کے بغیر کام کرتے ہیں — ایجنٹ موڈ، ٹول کالنگ اور وژن، مفت میں۔
انسٹال کریں۔** [OmniCopilot](https://github.com/diegosouzapw/OmniCopilot)** توسیع، اسے اپنے OmniRoute سرور ( `localhost:20128` پر پہلے سے طے شدہ) کی طرف اشارہ کریں، پھر Copilot چیٹ → ماڈل چننے والا → کھولیں۔** ماڈلز کا نظم کریں…** →**OmniRoute** .
ایڈیٹر کے اندر سے: کھولیں۔** ایکسٹینشنز** دیکھنا، تلاش کرنا** "OmniRoute"** ، کلک کریں۔** انسٹال کریں۔** - دونوں اسٹورز پر اسی طرح کام کرتا ہے۔ ماخذ، مسائل اور پبلشنگ رن بک [diegosouzapw/OmniCopilot](https://github.com/diegosouzapw/OmniCopilot) پر لائیو۔
📖 [VS کوڈ Copilot چیٹ گائیڈ](docs/guides/VSCODE-COPILOT.md) — سیٹ اپ، چننے والا کیا دکھاتا ہے، ڈیش بورڈ-ان-اے-ٹیب، کا ازالہ
### 🎩 نیا: OmniRouteTray — آپ کا گیٹ وے، مینو بار میں رہنا
> `omniroute serve` سب سے زیادہ خوش ہوتا ہے جب یہ ہمیشہ آن ہوتا ہے۔** [OmniRouteTray](https://github.com/zoispag/omniroute-tray)** اسے macOS کے لیے سیٹ اور فرامیٹ مینو بار ایپ میں بدل دیتا ہے: یہ سرور کو شروع کرتا ہے، اسے دوبارہ شروع کرنے کے دوران زندہ رکھتا ہے، اسے اپنی جگہ پر اپ ڈیٹ کرتا ہے، اور آپ کے لائیو ٹوکن بجٹ کو ایک کلک کے فاصلے پر رکھتا ہے۔** کوئی ٹرمینل کھڑکی کھلی نہیں چھوڑی، کوئی `npm install -g omniroute` to babysit۔**
[Tauri v2](https://v2.tauri.app/) (ایک راؤنڈنگ ایرر کے سائز کا زنگ کور) کے ساتھ بنایا گیا، یہ اپنا دستخط شدہ نوڈ 24 رن ٹائم بھیجتا ہے اور ایپ کی ملکیت والے OmniRoute انسٹال کا انتظام کرتا ہے، لہذا یہ کبھی بھی آپ کے عالمی `node`/`bun` سے نہیں لڑتا۔ یہ** آپ کے موجودہ `~/.omniroute/` کنفیگریشن اور ڈیٹا بیس کو شیئر کرتا ہے۔** - تو یہ وہی OmniRoute ہے جسے آپ پہلے ہی چلاتے ہیں، صرف ٹوپی کے ساتھ۔ 🎩
یہ کیا کرتا ہے
کیسے
🟢 سرور کی نگرانی کرتا ہے
Spawns omniroute serve ، اسے نقل کرنے کے بجائے پہلے سے چل رہی مثال کو اپناتا ہے
📊 ایک نظر میں براہ راست استعمال
فراہم کنندہ کوٹہ بارز، Claude session/weekly حدیں ری سیٹ الٹی گنتی کے ساتھ، 30 دن کی لاگت کی خرابی
🔄 جگہ پر خودکار اپ ڈیٹس
اسٹیجڈ انسٹال، ایٹمک سویپ، ناکامی پر رول بیک — ہمیشہ تازہ ترین ریلیز
پر
🚀 لاگ ان پر شروع کریں
لاگ ان پر اختیاری لانچ؛ صرف ٹرے، کوئی ڈاک آئیکن
نہیں ہے۔
🩺 ڈاکٹر & لاگز
ایک کلک کی تشخیص اور سرور لاگ رسائی
```sh
brew install --cask zoispag/tap/omniroute-tray
```
ڈاؤن لوڈ کو ترجیح دیتے ہیں؟ تازہ ترین .dmg سے حاصل کریں۔
جاری کرتا ہے۔ ماخذ، مسائل اور تعمیر
دستاویزات zoispag/omniroute-tray پر رہتے ہیں۔
💛 @zoispag کی طرف سے ایک کمیونٹی پروجیکٹ — ایک سرکاری OmniRoute ریلیز نہیں۔
> سرور سے آگے، OmniRoute ایک **مکمل کمانڈ لائن کاک پٹ** ہے جس میں **80+ کمانڈز** موجود ہیں، نیز اوپن ایجنٹ پروٹوکولز بھی ہیں تاکہ کوئی AI ایجنٹ اسے **خود سے** چلا سکے۔
### ⌨️ ایک حقیقی CLI (صرف `start` نہیں)
```bash
omniroute # گیٹ وے + ڈیش بورڈ چلائیں (پورٹ 20128)
omniroute chat # انٹرایکٹو TUI چیٹ کلائنٹ (سلیش: /model /combo /skill /memory)
omniroute setup # پہلی بار چلانے کے لیے رہنمائی والا وزارڈ
omniroute doctor # پرووائیڈرز، پورٹس اور مقامی انحصارات کی تشخیص کریں
```
### 🛰️ ریموٹ موڈ — CLI یہاں چلائیں، OmniRoute کو VPS پر
OmniRoute کسی سرور پر ہے؟ اسے اپنے لیپ ٹاپ سے **اسی CLI** کے ذریعے چلائیں۔ محدود دائرۂ اختیار والے رسائی ٹوکن کے ساتھ ایک بار لاگ اِن کریں؛ اس کے بعد ہر کمانڈ ریموٹ کو ہدف بنائے گی۔
```bash
omniroute connect 192.168.0.15 # پاس ورڈ → محدود دائرۂ اختیار والا ٹوکن، بطور کانٹیکسٹ محفوظ
omniroute models # ← ریموٹ سرور کے خلاف چلتا ہے
omniroute configure codex # ← ریموٹ ماڈل منتخب کرتا ہے، مقامی Codex پروفائل لکھتا ہے
omniroute tokens create --name ci --scope read # دوسری مشینوں کے لیے مزید محدود ٹوکن بنائیں
omniroute contexts use default # ← دوبارہ مقامی سرور پر منتقل ہوں
```
ٹوکنز کے دائرۂ اختیار `read` / `write` / `admin` ہیں؛ پراسیس شروع کرنے والے روٹس صرف لوپ بیک تک محدود رہتے ہیں۔
📖 [ریموٹ موڈ](docs/guides/REMOTE-MODE.md)
### 🤝 کسی ایجنٹ کو منسلک کریں — اور وہ خود OmniRoute کو کنٹرول کرے گا
OmniRoute کو **MCP**، **A2A**، ایک **REST API**، **webhooks** یا **ریموٹ CLI** کے ذریعے دستیاب کریں — کوئی بھی اہل ایجنٹ (یا آپ کا اپنا کوڈ) پورے گیٹ وے کی کنجیاں حاصل کر لیتا ہے: روٹنگ، پرووائیڈرز، کومبوز، کیش، کمپریشن، میموری — خودکار طور پر۔ ذیل کے HTTP اینڈ پوائنٹس `http://localhost:20128` کے تحت فراہم کیے جاتے ہیں۔
انٹرفیس
اینڈ پوائنٹ / کمانڈ
اس کا استعمال
🧰 MCP (stdio)
omniroute --mcp
Claude Desktop، Cursor یا کسی بھی MCP کلائنٹ سے منسلک کریں
OpenAI سے ہم آہنگ — چیٹ، ایمبیڈنگز، تصاویر، آڈیو، OCR
🔔 Webhooks
/api/webhooks
درخواست / کوٹا ایونٹس کو Slack، Discord، Telegram یا کسی بھی URL پر بھیجیں
🛰️ ریموٹ CLI
omniroute connect
محدود دائرۂ اختیار والے رسائی ٹوکنز کے ذریعے ریموٹ انسٹینس چلائیں
```bash
# Claude Code کو MCP کے ذریعے OmniRoute کا مکمل ٹول سیٹ دیں:
claude mcp add-server omniroute --type http --url http://localhost:20128/api/mcp/stream
```
📖 [MCP سرور](docs/frameworks/MCP-SERVER.md) · [A2A سرور](docs/frameworks/A2A-SERVER.md) · [ایجنٹ پروٹوکولز](docs/frameworks/AGENT_PROTOCOLS_GUIDE.md)
## 🗜️ خودکار طور پر 15–95% ٹوکنز محفوظ کریں
### 📖 یہ کیسے کام کرتا ہے — پائپ لائن، آرکیٹیکچر اور بچت کا حساب
Default stacked combo runs `RTK → Caveman`. جب دونوں ایک ہی tool/context payload پر عمل کرتے ہیں تو بچت باہم مرکب ہو جاتی ہے:
```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 اور structured data کو preservation engine کے ذریعے **ہمیشہ محفوظ** رکھا جاتا ہے۔
> **جب کم ٹوکنز سے کام چل سکتا ہے تو زیادہ ٹوکنز کیوں استعمال کریں؟** ہر درخواست OmniRoute کی compression pipeline سے **شفاف طور پر** گزرتی ہے — client میں کسی تبدیلی کے بغیر۔ اب یہ **12 composable engines کا stack** ہے جو ترتیب سے چلتے ہیں اور ہر routing combo کے مطابق باہم ملائے جا سکتے ہیں — [RTK](https://github.com/rtk-ai/rtk)، [Caveman](https://github.com/JuliusBrussee/caveman) (⭐ 90K+)، [LLMLingua-2](https://github.com/microsoft/LLMLingua) اور [Troglodita](https://github.com/leninejunior/troglodita) (PT-BR) کے خیالات کی بنیاد پر۔
### 🧱 12-engine stack
Engines پائپ لائن کی ترتیب سے چلتے ہیں؛ ہر engine کو الگ سے toggle کیا جا سکتا ہے اور ہر combo کے مطابق configure کیا جا سکتا ہے:
#
Engine
یہ کیا کرتا ہے
1
Session-Dedup
Turns کے دوران دہرائے گئے content کو ہٹا دیتا ہے (content-addressed، cross-turn)
2
CCR
بڑے blocks کو retrieve markers کے پیچھے archive کرتا ہے، جو ضرورت کے وقت fetch کیے جاتے ہیں
3
Lite
Whitespace اور image-URL trimming (latency-light baseline)
4
RTK
Smart tool-result filtering، dedup اور truncation (command-aware)
5
Responses Tool Output
Shell/patch/search/build outputs کے لیے lossless-first JSON اور محدود diagnostic compression (Responses API)
6
Headroom
Vendored GCF codec کے ذریعے JSON arrays کی lossless tabular compaction (~30%)
7
Relevance
آخری user query کے مقابل extractive sentence scoring
8
Caveman
Rule-based prose compression (output پر ~65–75%)
9
Aggressive
Summarization اور پرانے turns کی progressive aging
10
LLMLingua-2
MobileBERT ONNX کے ذریعے ML semantic pruning — code-safe، async
11
Ultra
اختیاری small-model (SLM) tier کے ساتھ heuristic token pruning
12
OmniGlyph
direct Anthropic wire پر measured Claude Fable 5 کے لیے experimental context-as-image encoding؛ GPT 5.6 transformers provider receipts موصول ہونے تک fail-closed رہتے ہیں۔ چار compression profiles (aggressive default، balanced، coding-safe، passthrough) (سب سے زیادہ aggressive؛ opt-in)
Code blocks، URLs اور structured data کو **ہمیشہ byte-perfect محفوظ** رکھا جاتا ہے۔ **One-click presets** engines کو یکجا کرتے ہیں:
Mode
بچت
بہترین استعمال
🪶 Lite
~15%
ہمیشہ فعال محفوظ default
🪨 Standard (Caveman)
~30%
روزمرہ coding
⚡ Aggressive
~50%
طویل، tools پر مبنی sessions
🔥 Ultra
~75%
زیادہ سے زیادہ بچت
🧰 RTK
60–90%
Shell/test/build/git output
🔗 Stacked (RTK → Caveman)
78–95%
ملے جلے prompts اور tool logs
**حقیقی مثال — Standard mode:**
> **پہلے (69 tokens):** _"آپ کا React component غالباً اس لیے دوبارہ render ہو رہا ہے کیونکہ آپ ہر render cycle پر ایک نیا object reference بنا رہے ہیں۔ جب آپ کسی inline object کو prop کے طور پر pass کرتے ہیں تو React کی shallow comparison اسے ہر بار ایک مختلف object سمجھتی ہے، جس سے re-render trigger ہوتا ہے۔ میرا مشورہ ہے کہ object کو memoize کرنے کے لیے useMemo استعمال کریں۔"_
>
> **بعد میں (19 tokens):** _"ہر render پر نیا object ref۔ Inline object prop = نیا ref = re-render۔ اسے useMemo میں wrap کریں۔"_
>
> **وہی جواب۔ 72% کم ٹوکنز۔ درستگی میں کوئی کمی نہیں۔** ✅
**PT-BR مثال — [Troglodita](https://github.com/leninejunior/troglodita) mode:**
> **پہلے (42 ٹوکن):** _"مسئلہ یہ ہے کہ جزو دوبارہ رینڈر ہو رہا ہے کیونکہ ہر رینڈرنگ سائیکل میں آبجیکٹ کا نیا ریفرنس بنایا جا رہا ہے۔ میں `useMemo` استعمال کرنے کی تجویز دوں گا۔"_
>
> **بعد میں (12 ٹوکن):** _"دوبارہ رینڈر: ہر سائیکل میں نیا ریفرنس (inline آبجیکٹ دوبارہ بنایا گیا)۔ `useMemo` استعمال کریں۔"_
>
> **وہی جواب۔ تقریباً 70% کم ٹوکن۔ تکنیکی درستگی برقرار۔** ✅
### 🎚️ انجنز سے آگے — آؤٹ پٹ اسٹائلز، adaptive dial اور فی درخواست کنٹرول
اوپر دیے گئے 12 انجنز **ان پٹ** کو مختصر کرتے ہیں۔ مزید تین پرتیں اس بات کی تشکیل کرتی ہیں کہ **کیسے**، **کب**، اور کیا **آؤٹ پٹ** میں آئے:
- **🪄 آؤٹ پٹ اسٹائلز** _(آؤٹ پٹ محور کی سمت بندی)_ — متعین، cache-safe جوابی تشکیل کی ہدایات شامل کرتے ہیں؛ انہیں باہم ملایا جا سکتا ہے، اور ہر ایک `lite` / `full` / `ultra` شدت میں دستیاب ہے۔ اسٹائل شامل کرنا رجسٹری میں ایک سطر کا اندراج ہے:
- **مختصر نثر** — غیر ضروری الفاظ / حروفِ تعریف / غیر یقینی لہجہ ختم کریں؛ تکنیکی مفہوم کو بالکل درست رکھیں۔
- **کم کوڈ** — "سست سینئر ڈویلپر" YAGNI: سب سے چھوٹی کام کرنے والی تبدیلی، غیر مطلوبہ scaffolding کے بغیر۔
- **پونی ٹیل (سست سینئر ڈویلپر)** — YAGNI کی سیڑھی پر چڑھیں، بنیادی وجہ درست کریں، سب سے چھوٹا قابلِ عمل diff رکھیں۔
- **مجھے ADHD ہے (عمل پہلے)** — اگلا عمل پہلے آئے، مراحل نمبر وار ہوں، ایک ٹھوس اگلا قدم ہو، کوئی تمہید نہ ہو۔
- **مختصر CJK (文言)** — کلاسیکی چینی کا انتہائی مختصر انداز (`zh` تک محدود)۔
- **🎯 Adaptive context-budget** _(ڈائل)_ — ایک ہی on/off ٹوکن حد کے بجائے، سب سے سستے اور کم سے کم نقصان والے انجنز کو صرف اتنی حد تک فعال کریں جتنی ضرورت ہو تاکہ **ماڈل کی context window میں گنجائش ہو**۔ پالیسی: `reserve-output` (پہلے سے طے شدہ، ماڈل سے آگاہ) · `percentage` · `absolute`۔ موڈ: `floor` (گنجائش کی ضمانت) · `replace-autotrigger` (آپ کی واضح ترجیح غالب ہو) · `off` (پرانا threshold)۔
- **🎛️ کمپریشن کہاں طے ہوتی ہے** _(ترجیح، زیادہ → کم)_ — فی درخواست `x-omniroute-compression` header › routing-combo override › فعال نامزد profile › adaptive / auto-trigger › panel default › off۔ نافذ شدہ منصوبہ `X-OmniRoute-Compression: ; source=` response header میں واپس شامل ہوتا ہے۔
ٹوکن threshold کے ذریعے auto-trigger کریں، adaptive dial فعال کریں، نامزد profile کو pin کریں، فی درخواست ایک وقتی ترتیب مقرر کریں، یا ہر routing combo کے لیے pipeline تفویض کریں — جو workload کے لیے موزوں ہو۔ اختیاری offline **eval harness** (`npm run eval:compression`) تبدیلی کو promote کرنے سے پہلے pinned corpus پر fidelity بمقابلہ savings اسکور کرتا ہے۔
📖 [`COMPRESSION_GUIDE.md`](docs/compression/COMPRESSION_GUIDE.md) · [`RTK_COMPRESSION.md`](docs/compression/RTK_COMPRESSION.md) · [`COMPRESSION_ENGINES.md`](docs/compression/COMPRESSION_ENGINES.md)
# ⚡ فوری آغاز
**1) انسٹال کریں اور چلائیں**
```bash
npm install -g omniroute
omniroute
```
> 💡 `npm warn ERESOLVE` یا peer-dep warnings نظر آ رہی ہیں؟ [یہ بے ضرر ہیں](docs/guides/TROUBLESHOOTING.md#npm-install-warnings-eresolve--peer--deprecated)۔
> **npm 11 یا بعد کا ورژن استعمال کر رہے ہیں؟** npm package lifecycle scripts کو روک سکتا ہے، جب تک انہیں اجازت نہ دی جائے۔ OmniRoute کا `postinstall` (`node scripts/build/postinstall.mjs`) اس کی native runtime files تیار کرنے کے لیے ضروری ہے۔ globally انسٹال کرتے وقت npm کی warning میں نام زد packages کو اجازت دیں۔ OmniRoute 3.8.54 کی جانب سے رپورٹ کردہ package set کے لیے:
>
> ```bash
> npm install -g --allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild omniroute
> ```
>
> مستقبل کی global installs کے لیے اس allowlist کو دوبارہ استعمال کرنے کی خاطر اسے ایک بار configure کریں، پھر معمول کے مطابق انسٹال کریں:
>
> ```bash
> npm config set allow-scripts=omniroute,keytar,onnxruntime-node,@parcel/watcher,@swc/core,protobufjs,esbuild --location=user
> npm install -g omniroute
> ```
>
> dependency list releases کے درمیان تبدیل ہو سکتی ہے؛ اگر npm مختلف list رپورٹ کرے تو اس warning میں موجود package names استعمال کریں۔ کسی package کو اجازت دینے سے اس کے install scripts چلنے کی اجازت ملتی ہے۔
> **Gemini Web یا کوئی اور web-cookie provider استعمال کر رہے ہیں؟** npm package میں
> Playwright شامل ہے، لیکن اس کی Chromium binary شامل نہیں۔ پہلی web-provider request کرنے سے پہلے
> [Playwright Chromium setup](docs/guides/TROUBLESHOOTING.md#gemini-web-and-playwright-chromium)
> نوٹ دیکھیں۔
Dashboard `http://localhost:20128` پر · API `http://localhost:20128/v1` پر۔
**2) اپنے اکاؤنٹ کے ذریعے اہل provider سے منسلک ہوں**
Dashboard → **Providers** → ایسا provider منتخب کریں جس کی موجودہ شرائط اور quota آپ کے استعمال کے معاملے سے مطابقت رکھتے ہوں → اس کی API key شامل کریں یا اکاؤنٹ کا flow مکمل کریں۔ مفت tiers کے لیے signup، approval، یا payment method درکار ہو سکتا ہے۔ [Free Tiers Guide](docs/getting-started/FREE-TIERS-GUIDE.md) دیکھیں؛ keyless availability کی ضمانت نہیں، اور `tos: avoid` سے نشان زد providers کو default طور پر `auto` سے خارج رکھا جاتا ہے۔
**3) اپنے coding tool کو نشانہ بنائیں**
```txt
Base URL: http://localhost:20128/v1
API Key: [copy from Dashboard → Endpoints]
Model: auto (routes among eligible connections — or choose provider/model)
```
**4) تصدیق کریں کہ یہ کام کر رہا ہے**
```bash
curl http://localhost:20128/v1/models -H "Authorization: Bearer YOUR_KEY"
```
آپ کو اپنے منسلک models کی فہرست نظر آنی چاہیے۔ 🎉 بس اتنا ہی — coding شروع کریں، اور OmniRoute آپ کے لیے خودکار routing اور fallback کرے گا۔
اگر آپ کا client custom headers نہیں بھیج سکتا تو OmniRoute 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
```
انہیں صرف ان clients کے لیے استعمال کریں جو `Authorization: Bearer ...` شامل نہیں کر سکتے۔ Header auth اب بھی ترجیحی موڈ ہے۔
## 📦 تنصیب کے مزید طریقے — Docker، سورس، 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` سب سے اعلیٰ **شائع شدہ** مستحکم SemVer کی پیروی کرتا ہے۔ یہ git `main` کو ٹریک نہیں کرتا۔ GitOps کے لیے `:X.Y.Z` مقرر کریں۔ [Docker ریلیز چینلز](docs/guides/DOCKER_GUIDE.md#release-channels) دیکھیں۔ امیج میں **`OMNIROUTE_MEMORY_MB=1024`** مقرر ہے۔ یہ ڈیش بورڈ اور ہلکی چیٹ کے لیے کافی ہے۔ **کوڈنگ ایجنٹس** (Claude Code، Codex، Grok، … سے `POST /v1/responses`) کو کہیں زیادہ بڑا V8 heap درکار ہوتا ہے، ورنہ دو باہم متجاوز طویل contexts کے دوران تقریباً 12 GiB پر پراسیس `FATAL ERROR` دیتا ہے۔ کنٹینر کا سائز heap سے زیادہ رکھیں (native buffers، V8 سے باہر موجود ہوتے ہیں):
| کام کا بوجھ | Heap (`-e OMNIROUTE_MEMORY_MB`) | کنٹینر (`--memory`) |
| ------------------------------- | ------------------------------- | ------------------- |
| ڈیش بورڈ / ہلکی چیٹ | `1024` (امیج کا ڈیفالٹ) | ≥2 g |
| ایک کوڈنگ ایجنٹ | `8192` | ≥10 g |
| بیک وقت دو طویل `/v1/responses` | `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
```
مکمل جدول: [Docker گائیڈ — رن ٹائم RAM](docs/guides/DOCKER_GUIDE.md#runtime-ram-for-coding-agents)۔
> **قبل از ریلیز Docker چینل:** `diegosouzapw/omniroute:next` اور
> `diegosouzapw/omniroute:next-web` موجودہ ڈیفالٹ `release/v*`
> برانچ کی پیروی کرتے ہیں۔ یہ قابلِ تغیر tags صرف غیر جاری شدہ اصلاحات کی جانچ کے لیے ہیں اور
> **پروڈکشن کے لیے معاونت یافتہ نہیں ہیں**۔ دیکھیں
> [Docker ریلیز چینلز](docs/guides/DOCKER_GUIDE.md#release-channels)۔
**🥟 Bun**
Bun رن ٹائم کی شناخت کے ذریعے معیاری `bun install` اور عالمی تنصیب (`bun install -g omniroute`) معاونت یافتہ ہیں:
- **بلٹ اِن `bun:sqlite`**: Bun کے تحت چلتے وقت OmniRoute، Bun کا بلٹ اِن `bun:sqlite` ڈرائیور استعمال کرتا ہے، جبکہ Node.js پر `better-sqlite3` یا `sql.js` استعمال کرتا ہے۔
- **ڈویلپمنٹ میں خودکار Webpack bundler انتخاب**: ڈویلپمنٹ (`bun run dev`) خودکار طور پر Bun کی شناخت کرتی ہے اور native V8 binding کی عدم مطابقت روکنے کے لیے Turbopack کو غیر فعال کرکے Webpack استعمال کرتی ہے۔ پروڈکشن builds (`bun run build`) عین Node کی طرح `OMNIROUTE_USE_TURBOPACK` کی پیروی کرتی ہیں: ڈیفالٹ طور پر Turbopack، اور Webpack کے ساتھ build کرنے کے لیے `OMNIROUTE_USE_TURBOPACK=0` (`Dockerfile.bun` اسے `--build-arg` کے طور پر فراہم کرتا ہے)۔
- **Bun کے لیے مخصوص Dockerfile**: مقامی Bun پروڈکشن deployments کے لیے multi-stage `Dockerfile.bun` (`docker build -f Dockerfile.bun -t omniroute:bun .`)۔
```bash
# Bun کے ساتھ تنصیب کریں اور چلائیں
bun install
bun run dev
```
**🛠️ سورس سے**
```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
# Nix flakes استعمال کرتے ہوئے
nix develop
npm run dev
# یا devbox استعمال کرتے ہوئے
devbox run npm run dev
```
📖 [Docker گائیڈ](docs/guides/DOCKER_GUIDE.md) — Compose profiles، Caddy HTTPS، Cloudflare tunnels۔
**🦭 Podman**
```bash
# 1. bind-mounted ڈیٹا ڈائریکٹری تیار کریں
mkdir -p data
# 2. صرف Linux + مقامی rootless Podman (کبھی بھی remote Podman Machine client نہیں):
podman unshare chown 1000:1000 ./data
# 3. رن ٹائم hint مقرر کریں، مقامی Compose امیج build کریں، اور آغاز کریں
echo "CONTAINER_HOST=podman" >> .env
podman compose --profile base up -d --build
```
macOS یا Windows پر، Podman ایک remote Podman Machine استعمال کرتا ہے: `podman unshare` کو چھوڑ دیں اور
[topology کے لحاظ سے مخصوص ڈیٹا ڈائریکٹری کی رہنمائی](contrib/podman/README.md#data-directory-permissions-by-topology) پر عمل کریں۔
📖 [Podman گائیڈ](contrib/podman/README.md) — Compose builds، Podman Machine، اور
Linux/systemd Quadlet سیٹ اپ۔
**⚡ تیز تر / ہلکی تنصیب (native build کو چھوڑ دیں)**
native SQLite انجن (`better-sqlite3`) ایک **اختیاری** dependency ہے، اس لیے عالمی
تنصیب کبھی بھی سورس سے compilation پر نہیں رکتی: جب کوئی prebuilt binary آپ کے
پلیٹ فارم/Node سے مطابقت رکھتی ہو تو اسے استعمال کیا جاتا ہے، بصورتِ دیگر شفاف انداز میں pure-JS انجن
(Node 22+ پر `node:sqlite`، ورنہ شامل کردہ `sql.js` WASM) استعمال کیا جاتا ہے — کسی build tool کی ضرورت نہیں۔
تنصیب کے بعد کی native warm-up کارروائی کو مکمل طور پر چھوڑنے کے لیے (CI، headless، یا سست مشینیں):
```bash
OMNIROUTE_SKIP_POSTINSTALL=1 npm install -g omniroute # CI=1 بھی اسے چھوڑ دیتا ہے
```
تیز ترین تنصیبات کے لیے **pnpm** کو ترجیح دیں (content-addressed store + hard links — اوپر دیکھیں)۔
ڈیش بورڈ کے بغیر headless رن ٹائم کے لیے Docker کا `base` profile (اوپر) یا
[Termux گائیڈ](docs/guides/TERMUX_GUIDE.md) استعمال کریں۔ CLI اور ویب ڈیش بورڈ ایک ہی پراسیس کے ذریعے ایک
پورٹ پر پیش کیے جاتے ہیں، اس لیے فی الحال کوئی الگ صرف-CLI package موجود نہیں ہے۔
**مکمل درجہ بندی (نقل سے پاک کینونیکل URLs، `v > 0`، سب سے زیادہ رسائی):**
| #1 | #2 | #3 | #4 | #5 |
| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [nick_saraev — Instagram](https://www.instagram.com/reel/Da8ZthUPK98/) — **3,042,474** | [nnapier7 — Instagram](https://www.instagram.com/reel/Dbp7wv_CIO0/) — **1,454,535** | [Amidia AI & Tech — YouTube](https://www.youtube.com/watch?v=NJ0TQ-pyMDY) — **794,974** | [theopenstack — Instagram](https://www.instagram.com/reel/DaSs65mMrHk/) — **692,419** | [migue.baena — TikTok](https://www.tiktok.com/@migue.baena/video/7670919268216622358) — **685,788** |
| #6 | #7 | #8 | #9 | #10 |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| [milesreevesai — TikTok](https://www.tiktok.com/@milesreevesai/video/7667980059189366019) — **620,400** | [nikothetech — TikTok](https://www.tiktok.com/@nikothetech/video/7671890769665477918) — **610,803** | [Vaibhav Sisinty — YouTube](https://www.youtube.com/watch?v=QucgvbO5gsM) — **509,281** | [buildwithai.club — Instagram](https://www.instagram.com/reel/DbIt9AjK7-U/) — **347,652** | [nivedan.ai — Instagram](https://www.instagram.com/reel/DbIrCksJiqq/) — **331,973** |
2026-10-18 کو کینونیکل میٹرکس: **1.976 منفرد ویڈیوز** · **20.220.289 معلوم ملاحظات** (`v > 0`) · **ہر نیٹ ورک پر 1.210 چینلز/پروفائلز**۔ خام پینل میں 1.976 قطاریں شامل ہیں (YouTube 1.352 = 740 طویل ویڈیوز + 612 Shorts · TikTok 334 · Instagram 290)؛ کینونیکل URL کے ذریعے نارملائزیشن کے بعد کوئی نقل باقی نہیں رہی، جو ہر ویڈیو کے لیے سب سے زیادہ تعداد برقرار رکھتی ہے۔ YouTube کا ڈیٹا اکٹھا کرنے کا عمل 2026-10-13 سے منجمد ہے (14 سے 18/10 تک API کوٹا ختم ہو گیا تھا)، جبکہ TikTok/Instagram کا 2026-09-02 سے (ڈیٹا اکٹھا کرنے کے کریڈٹس دستیاب نہ ہونے کی وجہ سے)؛ 76 ویڈیوز کے ملاحظات کی تعداد اب بھی دستیاب نہیں ہے۔
> 🎬 **OmniRoute کے بارے میں ویڈیو بنائی ہے؟** لنک کے ساتھ ایک [مسئلہ](https://github.com/diegosouzapw/OmniRoute/issues/new) یا [گفتگو](https://github.com/diegosouzapw/OmniRoute/discussions) شروع کریں — ہم اسے یہاں نمایاں کریں گے۔
# 📧 کمیونٹی اور مدد
> سب کچھ ایک ہی جگہ پر — مینٹینر کو فالو کریں، کمیونٹی کے ساتھ چیٹ کریں، یا کوئی مسئلہ کھولیں۔
| چینل | کہاں / کیسے |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| 💼 **LinkedIn** — مینٹینر کو فالو کریں | [linkedin.com/in/diegosouzapw](https://www.linkedin.com/in/diegosouzapw/) |
| 🐙 **GitHub** — ریلیزز اور تجاویز کے لیے فالو کریں | [@diegosouzapw](https://github.com/diegosouzapw) |
| 💬 **Discord** | [discord.gg/U47eFqAXCn](https://discord.gg/U47eFqAXCn) |
| ✈️ **Telegram** | [t.me/omnirouteOficial](https://t.me/omnirouteOficial) |
| 🟢 **WhatsApp — 🌍 عالمی** | [گروپ میں شامل ہوں](https://chat.whatsapp.com/FvuCbrpZmQ6I85n2vW5QIC?s=cl&p=a&mlu=4) |
| 🟢 **WhatsApp — 🇧🇷 برازیل** | [گروپ میں شامل ہوں](https://chat.whatsapp.com/KWgatljAjmbELQory59Oti?s=cl&p=a&mlu=4) |
| 🌍 **ویب سائٹ** | [omniroute.online](https://omniroute.online) |
| 🌍 **🌍StHub OmniRoute کمیونٹی (مفت)** | [StHub پورٹل](https://portal.sthub.com.br/communities/groups/st-hub/channels/Omniroute-World-8kRjmK) |
| 📦 **سورس کوڈ** | [github.com/diegosouzapw/OmniRoute](https://github.com/diegosouzapw/OmniRoute) |
| 🐛 **بگ رپورٹ کریں** | [ایک مسئلہ درج کریں](https://github.com/diegosouzapw/OmniRoute/issues) — `npm run system-info` کا آؤٹ پٹ منسلک کریں |
| 🤝 **تعاون کریں** | [CONTRIBUTING.md](CONTRIBUTING.md) · [برانچنگ اور ریلیز ماڈل](docs/ops/BRANCHING_MODEL.md) · ایک `good first issue` منتخب کریں |
| 💚 **پروجیکٹ کی معاونت کریں** | [معاونت کے طریقے ↑](#-support-omniroute) · [GitHub Sponsors](https://github.com/sponsors/diegosouzapw) |
8,400 سے زائد ٹریک شدہ ٹیسٹ فائلوں میں 60,000 سے زائد جامد ٹیسٹ اعلانات کے لیے ٹیسٹ کوریج کی حکمتِ عملی
# ⭐ نمایاں معاونین
> OmniRoute ایک پُرجوش اوپن سورس کمیونٹی کی کاوش ہے۔ ان افراد نے غیر معمولی شراکتیں کی ہیں جو براہِ راست پروجیکٹ کے معیار، استحکام اور رسائی پر اثر انداز ہوتی ہیں۔ **شکریہ۔**
### ضم شدہ پل ریکوئسٹس کے لحاظ سے بیرونی معاونین
شمارش 2026-11-03 03:01:19 UTC کو براہِ راست release/v3.8.53 ٹِپ 05bc048d6c کے ساتھ کی گئی۔ صفحات میں تقسیم شدہ GitHub GraphQL شمارش میں 9,947 ضم شدہ PRs شامل ہیں: 4,130 ریپوزٹری کے مالک کی جانب سے، 240 Dependabot کی جانب سے، 6 دیگر بوٹس/ایپس کی جانب سے، اور 883 منفرد معاونین کی جانب سے 5,571 بیرونی PRs۔ “تبدیل شدہ لائنیں” GitHub کی جانب سے شامل کی گئی + حذف کی گئی لائنیں ہیں اور ان میں جنریٹ شدہ فائلیں، لاک فائلیں، کیٹلاگز، تراجم اور دستاویزات شامل ہیں؛ یہ تبدیلیوں کا حجم ہے، تحریر کردہ LOC نہیں۔ 53 PRs میں GitHub کے ڈِفس 500,000 لائنوں سے زیادہ رپورٹ ہوئے ہیں (مثلاً #13399، جو ایک واحد پرووائیڈر کا اضافہ ہے، 2,347 تبدیل شدہ فائلیں دکھاتا ہے)، جس سے اوپر دیے گئے کئی مجموعے بڑھ جاتے ہیں۔ برابر اسکور والے ایک ہی درجہ پر رکھے گئے ہیں۔
### GitHub سے منسوب کمٹس
آخری بار 2026-11-03 02:09:16 UTC پر دوبارہ جانچا گیا: GitHub سے منسوب کمٹس، Contributors API کے ذریعے ریپوزٹری کی release/v3.8.53 ڈیفالٹ برانچ کے لیے رپورٹ کیے گئے ہیں۔ API نے 903 شناختیں واپس کیں (429 صارفین، 2 بوٹس، 472 گمنام)؛ اس جدول میں مینٹینر، بوٹس اور گمنام شناختیں شامل نہیں ہیں، جبکہ مقابلے میں برابر نمبروں کو برقرار رکھا گیا ہے۔ یہ اوپر دی گئی merged-PR درجہ بندی اور نیچے دی گئی Git-metadata مردم شماری، دونوں سے الگ ہے۔
> 🙏 ان معاونین کی خصوصیات، بگ فکسز اور بنیادی ڈھانچے میں بہتریاں اس بات کا **مرکزی حصہ** ہیں کہ OmniRoute کو قابلِ اعتماد اور خصوصیات سے بھرپور کیا بناتا ہے۔ ہر پل ریکویسٹ، ہر ٹیسٹ کیس اور ہر i18n ترجمہ فائل اہم ہے۔ اوپن سورس انہی جیسے لوگوں کے ذریعے تشکیل پاتا ہے۔
---
## 💖 اسپانسرز
ان لوگوں کا تہِ دل سے شکریہ جو اپنی جیب سے OmniRoute کی مالی معاونت کرتے ہیں — ہر تعاون اس منصوبے کو مفت، خودمختار اور رواں دواں رکھتا ہے۔
… اور وہ دیگر افراد جو اپنی شناخت نجی رکھنا پسند کرتے ہیں 💛عوامی GitHub Sponsors کی 2026-10-18 کو GitHub Sponsors GraphQL API کے ذریعے دوبارہ توثیق کی گئی: کل 14 میں سے 11 عوامی اسپانسرشپس (6 فعال، 5 سابقہ)۔ GitHub کی isActive حیثیت اوپر دیے گئے فعال لیبلز کا تعین کرتی ہے؛ سابقہ عوامی یک وقتی معاونین کا شکریہ بدستور ادا کیا جاتا ہے، جبکہ نجی اسپانسرز گمنام رہتے ہیں۔ Ko-fi، Buy Me a Coffee، Liberapay، PIX اور کرپٹو عطیات درج نہیں کیے گئے کیونکہ ان کا کوئی عوامی اسپانسر ریکارڈ موجود نہیں ہے۔💖 اسپانسر بنیں → — ہر ڈالر OmniRoute کو مفت اور خودمختار رکھتا ہے۔
## 👥 1,000+ معاونین
[](https://github.com/diegosouzapw/OmniRoute/graphs/contributors)
2026-11-02 کو live release/v3.8.53 tip 1c7135e0fb (7,972 commits) پر آڈٹ کیا گیا: 1,074 معمول پر لائی گئی انسانی Git شناختیں — 759 commit مصنفین کے طور پر ظاہر ہوتے ہیں (maintainer سمیت) اور 315 صرف واضح Co-authored-by trailers میں موجود ہیں۔ اس مردم شماری میں .mailmap لاگو کیا گیا ہے، ای میل پتوں کا موازنہ case-insensitive انداز میں کیا گیا ہے، عددی اور سادہ GitHub noreply پتوں کو صرف اسی وقت ملایا گیا ہے جب وہ ایک ہی handle کو encode کرتے ہوں، 29 bot/agent/service/placeholder شناختوں کو خارج کیا گیا ہے، اور صرف display names کے مماثل ہونے کی بنیاد پر عام ای میل پتوں کو ضم نہیں کیا گیا۔ 2026-08-24 کے آڈٹ میں 639 شائع کیے گئے تھے؛ اس آڈٹ کے base ac02c5b42f پر اسی طریقے کو دوبارہ چلانے سے 619 حاصل ہوتے ہیں، لہٰذا اضافہ نئے معاونین کی وجہ سے ہے، نہ کہ زیادہ نرم طریقے کی وجہ سے۔
### تعاون کیسے کریں
1. repository کو fork کریں
2. **فعال** `release/vX.Y.Z` tip سے branch بنائیں (`main` سے نہیں) — [Branching & Release Model](docs/ops/BRANCHING_MODEL.md) دیکھیں
3. اپنی feature branch بنائیں (`git checkout -b feat/amazing-feature`)
4. اپنی تبدیلیاں commit کریں (`git commit -m 'feat: add amazing feature'`)
5. branch پر push کریں (`git push origin feat/amazing-feature`)
6. **base = اس `release/vX.Y.Z` branch** کے ساتھ Pull Request کھولیں
تفصیلی رہنما اصولوں کے لیے [CONTRIBUTING.md](CONTRIBUTING.md) دیکھیں۔
### نیا ورژن جاری کرنا
```bash
# ریلیز بنائیں — npm publish خودکار طور پر ہو جاتا ہے
VERSION=x.y.z
gh release create "v${VERSION}" --title "v${VERSION}" --generate-notes
```
## 📊 ستارے
## 🌍 StarMapper
## 🙏 اعترافات
OmniRoute عظیم منصوبوں کے کندھوں پر کھڑا ہے۔ اس کا آغاز **[9router](https://github.com/decolua/9router)** کے فورک اور Go منصوبے **[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)** کے TypeScript پورٹ کے طور پر ہوا — اور یہاں سے آگے، ذیل کا ہر ذیلی نظام کسی ایسے اوپن سورس منصوبے سے متاثر ہے جو اس سے پہلے اس مقام تک پہنچ چکا تھا۔ ان میں سے ہر ایک نے OmniRoute کے ایک ٹھوس حصے کو تشکیل دیا۔ یہ ہم سب کی جانب سے ان کے لیے شکریہ ہے۔ 🙏
> ⭐ ستاروں کی تعداد 3 نومبر 2026 کو GitHub's REST API سے تصدیق شدہ ہے — جائیے، ان منصوبوں کو ستارہ دیجیے۔ تعداد ایک مخصوص تاریخ کا درست snapshot ہے اور قدرتی طور پر تبدیل ہوتی رہے گی۔
### 🧬 نسب اور گیٹ وے
وہ AI gateway جس کا public pricing dataset ہماری cost-tracking sync کو feed کرتا ہے، اور جس کے provider-normalization model نے ہماری routing کو متاثر کیا۔
MIT source کو vendored ChatGPT Web → Codex Responses bridge میں اپنایا گیا، جس میں browser-session، response-framing، usage اور web-search adapters شامل ہیں۔
اس کے patterns کو stream recovery، no-thinking aliases، fallback web search، sliding-window limits، log redaction اور hardened launcher flows میں port کیا گیا۔
اس کی Grok model mappings، fake-TypeError Statsig generator، request اور device defaults، اور NDJSON response processor کو OmniRoute کے Grok Web executor میں نمایاں طور پر اپنایا گیا۔
grok2api-merged کے پیچھے بنیادی transitive code source؛ اس کی model، header، payload، Statsig اور processor implementations کو Grok Web lineage میں محفوظ رکھا گیا ہے۔
Grok payload اور device defaults، Statsig generator، اور result.response processor کے لیے بنیادی MIT source، جو TQZHR اور grok2api-merged کے ذریعے آگے منتقل ہوا۔
grok2api-merged کی جانب سے اس کے proxy-pool layer کے لیے ایک transitive source کے طور پر تسلیم شدہ؛ OmniRoute اس lineage notice کو محفوظ رکھتا ہے، لیکن اپنے bounded Grok Web executor میں proxy-pool port کا دعویٰ نہیں کرتا۔
اس کے HTTP/browser upstream design سے اصل Grok Web implementation کے لیے رجوع کیا گیا؛ اس کا direct HTTP path GrokProxy سے ماخوذ ہے، اس لیے کسی independent code port کا دعویٰ نہیں کیا گیا۔
### 🗜️ سیاق و سباق اور token compression — engines
وائرل "جب چند ٹوکن سے کام چل جائے تو بہت سے ٹوکن کیوں استعمال کریں" پروجیکٹ — اس کا غار کے انسان جیسا بولنے کا فلسفہ ہمارے معیاری کمپریشن موڈ اور 30+ غیر ضروری الفاظ/اختصار کے قواعد کی بنیاد ہے۔
کمانڈ کے آؤٹ پٹ کی اعلیٰ کارکردگی والی کمپریشن — اس نے ہمارے RTK انجن، JSON فلٹر DSL، خام آؤٹ پٹ کی بحالی اور تہہ در تہہ RTK → Caveman پائپ لائن کو متاثر کیا۔
وائرل "سست سینئر ڈویلپر" YAGNI-coder اسکل — اس نے ہمارے less-code Output Style کو متاثر کیا: کم سے کم کام کرنے والی تبدیلی کی رہنمائی، جو _پیدا کردہ_ کوڈ کو کم کرتی ہے (یہ Caveman کی مختصر نثر کے مقابلے میں آؤٹ پٹ محور پر اس کا ہم رتبہ ہے)۔
مواد سے آگاہ، فی فائل-قسم آؤٹ پٹ کمپریشن، جس میں ناکامی سے آگاہ bail-out شامل ہے — اس نے ہماری فی-قسم dispatch اور کم از کم فائدے پر skip کو درست ثابت کیا۔
Rust columnar-JSON + content-addressed retrieve + cross-message dedup — اس نے ہمارے headroom/ccr/session-dedup انجن ڈیزائن اور کیش-مستحکم invariant کو درست ثابت کیا کہ "compressed form پوزیشن سے آزاد ہے"۔
coding-assistant ↔ LLM ٹریفک کی MITM مداخلت/تجزیے نے ابتدائی Traffic Inspector کی ضروریات سے آگاہ کیا۔ پہلے اخذ کیے گئے چار ماڈیولز — SSE merging، conversation normalization، secret masking اور header sanitization — کو عوامی پروٹوکول معیارات کی بنیاد پر آزادانہ clean-room implementations سے تبدیل کر دیا گیا ہے۔ دو host-passthrough surfaces (passthrough.ts اور _internal/bypass.cjs) OmniRoute کی اندرونی implementations کے طور پر برقرار ہیں اور آزادانہ طور پر درجہ بند ہیں؛ اس تبدیلی کے حصے کے طور پر انہیں دوبارہ نہیں لکھا گیا۔
فی process شفاف پراکسی routing — اس نے ہمارے crash-safe MITM teardown، socket idle-timeouts، /proc process attribution اور TPROXY capture کو متاثر کیا۔
secure-by-default libraries کی مرتب کردہ فہرست جو ہمارے security choices (Helmet.js، DOMPurify، ssrf-req-filter، safe-regex، Google Tink) کی رہنمائی کرتی ہے۔
Grok Build quota surface کی نشان دہی کی؛ اس کے بعد OmniRoute نے live wire format کی آزادانہ طور پر تصدیق اور اصلاح کی۔
## 📄 لائسنس
MIT لائسنس - تفصیلات کے لیے [LICENSE](LICENSE) دیکھیں۔
---
**[⬆ اوپر واپس جائیں](#-omniroute)** · اوپن سورس AI کمیونٹی کے لیے ❤️ سے تیار کیا گیا۔
Diego Souza کی جانب سے تیار کردہ · OmniRoute v3.8.54 · Node ≥22.22.2 · MIT لائسنس · omniroute.online
> live `/dashboard/free-tiers` صفحے کا متحرک خلاصہ۔ مکمل طریقۂ کار (pool dedupe، credit tiers، provider terms): **[docs/reference/FREE_TIERS.md](docs/reference/FREE_TIERS.md)**۔
>
> ان اعداد و شمار کا ہر دو ہفتے بعد live catalog کے مقابلے میں دوبارہ جائزہ لیا جاتا ہے اور یہ **دونوں سمتوں میں تبدیل ہوتے ہیں** — کوئی فراہم کنندہ مفت درجہ ختم کرتا ہے تو تعداد کم ہو جاتی ہے؛ کوئی نیا شامل ہوتا ہے تو بڑھ جاتی ہے۔ ہم وہی شائع کرتے ہیں جو catalog حقیقت میں حساب کرتا ہے، کبھی بھی اوپر کی طرف گول کیا ہوا بہترین مفروضہ نہیں۔
```bash
# کسی provider سے کنیکٹ ہونے کے بعد، Dashboard → Endpoints سے اپنی OmniRoute key کاپی کریں:
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` کے لیے ایک اہل route درکار ہے۔ نئی installation میں کوئی اہل keyless target موجود نہ ہو سکتا ہے، اور کوئی keyless provider third-party clients کو مسترد کر سکتا ہے۔ `tos: avoid` کے بطور نشان زد providers، بشمول Kiro، بطور ڈیفالٹ automatic routing سے خارج رہتے ہیں؛ کسی account سے کنیکٹ ہونے پر یہ ترتیب تبدیل نہیں ہوتی۔ کسی provider کا انتخاب کرنے سے پہلے [Free Tiers Guide](docs/getting-started/FREE-TIERS-GUIDE.md) دیکھیں۔
📦 **Python، Node.js، PHP، اور cURL** کے لیے copy-paste quickstart scripts → [`examples/quickstart/`](examples/quickstart/)
> **کومبو** ماڈلز کی ایک زنجیر ہے جن کے درمیان OmniRoute **خودکار طور پر** روٹنگ کرتا ہے۔ اگر کوٹا ختم ہو جائے، کوئی فراہم کنندہ ناکام ہو جائے، یا اخراجات اچانک بڑھ جائیں، تو کومبو اگلے اہل اور صحت مند ماڈل پر منتقل ہو سکتا ہے۔ 🛡️
### ⚡ صفر کنفیگریشن — بس `auto` استعمال کریں
کوئی کومبو بنانے کی ضرورت نہیں۔ اپنے ماڈل کو `auto` (یا اس کی کسی قسم) پر سیٹ کریں، اور OmniRoute آپ کے منسلک فراہم کنندگان سے ایک ورچوئل کومبو بناتا ہے، جس کی لائیو اسکورنگ کی جاتی ہے:
📖 [Auto-Combo انجن](docs/routing/AUTO-COMBO.md) · [لچک پذیری کی رہنما دستاویز](docs/architecture/RESILIENCE_GUIDE.md)
📊 9router، OpenRouter، CLIProxyAPI اور LiteLLM کے مقابلے میں مکمل طریقۂ کار اور فیچر بہ فیچر تفصیل → [`docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md`](docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md)
کلید (بے ترتیب): `5d865059-bc44-483a-962d-43ceb80126eb`
Pix کاپی اور پیسٹ:
```
00020101021126580014br.gov.bcb.pix01365d865059-bc44-483a-962d-43ceb80126eb5204000053039865802BR5922OMNIROUTE CONTRIBUICAO6006BRASIL62070503***630475DD
```
📖 [اجازت دہی](docs/architecture/AUTHZ_GUIDE.md) · [حفاظتی حدود](docs/security/GUARDRAILS.md) · [تعمیل](docs/security/COMPLIANCE.md)
Default stacked combo runs `RTK → Caveman`. جب دونوں ایک ہی tool/context payload پر عمل کرتے ہیں تو بچت باہم مرکب ہو جاتی ہے:
```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 اور structured data کو preservation engine کے ذریعے **ہمیشہ محفوظ** رکھا جاتا ہے۔
> **جب کم ٹوکنز سے کام چل سکتا ہے تو زیادہ ٹوکنز کیوں استعمال کریں؟** ہر درخواست OmniRoute کی compression pipeline سے **شفاف طور پر** گزرتی ہے — client میں کسی تبدیلی کے بغیر۔ اب یہ **12 composable engines کا stack** ہے جو ترتیب سے چلتے ہیں اور ہر routing combo کے مطابق باہم ملائے جا سکتے ہیں — [RTK](https://github.com/rtk-ai/rtk)، [Caveman](https://github.com/JuliusBrussee/caveman) (⭐ 90K+)، [LLMLingua-2](https://github.com/microsoft/LLMLingua) اور [Troglodita](https://github.com/leninejunior/troglodita) (PT-BR) کے خیالات کی بنیاد پر۔
### 🧱 12-engine stack
Engines پائپ لائن کی ترتیب سے چلتے ہیں؛ ہر engine کو الگ سے toggle کیا جا سکتا ہے اور ہر combo کے مطابق configure کیا جا سکتا ہے:
