پلگ انز کیسے کام کرتے ہیں
پلگ ان ایک ایگزیکیوٹیبل اور ایک مینی فیسٹ ہوتا ہے۔ Nebo کالز کے درمیان کوئی پلگ ان پروسیس چلتا نہیں رکھتا۔ جب بھی کوئی ملازم پلگ ان استعمال کرتا ہے، Nebo بائنری کو ایک کمانڈ اور آرگیومنٹس کے ساتھ شروع کرتا ہے، اس کے ختم ہونے کا انتظار کرتا ہے، اور آؤٹ پٹ ملازم کو واپس دے دیتا ہے۔
- کمانڈز آرگیومنٹس ہوتی ہیں۔ ملازم ایک کمانڈ، جیسے
notes search، اور نام والے آرگیومنٹس چنتا ہے۔ Nebo ہر آرگیومنٹ--name valueکی صورت میں دیتا ہے۔ کوئی شیل نہیں ہوتا، اس لیے پائپس اور ری ڈائریکٹس کبھی لاگو نہیں ہوتے۔ - آؤٹ پٹ stdout ہے۔ نتائج stdout پر لکھیں۔ JSON اچھا کام کرتا ہے۔
- عام کالز کے لیے اسٹینڈرڈ ان پٹ بند ہوتا ہے۔ ہکس، روٹس اور چیٹ فراہم کنندگان stdin استعمال کرتے ہیں؛ plugin.json کا حوالہ دیکھیں۔
ہر انسٹال شدہ اور فعال پلگ ان ملازمین کو plugin__<slug> نام کے ایک ٹول کے طور پر نظر آتا ہے۔ ملازم اسے اس طرح کال کرتا ہے:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo یہ چلاتا ہے:
notes-sync notes search --query "quarterly plan" --limit 5
| پیرامیٹر | قسم | مطلب |
|---|---|---|
command | string، لازمی | پلگ ان کمانڈ اور کوئی بھی پوزیشنل الفاظ۔ |
args | اسٹرنگز کا آبجیکٹ | نام والے آرگیومنٹس۔ ہر ایک --key value بن جاتا ہے۔ |
timeout | integer | انتظار کے سیکنڈز۔ طے شدہ 120، جس کی حد مینی فیسٹ کا permissions.maxTimeoutSeconds ہے۔ |
display | string | وہ جملہ جو کال کو منظوری درکار ہونے پر مالک دیکھتا ہے۔ |
اپنا پہلا پلگ ان بنائیں
کسی بھی زبان میں ایک بائنری لکھیں جو آرگیومنٹس سے اپنی کمانڈ پڑھے اور نتیجہ پرنٹ کرے۔ پھر اسے کسی بوٹ کی یوزر پلگ انز ڈائریکٹری میں plugin.json کے ساتھ رکھ دیں۔
<data>/user/plugins/notes-sync/
├── plugin.json # runtime manifest
├── notes-sync # your binary, named after the slug
└── skills/ # optional: skills that teach employees to use it
└── notes-sync/
└── SKILL.md {
"id": "notes-sync",
"slug": "notes-sync",
"name": "Notes Sync",
"version": "0.1.0",
"description": "Search, read and create notes in Example Notes.",
"platforms": {}
} id، slug، name، version اور platforms لازمی ہیں۔ یوزر پلگ انز ڈائریکٹری میں platforms میپ خالی ہو سکتا ہے: Nebo پہلے plugin.json کے ساتھ slug کے نام والی بائنری ڈھونڈتا ہے، پھر target/release/ اور target/debug/ میں۔ جب آپ شائع کرتے ہیں تو مارکیٹ پلیس آپ کی اپ لوڈ کی گئی ہر بائنری کے لیے platforms بھر دیتا ہے۔
<data> سے مراد macOS پر ~/Library/Application Support/Nebo، Windows پر %APPDATA%\Nebo اور Linux پر ~/.local/share/nebo ہے، یا NEBO_HOME کی قدر۔ یوزر ڈائریکٹری میں موجود پلگ ان اسی slug والے مارکیٹ پلیس پلگ ان پر فوقیت رکھتا ہے، اس لیے نئی بلڈ ٹیسٹ کرنے کی جگہ یہی ہے۔
ملازمین کو اس کا استعمال سکھائیں
plugin.json کے ساتھ ایک skills/ فولڈر رکھیں۔ اس میں موجود ہر مہارت پلگ ان کے انسٹال رہنے تک ہر ملازم کے لیے دستیاب ہوتی ہے، اور پلگ ان کو خود بخود ایک انحصار کے طور پر درج کرتی ہے۔ مہارت میں بتائیں کہ کون سی کمانڈز موجود ہیں، وہ کیا لوٹاتی ہیں، اور ہر ایک کب استعمال کرنی ہے۔ سب سے کارآمد مہارتوں کے نام entrySkills میں لکھیں تاکہ پلگ ان کے ٹول کی تفصیل سب سے پہلے انہی کی طرف اشارہ کرے۔
مارکیٹ پلیس لسٹنگ ایک الگ فائل ہے، PLUGIN.md۔ Nebo اسے چلتے وقت نہیں پڑھتا؛ یہ وہ صفحہ ہے جو لوگ انسٹال کرنے سے پہلے دیکھتے ہیں۔ پلگ ان شپ کرنا دیکھیں۔
انوائرنمنٹ
ہر کال بوٹ کا انوائرنمنٹ وراثت میں لیتی ہے، جس سے لوڈر اور شیل انجیکشن والے ویری ایبلز ہٹا دیے جاتے ہیں، پھر یہ قدریں شامل کی جاتی ہیں۔ بعد والے اندراجات کو فوقیت ہوتی ہے۔
| ویری ایبل | قدر |
|---|---|
auth.env کیز | مینی فیسٹ سے طے شدہ قدریں۔ |
<SLUG>_BIN | اس پلگ ان کی بائنری کا پاتھ، اور ہر اس پلگ ان کا جس پر یہ منحصر ہے۔ slug بڑے حروف میں ہوتا ہے اور ہائفنز کی جگہ انڈر اسکور۔ |
NEBO_DATA_DIR | پلگ ان کا اپنا ڈیٹا فولڈر، <data>/appdata/plugins/<slug>/۔ یہی ورکنگ ڈائریکٹری بھی ہے، اور یہ ان انسٹال کے بعد بھی باقی رہتا ہے۔ |
PATH | پہلے پلگ ان فولڈرز، پھر وراثت میں ملا پاتھ۔ |
| ترتیبات | configSchema فیلڈز کے لیے مالک کی محفوظ کردہ قدریں۔ |
NEBO_AGENT_ID | کال کرنے والا ملازم۔ |
profileDirEnv | اس ملازم اور اکاؤنٹ کا اکاؤنٹ فولڈر، جب پلگ ان اکاؤنٹس کو سپورٹ کرتا ہو۔ |
permissions.envAllow اور permissions.envDeny محدود کرتے ہیں کہ پلگ ان بوٹ سے کیا وراثت میں لیتا ہے۔ یہ پلگ ان کے اپنے تصدیقی ویری ایبلز کبھی نہیں ہٹاتے۔
اکاؤنٹس اور اسناد
جو پلگ ان کسی سروس میں سائن ان کرتا ہے، اسے ہر ملازم کے لیے ایک اکاؤنٹ رکھنا چاہیے۔ بک کیپر فنانس لاگ ان سے سائن ان کرتا ہے اور اسسٹنٹ اپنے لاگ ان سے، اور کوئی بھی دوسرے کے ٹوکن نہیں دیکھتا۔ آپ یہ مینی فیسٹ میں بیان کرتے ہیں؛ باقی Nebo کرتا ہے۔
"auth": {
"type": "env",
"label": "Example Notes account",
"env": { "EXAMPLE_NOTES_TOKEN": "" },
"commands": { "login": "auth login", "status": "auth status", "logout": "auth logout" },
"profileDirEnv": "EXAMPLE_NOTES_CONFIG_DIR"
},
"capabilities": {
"configSchema": [
{ "key": "EXAMPLE_NOTES_TOKEN", "label": "API token", "fieldType": "password", "secret": true, "required": true }
]
} auth.envاسناد کے نام بتاتا ہے۔capabilities.configSchemaان کے لیبل لگاتا ہے اور کنیکٹ فارم میں ان کی ترتیب طے کرتا ہے۔auth.profileDirEnvاس ویری ایبل کا نام بتاتا ہے جس سے آپ کا پلگ ان اپنی اسناد کا فولڈر پڑھتا ہے۔ Nebo ہر ملازم اور اکاؤنٹ کے لیے ایک فولڈر بناتا ہے اور ہر کال پر وہ ویری ایبل سیٹ کرتا ہے۔- جب مالک کوئی اکاؤنٹ کنیکٹ کرتا ہے تو Nebo آپ کی
loginکمانڈ مالک کی ٹائپ کی ہوئی قدروں اور اکاؤنٹ فولڈر کے ساتھ چلاتا ہے۔ آپ کا پلگ ان جو کچھ اسے درکار ہو اس فولڈر میں محفوظ کرتا ہے۔ Nebo یہ قدریں اپنے پاس نہیں رکھتا۔ - آپ کی
statusکمانڈ JSON پرنٹ کرتی ہے، جیسے{"authenticated": true}۔ جب ٹوکن کی میعاد ختم ہو جائے تو اگر آپ نےrefreshبیان کیا ہو تو Nebo اسے چلاتا ہے۔
براؤزر سائن ان کے لیے type کو oauth_cli پر سیٹ کریں اور login سے فراہم کنندہ کا سائن ان URL پرنٹ کروائیں یا کھلوائیں۔ ملازمین کبھی خود سائن ان نہیں کرتے: جب کسی کال کو لاگ ان درکار ہو تو مالک کو ایک کنیکٹ کارڈ نظر آتا ہے۔ کئی اکاؤنٹس والا ملازم کمانڈ میں --account <label> شامل کر کے ایک اکاؤنٹ چنتا ہے۔ Nebo یہ فلیگ آپ کی بائنری تک پہنچنے سے پہلے ہٹا دیتا ہے۔
سروس کا نام لیں، شکل کا نہیں۔ پلگ ان کا نام بتاتا ہے کہ یہ کس سے جڑتا ہے، جیسے "Example Notes"۔ پلگ ان کے نام میں کبھی "CLI" نہ لکھیں؛ ملازمین اور مالکان کے لیے یہ ایک کنکشن ہے، کمانڈ لائن نہیں۔
آگے
- plugin.json کا حوالہ: ہر فیلڈ، بشمول ایونٹس، ہکس اور ٹائپ شدہ آپریشنز۔
- پلگ ان شپ کرنا: پلیٹ فارمز، بائنریز، دستخط اور اپ ڈیٹس۔
- اشاعت: ہر آرٹیفیکٹ کے لیے مارکیٹ پلیس کا طریقہ۔