اعلیٰ سطحی فیلڈز
| فیلڈ | قسم | لازمی | مطلب |
|---|---|---|---|
id | string | ہاں | مارکیٹ پلیس میں پلگ ان کا شناخت کنندہ۔ ڈیولپمنٹ کے دوران slug استعمال کریں۔ |
slug | string | ہاں | مستقل شناخت کنندہ۔ [a-z0-9-]، زیادہ سے زیادہ 64 حروف، شروع، آخر یا دوہرا ہائفن نہیں۔ اسی سے plugin__<slug> ٹول اور <SLUG>_BIN ویری ایبل کا نام بنتا ہے۔ |
name | string | ہاں | ڈسپلے نام۔ اس سروس کا نام لیں جس سے یہ جڑتا ہے۔ |
version | string | ہاں | سیمینٹک ورژن، جیسے 0.1.0۔ |
platforms | map | ہاں | پلیٹ فارم کی سے بائنری تک۔ Platforms دیکھیں۔ |
description | string | نہیں | لوگوں اور ملازمین کے لیے ایک جملہ۔ |
author | string | نہیں | ناشر کا نام۔ |
category | string | نہیں | ملازمین کو پلگ ان تلاش کرنے میں مدد دیتا ہے۔ |
triggers | اسٹرنگز کی فہرست | نہیں | وہ الفاظ جو بتاتے ہیں کہ پلگ ان کب کام آتا ہے۔ سرچ کے اشاروں میں استعمال ہوتے ہیں۔ |
entrySkills | اسٹرنگز کی فہرست | نہیں | بنڈل شدہ مہارتیں جن کا نام پلگ ان کے ٹول کی تفصیل میں سب سے پہلے لیا جائے۔ |
dependencies | {name, version, optional} کی فہرست | نہیں | دوسرے پلگ انز جنہیں یہ پلگ ان چلاتا ہے۔ version کی طے شدہ قدر "*" ہے؛ optional کی false۔ ان کے <SLUG>_BIN پاتھ ہر کال پر سیٹ ہوتے ہیں۔ |
auth | object | نہیں | سائن ان اور اکاؤنٹس۔ Auth دیکھیں۔ |
capabilities | object | نہیں | configSchema, hooks, commands, routes, providers. |
permissions | object | نہیں | ماحول کی فلٹرنگ اور ٹائم آؤٹ کی بالائی حد۔ |
events | list | نہیں | نگران جو ملازمین کے ورک فلوز کو ایونٹس فراہم کرتے ہیں۔ |
interfaceBindings | map | نہیں | ٹائپ شدہ آپریشنز جو پلگ ان فراہم کرتا ہے۔ |
channel | object | نہیں | کسی میسجنگ سروس سے مستقل رابطہ پل۔ |
setup | object | نہیں | مرحلہ وار سیٹ اپ وزرڈ۔ |
Nebo مارکیٹ پلیس سے ہونے والی انسٹالیشنز کی توثیق کرتا ہے: slug کے اصول، سیمینٹک ورژن، کم از کم ایک پلیٹ فارم، ایسا binaryName جس میں پاتھ سیپریٹر یا .. نہ ہو، login کمانڈ جب تک auth.type کی قدر env نہ ہو، خالی نہ ہونے والے ایونٹ نام اور کمانڈز، اور ایسے بائنڈنگ ٹیمپلیٹس جو درست پارس ہوں۔ صارف کی پلگ انز ڈائریکٹری میں موجود پلگ انز توثیق سے مستثنیٰ ہیں۔
پلیٹ فارمز
کیز darwin-arm64، darwin-amd64، linux-arm64، linux-amd64، windows-arm64 اور windows-amd64 ہیں۔ ہر اندراج میں نیچے دی گئی پانچوں فیلڈز ہوتی ہیں۔ جب آپ شائع کرتے ہیں تو مارکیٹ پلیس اصل ہیش، سائز، دستخط اور ڈاؤن لوڈ URL لکھ دیتا ہے، اس لیے جو فائل آپ اپ لوڈ کریں اس میں انہیں خالی چھوڑ دیں۔
"platforms": {
"darwin-arm64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"linux-amd64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
} | فیلڈ | مطلب |
|---|---|
binaryName | ایگزیکیوٹیبل کی فائل کا نام۔ Windows پر .exe لگائیں۔ |
sha256 | بائنری کا ہیش۔ انسٹال کے وقت جانچا جاتا ہے۔ |
signature | بائنری کا دستخط۔ سائننگ کی دستیاب ہونے پر انسٹال کے وقت جانچا جاتا ہے۔ |
size | بائٹس میں سائز۔ |
downloadUrl | جہاں سے Nebo پیکیج ڈاؤن لوڈ کرتا ہے۔ |
تصدیق
| فیلڈ | مطلب |
|---|---|
type | oauth_cli پلگ ان کے ذریعے براؤزر میں سائن ان کے لیے؛ env ان اسناد کے لیے جو قدروں کے طور پر درج کی جائیں؛ neboai تاکہ _TOKEN پر ختم ہونے والی ہر auth.env کی میں مالک کا NeboAI ٹوکن ملے۔ |
env | ویری ایبل کے نام سے طے شدہ قدر تک کا میپ۔ یہی اسناد کے وہ واحد نام بھی ہیں جو Nebo login کو دیتا ہے۔ |
commands.login | سائن ان کرتا ہے۔ لازمی ہے جب تک type کی قدر env نہ ہو۔ اکاؤنٹ فولڈر سیٹ کر کے چلتا ہے۔ |
commands.status | JSON پرنٹ کرتا ہے جو بتاتا ہے کہ اکاؤنٹ سائن ان ہے یا نہیں۔ |
commands.refresh | بغیر کسی تعامل کے ٹوکن کی تجدید کرتا ہے۔ |
commands.logout | سائن آؤٹ کرتا ہے۔ صرف مالک اسے چلا سکتا ہے۔ |
profileDirEnv | وہ ویری ایبل جسے ہر ملازم اور اکاؤنٹ کے لیے اسناد کا الگ فولڈر ملتا ہے۔ اس کے بغیر پلگ ان ایک مشترکہ اکاؤنٹ رکھتا ہے۔ |
label, description | کنیکٹ کارڈ پر متن۔ |
help | {url, urlLabel, text} جو کنیکٹ کرتے وقت دکھایا جاتا ہے۔ |
publicRedirect | جب فراہم کنندہ http://localhost ری ڈائریکٹس قبول نہ کرے تو true سیٹ کریں؛ تب سائن ان NeboAI کے عوامی ری ڈائریکٹ سے ہو کر جاتا ہے۔ |
Nebo اسٹیٹس آؤٹ پٹ میں authenticated، isAuthenticated، logged_in، loggedIn یا token_valid میں سے پہلی موجود قدر پڑھتا ہے۔ خالی نہ ہونے والا token_error، یا credential_source، auth_method، storage یا status میں none کی قدر کا مطلب ہے سائن آؤٹ۔ اسٹیٹس کمانڈ کے پاس 45 سیکنڈ ہوتے ہیں۔
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema ان قدروں کو بیان کرتا ہے جو مالک پلگ ان کے لیے سیٹ کرتا ہے۔ ہر قدر بائنری تک key کے نام والے انوائرنمنٹ ویری ایبل کے طور پر پہنچتی ہے۔ اسناد کی ان کیز کے لیے جو auth.env میں بھی درج ہیں، اسکیما ہر ملازم کے کنیکٹ فارم کی فیلڈز کے لیبل طے کرتا ہے۔
| فیلڈ | قسم | طے شدہ | مطلب |
|---|---|---|---|
key | string | لازمی | انوائرنمنٹ ویری ایبل کا نام۔ |
label | string | لازمی | فیلڈ کا لیبل۔ |
description | string | "" | مدد کا متن۔ |
fieldType | string | "string" | ان پٹ کی قسم، جیسے string، number، boolean، select یا password۔ |
default | string | کوئی نہیں | پہلے سے بھری ہوئی قدر۔ |
required | boolean | false | جب تک قدر سیٹ نہ ہو، پلگ ان تیار نہیں ہوتا۔ |
secret | boolean | false | واپس پڑھتے وقت قدر چھپا دی جاتی ہے۔ |
options | اسٹرنگز کی فہرست | کوئی نہیں | select کے لیے انتخاب۔ |
اجازتیں
| فیلڈ | طے شدہ | مطلب |
|---|---|---|
envAllow | [] | وراثت میں ملے ویری ایبلز جو پلگ ان دیکھ سکتا ہے۔ خالی ہو تو سب کی اجازت ہے۔ |
envDeny | [] | وراثت میں ملے ویری ایبلز جو ہمیشہ ہٹا دیے جاتے ہیں۔ |
maxTimeoutSeconds | 300 | کسی بھی کال کے ٹائم آؤٹ کی بالائی حد۔ |
network | false | نیٹ ورک کے استعمال کا اعلان کرتا ہے۔ صرف معلومات کے لیے؛ نافذ نہیں کیا جاتا۔ |
ایونٹس
ایونٹ ایک طویل عرصے تک چلنے والا نگران ہے۔ Nebo اسے تب شروع کرتا ہے جب کسی ملازم کا ورک فلو اسے دیکھتا ہے، اور بند ہو جانے پر دوبارہ شروع کرتا ہے۔ نگران stdout پر جو بھی لائن لکھتا ہے وہ ایک ایونٹ ہے۔ چلتے وقت ایونٹ کے نام سے پہلے slug لگا دیا جاتا ہے، اس لیے note.created بن جاتا ہے notes-sync.note.created۔
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | فیلڈ | مطلب |
|---|---|
name | ایونٹ کا نام، slug کے بغیر۔ لازمی۔ |
command | آرگیومنٹس جو نگران کو شروع کرتے ہیں۔ لازمی۔ {{key}} کی جگہ ملازم کی ان پٹ قدریں لگائی جاتی ہیں۔ |
description | ایونٹ کس وجہ سے ہوتا ہے۔ |
multiplexed | جب true ہو تو ایک نگران کئی قسم کے ایونٹس بھیجتا ہے اور ہر لائن میں ایک "event" فیلڈ ہوتی ہے۔ |
ورک فلوز watch ٹرگر کے ذریعے ایونٹس کو سبسکرائب کرتے ہیں۔ ٹرگرز دیکھیں۔
interfaceBindings
بائنڈنگ کسی انٹرفیس آپریشن کو آپ کی کسی کمانڈ سے جوڑتی ہے۔ ہر بائنڈنگ ملازمین کے لیے ایک ٹائپ شدہ ٹول بن جاتی ہے، جس کا نام آپریشن کے نام پر چھوٹے حروف میں ہوتا ہے اور نقطوں اور ہائفنز کی جگہ انڈر اسکور: notes.search بن جاتا ہے notes_search۔ بائنڈنگز کے ذریعے ہی کوئی پلگ ان وہ صلاحیتیں پوری کرتا ہے جو کسی ملازم کو درکار ہوں؛ صلاحیتیں دیکھیں۔
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | پلیس ہولڈر | پھیل کر یہ بنتا ہے |
|---|---|
{field} | فیلڈ کی قدر ایک لفظ کے طور پر۔ فیلڈ الگ سے فلیگ کے طور پر نہیں دی جاتی۔ |
{field[]:--flag} | فہرست والی فیلڈ کے ہر آئٹم کے لیے ایک --flag <item> جوڑا۔ |
{field?:--flag} | فیلڈ موجود ہو تو --flag <value>؛ غیر موجود ہو تو کچھ نہیں۔ |
{field:cents->dollars} | سینٹس میں ایک عددی رقم، ڈالرز کے طور پر لکھی ہوئی۔ |
جن ان پٹ فیلڈز کا ٹیمپلیٹ میں نام نہیں، وہ --field value کی صورت میں آخر میں جوڑ دی جاتی ہیں۔ فہرست اور اختیاری پلیس ہولڈرز پورے الفاظ ہونے چاہئیں۔ جس آپریشن کے لیے منظوری درکار ہو، اس تک وہی کمانڈ plugin__<slug> کے ذریعے چلا کر نہیں پہنچا جا سکتا۔
ہکس، سلیش کمانڈز اور روٹس
"capabilities": {
"hooks": [
{ "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
],
"commands": [
{ "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
],
"routes": [
{ "path": "/callback", "method": "GET", "command": "http callback" }
]
} ہکس
ہک ملازم کی باری کے کسی مقام پر آپ کی کمانڈ چلاتا ہے۔ Nebo ایک JSON پے لوڈ stdin پر لکھتا ہے۔ action ہک کا آؤٹ پٹ نظرانداز کیا جاتا ہے۔ filter ہک {"payload": ..., "handled": false} واپس کرتا ہے؛ "handled": true بعد کے ہکس کو روک دیتا ہے۔ خرابیوں اور ٹائم آؤٹس میں پچھلا پے لوڈ برقرار رہتا ہے اور یہ باری کو کبھی نہیں روکتے۔ لگاتار تین ناکامیوں کے بعد ہک پانچ منٹ کے لیے روک دیا جاتا ہے۔
| فیلڈ | طے شدہ | مطلب |
|---|---|---|
hook | لازمی | tool.pre_execute، tool.post_execute، message.post_receive، session.message_append، steering.generate، agent.turn، agent.should_continue میں سے ایک۔ |
hookType | "action" | action یا filter۔ |
command | لازمی | آپ کی بائنری کے لیے آرگیومنٹس۔ |
priority | 100 | کم قدر پہلے چلتی ہے۔ |
timeoutMs | 500 | ملی سیکنڈز میں وقت کی حد۔ |
کمانڈز
"slash": true کے ساتھ، چیٹ میں /name args لکھنے سے command args براہِ راست چلتی ہے، ملازم کے بغیر۔ آؤٹ پٹ ہی جواب ہوتا ہے۔ وقت کی حد 30 سیکنڈ ہے۔
روٹس
روٹ بوٹ پر /api/v1/plugins/<slug>/api/<path> پر آنے والی HTTP درخواستوں کا جواب دیتا ہے، جن کا ملان path اور method سے ہوتا ہے۔ درخواست کی باڈی stdin پر جاتی ہے اور آپ کا stdout جواب ہوتا ہے۔ وقت کی حد 30 سیکنڈ ہے۔
فراہم کنندگان
فراہم کنندہ چیٹ ماڈل کا ایک ذریعہ شامل کرتا ہے۔ id، displayName، providerType، modelsCommand اور chatCommand کا اعلان کریں۔ Nebo چیٹ کی درخواست JSON کی صورت میں stdin پر chatCommand کو بھیجتا ہے اور stdout پر نئی لائن سے الگ کیے گئے JSON کی صورت میں اسٹریم ہونے والے ایونٹس پڑھتا ہے، زیادہ سے زیادہ 300 سیکنڈ تک۔ آج صرف چیٹ اسٹریمنگ استعمال ہوتی ہے۔
چینل
چینل کسی میسجنگ سروس سے رابطہ جوڑتا ہے۔ Nebo command کو چلتا رکھتا ہے، اس کے stdout سے آنے والے پیغامات پڑھتا ہے اور اس کے stdin پر جوابات لکھتا ہے، دونوں نئی لائن سے الگ کیے گئے JSON کی صورت میں۔
| فیلڈ | طے شدہ | مطلب |
|---|---|---|
command | لازمی | آرگیومنٹس جو برج کو شروع کرتے ہیں۔ |
name, description | "" | ترتیبات میں دکھایا جاتا ہے۔ |
restartDelaySecs | 5 | کریش کے بعد دوبارہ شروع کرنے سے پہلے انتظار۔ |
shared | false | سب ملازمین کے لیے ایک برج؛ پیغامات ملازم کے نام سے روٹ ہوتے ہیں اور جوابات میں ہر ملازم کی شناخت شامل ہوتی ہے۔ |
needsLocalApi | false | برج کو بوٹ کا مقامی API پتہ، ایک ٹوکن اور ملازم کی id دیں۔ ضرورت نہ ہو تو بند رہتا ہے۔ |
سیٹ اپ
سیٹ اپ وزرڈ مالک کو ان مراحل سے گزارتا ہے جو ایک فارم میں نہیں سما سکتے۔ form مراحل کی قدریں بعد کے generate آرگیومنٹس میں {{key}} بھرتی ہیں۔ credentials مراحل کی قدریں پلگ ان کے انوائرنمنٹ ویری ایبلز کے طور پر محفوظ ہوتی ہیں۔
"setup": {
"title": "Connect Example Chat",
"steps": [
{ "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
{ "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
{ "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
{ "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
]
} | مرحلے کی قسم | فیلڈز |
|---|---|
form | title, description, fields |
generate | title، description، command، args، outputFormat (yaml، json، toml، text)، buttonLabel۔ کاپی کرنے کے لیے کمانڈ کا آؤٹ پٹ دکھاتا ہے۔ |
external | title, description, url, urlLabel, instructions |
credentials | title، description، fields، verifyCommand۔ مرحلہ تب مکمل ہوتا ہے جب verifyCommand کامیاب ہو جائے۔ |
فیلڈز میں key، label، default، placeholder، maxLength، help، inputType (text، textarea، password) اور required ہوتے ہیں۔