शीर्ष-स्तरीय फ़ील्ड
| फ़ील्ड | प्रकार | ज़रूरी | अर्थ |
|---|---|---|---|
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; _TOKEN पर खत्म होने वाली हर auth.env कुंजी में मालिक का NeboAI टोकन पाने के लिए 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 stdin पर एक JSON पेलोड लिखता है। 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 होते हैं।