NeboAI
NeboAI
सुरू करा

plugin.json संदर्भ

plugin.json हे मॅनिफेस्ट आहे जे Nebo प्लगइन इंस्टॉल करण्यासाठी आणि चालवण्यासाठी वाचते. की camelCase मध्ये असतात. हे पेज Nebo आज वाचत असलेले प्रत्येक फील्ड आणि ते काय करते याची यादी देते.

शीर्ष-स्तरीय फील्ड

फील्डप्रकारआवश्यकअर्थ
idstringहोयप्लगइनचा मार्केटप्लेस ओळखकर्ता. डेव्हलपमेंट करताना slug वापरा.
slugstringहोयस्थिर ओळखकर्ता. [a-z0-9-], जास्तीत जास्त 64 अक्षरे, सुरुवातीला, शेवटी किंवा दुहेरी हायफन नाही. plugin__<slug> टूल आणि <SLUG>_BIN व्हेरिएबलला नाव देतो.
namestringहोयदाखवले जाणारे नाव. ते ज्या सेवेशी जोडते तिचे नाव द्या.
versionstringहोयसिमँटिक व्हर्जन, जसे 0.1.0.
platformsmapहोयप्लॅटफॉर्म की ते बायनरी. Platforms पहा.
descriptionstringनाहीलोकांसाठी आणि कर्मचाऱ्यांसाठी एक वाक्य.
authorstringनाहीप्रकाशकाचे नाव.
categorystringनाहीकर्मचाऱ्यांना प्लगइन शोधायला मदत करते.
triggersस्ट्रिंगची यादीनाहीप्लगइन कधी लागू होतो याचे वर्णन करणारे शब्द. शोध सूचनांमध्ये वापरले जातात.
entrySkillsस्ट्रिंगची यादीनाहीप्लगइनच्या टूल वर्णनात आधी नमूद करायची बंडल केलेली कौशल्ये.
dependencies{name, version, optional} ची यादीनाहीहा प्लगइन चालवत असलेले इतर प्लगइन. version डीफॉल्ट "*" असते; optional डीफॉल्ट false. त्यांचे <SLUG>_BIN पाथ प्रत्येक कॉलवर सेट केले जातात.
authobjectनाहीसाइन-इन आणि खाती. Auth पहा.
capabilitiesobjectनाहीconfigSchema, hooks, commands, routes, providers.
permissionsobjectनाहीएन्व्हायर्नमेंट फिल्टरिंग आणि टाइमआउटची कमाल मर्यादा.
eventslistनाहीकर्मचाऱ्यांच्या वर्कफ्लोला माहिती पुरवणारे वॉचर.
interfaceBindingsmapनाहीप्लगइन पुरवत असलेल्या टाइप केलेल्या ऑपरेशन्स.
channelobjectनाहीमेसेजिंग सेवेशी कायमस्वरूपी ब्रिज.
setupobjectनाहीटप्प्याटप्प्याने चालणारा सेटअप विझार्ड.

Nebo मार्केटप्लेस इंस्टॉलची पडताळणी करते: slug नियम, सिमँटिक व्हर्जन, किमान एक प्लॅटफॉर्म, पाथ सेपरेटर किंवा .. नसलेले binaryName, auth.type हे env असल्याशिवाय एक login कमांड, रिकामी नसलेली इव्हेंट नावे आणि कमांड, आणि पार्स होणारे बाइंडिंग टेम्पलेट. युजर प्लगइन डिरेक्टरीतील प्लगइनची पडताळणी होत नाही.

प्लॅटफॉर्म

की 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बाइट्समधील आकार.
downloadUrlNebo पॅकेज कुठून डाउनलोड करते.

Auth

फील्डअर्थ
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 मध्येही सूचीबद्ध असलेल्या क्रेडेन्शियल कीसाठी, स्कीमा प्रत्येक कर्मचाऱ्याच्या कनेक्ट फॉर्ममधील फील्डना लेबल देते.

फील्डप्रकारडीफॉल्टअर्थ
keystringआवश्यकएन्व्हायर्नमेंट व्हेरिएबलचे नाव.
labelstringआवश्यकफील्ड लेबल.
descriptionstring""मदत मजकूर.
fieldTypestring"string"इनपुट प्रकार, जसे string, number, boolean, select किंवा password.
defaultstringकाहीही नाहीआधीच भरलेले मूल्य.
requiredbooleanfalseमूल्य सेट होईपर्यंत प्लगइन तयार नसतो.
secretbooleanfalseमूल्य परत वाचताना लपवले जाते.
optionsस्ट्रिंगची यादीकाहीही नाहीselect साठी पर्याय.

permissions

