منصوبے کے بارے میں

ہیڈروم (Headroom) AI ایجنٹس کے لیے ایک مقامی سیاق و سباق کمپریشن لیئر ہے۔ یہ ہر اس چیز کو کمپریس کرتا ہے جسے ایجنٹ پڑھتا ہے — جیسے ٹول آؤٹ پٹس، لاگز، RAG چنکس، فائلز اور بات چیت کی تاریخ — اس سے پہلے کہ وہ بڑے زبان کے ماڈل (LLM) تک پہنچے۔ اس کا مقصد جوابات کی سالمیت برقرار رکھتے ہوئے ٹوکن کے استعمال میں کمی لانا ہے۔ کمپریشن مقامی طور پر چلتی ہے؛ پرومپٹس اور فائلوں کا مواد کمپریشن کے لیے کسی دوسری جگہ بھیجا نہیں جاتا۔ اہم خصوصیات: - لائبریری: پیایتھون یا ٹائپ اسکرپٹ میں `compress(messages)` کا استعمال کریں، جو کسی بھی ایپلی کیشن میں ان لائن استعمال کیا جا سکتا ہے۔ - پراکسی: `headroom proxy --port 8787` ایک ڈراپ ان لوکل پراکسی ہے جس کے لیے کوڈ میں تبدیلی کی ضرورت نہیں اور یہ کسی بھی OpenAI-compatible کلائنٹ کے ساتھ کام کرتی ہے۔ - ایجنٹ واپر: `headroom wrap` Claude Code, Codex, Grok CLI, Cursor, Aider, Copilot CLI, VS Code Copilot, OpenClaw, OpenCode, Cline, Continue, Goose, OpenHands, Mistral Vibe, Oh My Pi, Kimi CLI, ZCode اور دیگر کو سپورٹ کرتا ہے۔ `headroom unwrap` سیٹ اپ کو ریورس کرتا ہے۔ - MCP سرور: یہ کسی بھی MCP کلائنٹ کے لیے `headroom_compress`, `headroom_retrieve`, اور `headroom_stats` ٹولز کو ظاہر کرتا ہے۔ - کراس ایجنٹ میموری: Claude, Codex, Gemini, اور Grok کے درمیان ایک مشترکہ، غیر دوہری شدہ ذخیرہ۔ - `headroom learn`: ناکام سیشنز سے اصلاحات نکال کر `CLAUDE.local.md` (ڈیفالٹ، gitignored) یا دیگر ایجنٹ انسٹرکشن فائلز میں لکھتا ہے۔ - آؤٹ پٹ ٹوکن میں کمی: آپشنل پراکسی سائیڈ وربوزٹی اسٹیئرنگ اور ایفارٹ روٹنگ ماڈل کے ذریعے واپس لکھے جانے والے ٹوکنز کو کم کرنے کے لیے، نہ صرف بھیجے جانے والے ٹوکنز کو۔ - ریورسیبل کمپریشن (CCR): اصل فائلز مقامی طور پر کیچ کی جاتی ہیں اور `headroom_retrieve` کے ذریعے طلب پر بازیافت کی جاتی ہیں۔ طریقہ کار: ایک ContentRouter مواد کی قسم کا پتہ لگاتا ہے اور ایک کمپریسر منتخب کرتا ہے — JSON کے لیے SmartCrusher، کوڈ کے لیے CodeCompressor (AST-aware، Python, JS/TS, Go, Rust, Java, C/C++, اور Perl کو سپورٹ کرتا ہے)، اور متن کے لیے Kompress-v2-base (ایک Hugging Face ماڈل جو ایجنٹک ٹریسز پر تربیت یافتہ ہے)۔ CacheAligner متزلزل مواد کی نشاندہی کرتا ہے جو فراہم کنندہ KV-cache پریفکس کو توڑ سکتا ہے بغیر پرومپٹس کو دوبارہ لکھے؛ لائیو زون کمپریشن فریزڈ پریفکس کو بائٹ سطح پر یکساں رکھتی ہے تاکہ فراہم کنندہ کیچز زندہ رہیں۔ Anthropic/OpenAI SDKs, Vercel AI SDK, LiteLLM, LangChain, Agno, Strands, ASGI apps, اور multi-agent SharedContext کے لیے فریم ورک ایڈاپٹرز فراہم کیے گئے ہیں۔ README میں شیدڈ آف لائن پروف بینچ مارکس رپورٹ کیے گئے ہیں: کوڈ سرچ پر 21% بچت، SRE انسیڈنٹ ڈیبگنگ پر 57%, کوڈ بیس ایکسپلوریشن پر 42%, اور GitHub آئی شو ٹرائیج پر 30%, جبکہ بار بار JSON/لاگ پی لوڈز 90% صاف کرتے ہیں۔ کمپریشن لیٹنسی 10K ٹوکنز پر ایک ملی سیکنڈ سے بھی کم رپورٹ کی گئی ہے۔ README میں درستگی کے ایلوز GSM8K اور TruthfulQA پر کوئی قابل تشخیص فرق نہیں دکھاتے، اور 19–32% کمپریشن پر SQuAD v2 اور BFCL پر 97% ہیں۔ انسٹالیشن: `uv tool install --python 3.13 "headroom-ai[all]"`, `pip install "headroom-ai[all]"`, `npm install headroom-ai` (صرف ٹائپ اسکرپٹ SDK، CLI نہیں)، یا Docker امیج `ghcr.io/headroomlabs-ai/headroom`۔ Python 3.10+ درکار ہے؛ Apache 2.0 لائسنس کے تحت لائسنس یافتہ۔ گرینولر ایکسٹرا میں `[proxy]`, `[mcp]`, `[ml]`, `[code]`, `[memory]`, `[vector]`, `[image]`, اور فریم ورک ایڈاپٹرز شامل ہیں۔