پروڈکشن گریڈ • <10MB RAM • <1s بُوٹ • $10 ہارڈویئر • دنیا کے لیے بنایا گیا!
فوری شروع • خصوصیات • آرکیٹیکچر • انسٹالیشن • ڈیمو • دستاویزات • کمیونٹی
**اردو** | [日本語](README.ja.md) | [Português](README.pt-br.md) | [Tiếng Việt](README.vi.md) | [Français](README.fr.md) | [English](README.md)
---
## 📦 انسٹالیشن
### سسٹم کی ضروریات
| پلیٹ فارم | کم از کم | تجویز کردہ |
|----------|---------|-------------|
| **Linux SBC** | Orange Pi Zero ($10) | Raspberry Pi 4 |
| **Android** | 2GB RAM، Termux | 4GB RAM |
| **ڈیسک ٹاپ** | 2GB RAM، کوئی بھی OS | 4GB RAM |
| **Docker** | 512MB RAM | 1GB RAM |
### انسٹالیشن کے طریقے
#### 1. ایک کمانڈ انسٹال (تجویز کردہ)
اوپر [فوری شروع](#-فوری-شروع) دیکھیں۔
#### 2. سورس سے بنائیں
```bash
git clone https://github.com/AbdullahMalik17/malikclaw.git
cd malikclaw
# موجودہ پلیٹ فارم کے لیے بنائیں
make build
# بنائیں اور انسٹال کریں
make install
# کئی پلیٹ فارمز کے لیے بنائیں
make build-all
```
#### 3. Docker
```bash
# کم از کم (Alpine-based)
docker compose -f docker/docker-compose.yml up
# مکمل خصوصیت (Node.js 24 MCP سپورٹ کے لیے)
docker compose -f docker/docker-compose.full.yml up
```
#### 4. پیکج مینیجرز
**Homebrew (macOS):**
```bash
brew install malikclaw
```
**Scoop (Windows):**
```bash
scoop install malikclaw
```
**AUR (Arch Linux):**
```bash
yay -S malikclaw
```
---
## 🎮 ڈیمو
### انٹرایکٹو ڈیمو اسکرپٹ
تمام صلاحیتوں کا مظاہرہ کرنے والی جامع ڈیمو چلائیں:
```bash
curl -fsSL https://raw.githubusercontent.com/AbdullahMalik17/malikclaw/main/demo.sh | bash
```
### ڈیمو 1: فون کنٹرول (ADB)
**ضروریات:**
- USB ڈی بگنگ فعال کے ساتھ Android ڈیوائس
- ADB انسٹال (`sudo apt install android-tools-adb`)
**کمانڈز:**
```bash
# اسکرین شاٹ لیں
malikclaw agent -m "Take a screenshot of my phone"
# کوآرڈینیٹس پر ٹیپ کریں
malikclaw agent -m "Tap at position 500, 1000 on my phone"
# ٹیکسٹ ٹائپ کریں
malikclaw agent -m "Type 'Hello World' on my phone"
# ایپ کھولیں
malikclaw agent -m "Open WhatsApp on my phone"
# سوائپ حرکت
malikclaw agent -m "Swipe up on my phone screen"
```
### ڈیمو 2: ای میل (Gmail)
**ضروریات:**
- Gmail اکاؤنٹ
- config میں Gmail API فعال
**کمانڈز:**
```bash
# ای میل بھیجیں
malikclaw agent -m "Send an email to john@example.com with subject 'Meeting' and body 'Let's meet at 3pm tomorrow'"
# حالیہ ای میلز دیکھیں
malikclaw agent -m "Show my 5 most recent emails"
# ای میلز تلاش کریں
malikclaw agent -m "Find emails from last week about 'project'"
# ای میل کا جواب دیں
malikclaw agent -m "Reply to the last email with 'Thanks, I'll review it'"
```
### ڈیمو 3: ویب سرچ
**ضروریات:**
- انٹرنیٹ کنکشن
- DuckDuckGo ڈیفالٹ کے طور پر فعال (کوئی API key نہیں چاہیے)
**کمانڈز:**
```bash
# موجودہ موسم حاصل کریں
malikclaw agent -m "What's the weather in Lahore today?"
# خبریں تلاش کریں
malikclaw agent -m "What are the latest AI news today?"
# موضوع پر تحقیق کریں
malikclaw agent -m "Research quantum computing breakthroughs in 2025"
# دستاویزات حاصل کریں
malikclaw agent -m "Fetch the Go 1.25 release notes"
# ٹیوٹوریلز تلاش کریں
malikclaw agent -m "Find Go programming tutorials for beginners"
```
---
## 🖥️ ویب انٹرفیس
جدید ویب UI تک رسائی: **http://localhost:18790**
**خصوصیات:**
- حقیقی وقت چیٹ انٹرفیس
- اسٹیٹس ڈیش بورڈ (ایجنٹ اسٹیٹس، میموری استعمال، ٹولز، اپ ٹائم)
- ڈیمو ٹاسک شارٹ کٹس
- رسپانسو ڈیزائن (موبائل فرینڈلی)
- ڈارک تھیم
**ویب UI شروع کریں:**
```bash
malikclaw gateway
```
یا Docker کے ساتھ:
```bash
docker run -d -p 18790:18790 -v ~/.malikclaw:/root/.malikclaw ghcr.io/abdullahmalik17/malikclaw:latest
```
---
## ⚙️ کنفیگریشن
### بنیادی کنفگ
`~/.malikclaw/config.json` ایڈٹ کریں:
```json
{
"model_list": [
{
"model_name": "gpt-4o-mini",
"model": "openai/gpt-4o-mini",
"api_key": "sk-your-api-key-here"
}
],
"tools": {
"web": {
"duckduckgo": { "enabled": true },
"tavily": { "enabled": false }
},
"shell": { "enabled": true },
"file": { "enabled": true }
},
"performance": {
"low_memory_mode": true,
"max_concurrent_tasks": 2
}
}
```
### API کیز حاصل کریں
**LLM پرووائیڈرز:**
- [OpenRouter](https://openrouter.ai/keys) - ملٹی پرووائیڈر ایکسیس
- [Zhipu](https://open.bigmodel.cn/) - چینی LLM پرووائیڈر
- [Anthropic](https://console.anthropic.com) - Claude ماڈلز
- [OpenAI](https://platform.openai.com) - GPT ماڈلز
**ویب سرچ (اختیاری):**
- [Tavily](https://tavily.com) - AI-آپٹیمائزڈ (1000 مفت سوالات/مہینہ)
- [Brave](https://brave.com/search/api) - ادا شدہ ($5/1000 سوالات)
- [Perplexity](https://www.perplexity.ai) - AI-پاورڈ
- [SearXNG](https://github.com/searxng/searxng) - خود میزبان، مفت
---
## 🎯 استعمال کی مثالیں
### 1. ذاتی اسسٹنٹ
- ای میلز اور کیلنڈر مینیج کریں
- یاد دہانیاں اور الارم سیٹ کریں
- معلومات کے لیے تلاش کریں
- سمارٹ ہوم ڈیوائسز کنٹرول کریں
### 2. ڈیولپر ٹول
- کوڈ جنریشن اور جائزہ
- فائل آپریشنز اور تلاش
- Git آپریشنز
- دستاویزات تلاش
- TODO کمنٹس ٹریکنگ
### 3. موبائل آٹومیشن
- بار بار فون کے کاموں کو خودکار کریں
- اسکرین شاٹس لیں اور ٹیکسٹ نکالیں
- WhatsApp کے ذریعے پیغامات بھیجیں
- ایپس کو ریموٹلی کنٹرول کریں
### 4. ایج AI
- کم پاور ہارڈویئر پر چلائیں
- لوکل ماڈلز کے ساتھ آف لائن قابل
- پرائیویسی فرسٹ (ڈیٹا لوکل رہتا ہے)
- کم سے کم پاور کے ساتھ 24/7 آپریشن
---
## 📚 دستاویزات
| دستاویز | تفصیل | سامعین |
|----------|-------------|----------|
| [PRODUCT.md](PRODUCT.md) | **فوری شروع گائیڈ** (5 منٹ سیٹ اپ) | نئے صارفین |
| [QUICK_REFERENCE.md](QUICK_REFERENCE.md) | کمانڈ چیٹ شیٹ | تمام صارفین |
| [README.product.md](README.product.md) | پروڈکٹ کا جائزہ | عمومی |
| [pkg/agent/agentloop/README.md](pkg/agent/agentloop/README.md) | ایجنٹ لوپ آرکیٹیکچر | ڈیولپرز |
| [CONTRIBUTING.md](CONTRIBUTING.md) | شراکت کے رہنما خطوط | شراکت دار |
| [ROADMAP.md](ROADMAP.md) | ترقیاتی روڈ میپ | کمیونٹی |
---
## 🔧 ٹربل شوٹنگ
### عام مسائل
**انسٹالیشن کے بعد "Command not found":**
```bash
export PATH="$HOME/.local/bin:$PATH"
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```
**"API key not configured":**
1. config کھولیں: `malikclaw config edit`
2. `model_list` میں اپنی API key شامل کریں
3. محفوظ کریں اور دوبارہ کوشش کریں
**"ADB device not found":**
```bash
# فون پر USB ڈی بگنگ فعال ہے چیک کریں
# منسلک ڈیوائسز کی فہرست
adb devices
# اگر خالی ہے، تو کوشش کریں:
adb kill-server
adb start-server
adb devices
```
**کم RAM والی ڈیوائسز پر "Out of memory":**
```json
{
"performance": {
"low_memory_mode": true,
"max_concurrent_tasks": 1,
"gc_interval_seconds": 180
}
}
```
📖 **مزید مدد:** [PRODUCT.md#troubleshooting](PRODUCT.md#troubleshooting)
---
## 🤝 شراکت
ہم شراکت کا خیرمقدم کرتے ہیں! رہنما خطوط کے لیے [CONTRIBUTING.md](CONTRIBUTING.md) دیکھیں۔
### شراکت کے طریقے
- 🐛 بگز رپورٹ کریں
- ✨ خصوصیات شامل کریں
- 📝 دستاویزات بہتر بنائیں
- 🌍 اپنی زبان میں ترجمہ کریں
- 💡 استعمال کی مثالیں شیئر کریں
- 🔌 اسکلز/پلگ انز بنائیں
### ڈیولپمنٹ سیٹ اپ
```bash
git clone https://github.com/AbdullahMalik17/malikclaw.git
cd malikclaw
# ڈیپنڈنسیز ڈاؤن لوڈ کریں
make deps
# ٹیسٹس چلائیں
make test
# بنائیں
make build
# لنٹرز چلائیں
make lint
```
---
## 📢 کمیونٹی
دنیا بھر کے ڈیولپرز اور صارفین کی ہماری عالمی کمیونٹی میں شامل ہوں:
- **GitHub:** [بحثیں](https://github.com/AbdullahMalik17/malikclaw/discussions)
- **ویب سائٹ:** [malikclaw.io](https://malikclaw.io)
- **Twitter:** [@AbdullahMalik17](https://twitter.com/AbdullahMalik17)
- **Discord:** [سرور میں شامل ہوں](https://discord.gg/malikclaw) (جلد ہی)
---
## 📄 لائسنس
MIT License — تفصیلات کے لیے [LICENSE](LICENSE) فائل دیکھیں۔
---
## 🌍 دنیا کے لیے بنایا گیا
MalikClaw کو فخر کے ساتھ دنیا بھر کے ڈیولپرز اور تنظیمیں استعمال کرتی ہیں:
- 🌏 **ایشیا:** پاکستان، بھارت، جاپان، چین، ویتنام، فلپائن
- 🌍 **یورپ:** جرمنی، فرانس، برطانیہ، نیدرلینڈز، پولینڈ
- 🌎 **امریکہ:** امریکہ، برازیل، کینیڈا، میکسیکو، ارجنٹائن
- 🌍 **افریقہ:** نائجیریا، مصر، جنوبی افریقہ، کینیا
- 🌏 **اوشیانا:** آسٹریلیا، نیوزی لینڈ
**20+ ممالک سے شراکت دار** اور ہر روز بڑھ رہے ہیں!
---