फील्डडीफॉल्टअर्थ
envAllow[]वारशाने मिळालेले जे व्हेरिएबल प्लगइन पाहू शकतो. रिकामे ठेवल्यास सर्व दिसतात.
envDeny[]वारशाने मिळालेले जे व्हेरिएबल नेहमी काढले जातात.
maxTimeoutSeconds300कोणत्याही कॉलच्या टाइमआउटची कमाल मर्यादा.
networkfalseनेटवर्क वापर जाहीर करते. केवळ माहितीसाठी; लागू केले जात नाही.

events

इव्हेंट हा दीर्घकाळ चालणारा वॉचर असतो. एखाद्या कर्मचाऱ्याचा वर्कफ्लो त्यावर लक्ष ठेवतो तेव्हा 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"
  }
]
फील्डअर्थ
nameslug शिवाय इव्हेंटचे नाव. आवश्यक.
commandवॉचर सुरू करणारे आर्ग्युमेंट. आवश्यक. {{key}} कर्मचाऱ्याच्या इनपुट मूल्यांनी बदलले जाते.
descriptionइव्हेंट कशामुळे घडतो.
multiplexedtrue असताना एकच वॉचर अनेक प्रकारचे इव्हेंट पाठवतो आणि प्रत्येक ओळीत "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" }
  ]
}

hooks

हुक कर्मचाऱ्याच्या टर्नमधील एखाद्या टप्प्यावर तुमची कमांड चालवतो. Nebo stdin वर JSON payload लिहिते. action हुकचे आउटपुट दुर्लक्षित केले जाते. filter हुक {"payload": ..., "handled": false} परत करतो; "handled": true पुढचे हुक थांबवते. त्रुटी आणि टाइमआउट आधीचे payload तसेच ठेवतात आणि टर्न कधीही अडवत नाहीत. सलग तीन अपयशांनंतर हुक पाच मिनिटांसाठी थांबवला जातो.

फील्डडीफॉल्टअर्थ
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आवश्यकतुमच्या बायनरीसाठी आर्ग्युमेंट.
priority100कमी असलेले आधी चालते.
timeoutMs500मिलिसेकंदांमधील वेळमर्यादा.

commands

"slash": true असल्यास, चॅटमध्ये /name args टाइप केल्यावर कर्मचाऱ्याशिवाय थेट command args चालते. आउटपुट हेच उत्तर असते. वेळमर्यादा 30 सेकंद आहे.

routes

रूट बॉटवरील /api/v1/plugins/<slug>/api/<path> येथे HTTP विनंत्यांना उत्तर देतो, path आणि method नुसार जुळवून. विनंतीचा बॉडी stdin वर जातो आणि तुमचा stdout हाच प्रतिसाद असतो. वेळमर्यादा 30 सेकंद आहे.

providers

प्रदाता चॅट मॉडेलचा एक स्रोत जोडतो. id, displayName, providerType, modelsCommand आणि chatCommand जाहीर करा. Nebo चॅट विनंती JSON म्हणून stdin वर chatCommand ला पाठवते आणि स्ट्रीम केलेले इव्हेंट stdout वर newline-delimited JSON म्हणून, 300 सेकंदांपर्यंत वाचते. आज फक्त चॅट स्ट्रीमिंग वापरले जाते.

channel

चॅनेल एखाद्या मेसेजिंग सेवेशी ब्रिज तयार करते. Nebo command चालू ठेवते, त्याच्या stdout मधून येणारे संदेश वाचते आणि उत्तरे त्याच्या stdin वर लिहिते, दोन्ही newline-delimited JSON म्हणून.

फील्डडीफॉल्टअर्थ
commandआवश्यकब्रिज सुरू करणारे आर्ग्युमेंट.
name, description""सेटिंग्जमध्ये दाखवले जाते.
restartDelaySecs5क्रॅशनंतर पुन्हा सुरू करण्यापूर्वी थांबण्याचा वेळ.
sharedfalseसर्व कर्मचाऱ्यांसाठी एकच ब्रिज; संदेश कर्मचाऱ्याच्या नावानुसार पोहोचवले जातात आणि उत्तरांमध्ये प्रत्येक कर्मचाऱ्याची ओळख असते.
needsLocalApifalseब्रिजला बॉटचा लोकल API पत्ता, एक टोकन आणि कर्मचाऱ्याचा id द्या. गरज असल्याशिवाय बंद.

setup

सेटअप विझार्ड मालकाला अशा पायऱ्यांमधून नेतो ज्या एका फॉर्ममध्ये बसत नाहीत. form पायऱ्यांमधील मूल्ये पुढच्या generate आर्ग्युमेंट्समधील {{key}} भरतात. credentials पायऱ्यांमधील मूल्ये प्लगइनचे environment variables म्हणून सेव्ह केली जातात.

"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" }
  ]
}
टप्प्याचा प्रकारफील्ड
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. कॉपी करण्यासाठी कमांडचे आउटपुट दाखवते.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. verifyCommand यशस्वी झाल्यावर टप्पा पूर्ण होतो.

फील्डमध्ये key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) आणि required असतात.