प्लगइन कसे काम करतात
प्लगइन म्हणजे एक्झिक्यूटेबल आणि मॅनिफेस्ट. 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 | स्ट्रिंग, आवश्यक | प्लगइन कमांड आणि कोणतेही स्थानदर्शक शब्द. |
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 slug नावाची बायनरी आधी plugin.json च्या शेजारी, मग 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कमांड{"authenticated": true}सारखे JSON प्रिंट करते. टोकनची मुदत संपल्यावर, तुम्हीrefreshघोषित केले असल्यास Nebo ते चालवते.
ब्राउझर साइन-इनसाठी type ला oauth_cli सेट करा आणि login ने प्रदात्याची साइन-इन URL प्रिंट करावी किंवा उघडावी. कर्मचारी कधीही स्वतःहून साइन इन करत नाहीत: एखाद्या कॉलला लॉगिन लागते तेव्हा मालकाला कनेक्ट कार्ड दिसते. अनेक खाती असलेला कर्मचारी कमांडमध्ये --account <label> जोडून एक खाते निवडतो. तुमच्या बायनरीला दिसण्यापूर्वी Nebo तो फ्लॅग काढून टाकते.
सेवेचे नाव द्या, स्वरूपाचे नाही. प्लगइनचे नाव ते कशाशी जोडते ते सांगते, जसे "Example Notes". प्लगइनच्या नावात कधीही "CLI" लिहू नका; कर्मचारी आणि मालकांसाठी ते एक कनेक्शन आहे, कमांड लाइन नाही.
पुढे
- plugin.json संदर्भ: इव्हेंट, हुक आणि टाइप केलेल्या ऑपरेशन्ससह प्रत्येक फील्ड.
- प्लगइन शिप करणे: प्लॅटफॉर्म, बायनरी, साइनिंग आणि अपडेट.
- प्रकाशन: प्रत्येक आर्टिफॅक्टसाठी मार्केटप्लेसची प्रक्रिया.