NeboAI
NeboAI
शुरू करें

प्लगइन

प्लगइन कर्मचारियों को काम करने के लिए कुछ देता है: कोई ऑनलाइन सेवा, कोई बिज़नेस सिस्टम, या कंप्यूटर पर कोई प्रोग्राम। आप इसे कमांड-लाइन बाइनरी के रूप में बनाते हैं और plugin.json मैनिफ़ेस्ट से इसका वर्णन करते हैं। कर्मचारी इसकी कमांड कॉल करते हैं, और Nebo इंस्टॉलेशन, हर कर्मचारी के अकाउंट और अपडेट संभालता है।

प्लगइन कैसे काम करते हैं

प्लगइन एक एक्ज़िक्यूटेबल और एक मैनिफ़ेस्ट है। 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 बन जाता है।
timeoutintegerइंतज़ार के सेकंड। डिफ़ॉल्ट 120, मैनिफ़ेस्ट के permissions.maxTimeoutSeconds तक सीमित।
displaystringवह वाक्य जो कॉल को मंज़ूरी की ज़रूरत होने पर मालिक देखता है।

अपना पहला प्लगइन बनाएँ

किसी भी भाषा में एक बाइनरी लिखें जो आर्ग्युमेंट से अपनी कमांड पढ़े और नतीजा प्रिंट करे। फिर उसे किसी बॉट की यूज़र प्लगइन डायरेक्टरी में एक 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 }
  ]
}
  1. auth.env क्रेडेंशियल के नाम बताता है। capabilities.configSchema उन्हें लेबल देता है और कनेक्ट फ़ॉर्म में उनका क्रम तय करता है।
  2. auth.profileDirEnv उस वेरिएबल का नाम बताता है जिसे आपका प्लगइन अपने क्रेडेंशियल फ़ोल्डर के लिए पढ़ता है। Nebo हर कर्मचारी और अकाउंट के लिए एक फ़ोल्डर बनाता है और हर कॉल पर वह वेरिएबल सेट करता है।
  3. जब मालिक कोई अकाउंट कनेक्ट करता है, तो Nebo आपकी login कमांड को मालिक के टाइप किए मानों और सेट किए गए अकाउंट फ़ोल्डर के साथ चलाता है। आपका प्लगइन जो ज़रूरी हो, उस फ़ोल्डर में सहेजता है। Nebo ये मान नहीं रखता।
  4. आपकी status कमांड {"authenticated": true} जैसा JSON प्रिंट करती है। जब कोई टोकन समाप्त हो जाता है, तो अगर आपने refresh घोषित किया है तो Nebo उसे चलाता है।

ब्राउज़र साइन-इन के लिए type को oauth_cli पर सेट करें और login से प्रोवाइडर का साइन-इन URL प्रिंट करवाएँ या खुलवाएँ। कर्मचारी कभी खुद साइन इन नहीं करते: जब किसी कॉल को लॉगिन चाहिए, तो मालिक को एक कनेक्ट कार्ड दिखता है। कई अकाउंट वाला कर्मचारी कमांड में --account <label> जोड़कर एक अकाउंट चुनता है। आपकी बाइनरी तक पहुँचने से पहले Nebo वह फ़्लैग हटा देता है।

सेवा का नाम लिखें, बनावट का नहीं। प्लगइन का नाम बताता है कि वह किससे जुड़ता है, जैसे "Example Notes"। प्लगइन के नाम में कभी "CLI" न लिखें; कर्मचारियों और मालिकों के लिए यह एक कनेक्शन है, कमांड लाइन नहीं।

आगे

  • plugin.json संदर्भ: हर फ़ील्ड, जिसमें इवेंट, हुक और टाइप किए गए ऑपरेशन शामिल हैं।
  • प्लगइन शिप करना: प्लेटफ़ॉर्म, बाइनरी, साइनिंग और अपडेट।
  • प्रकाशन: हर आर्टिफ़ैक्ट के लिए मार्केटप्लेस की प्रक्रिया।