প্লাগইন কীভাবে কাজ করে
একটি প্লাগইন হলো একটি এক্সিকিউটেবল ও একটি ম্যানিফেস্ট। দুটি কলের মাঝে 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 প্রথমে plugin.json-এর পাশে slug নামের একটি বাইনারি খোঁজে, তারপর 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কমান্ড JSON প্রিন্ট করে, যেমন{"authenticated": true}। কোনো টোকেনের মেয়াদ শেষ হলে, আপনিrefreshঘোষণা করে থাকলে Nebo সেটি চালায়।
ব্রাউজার সাইন-ইনের জন্য type-কে oauth_cli সেট করুন এবং login যেন প্রোভাইডারের সাইন-ইন URL প্রিন্ট করে বা খোলে। কর্মীরা কখনো নিজে সাইন ইন করে না: কোনো কলে লগইন দরকার হলে মালিক একটি কানেক্ট কার্ড দেখেন। কয়েকটি অ্যাকাউন্ট আছে এমন কর্মী কমান্ডে --account <label> যোগ করে একটি বেছে নেয়। আপনার বাইনারি দেখার আগেই Nebo ফ্ল্যাগটি সরিয়ে দেয়।
সার্ভিসের নাম দিন, গঠনের নয়। প্লাগইনের নাম বলে এটি কীসের সাথে সংযোগ করে, যেমন "Example Notes"। প্লাগইনের নামে কখনো "CLI" রাখবেন না; কর্মী ও মালিকদের কাছে এটি একটি সংযোগ, কমান্ড লাইন নয়।
এরপর
- plugin.json রেফারেন্স: ইভেন্ট, হুক ও টাইপড অপারেশনসহ প্রতিটি ফিল্ড।
- প্লাগইন প্রকাশ করা: প্ল্যাটফর্ম, বাইনারি, সাইনিং ও আপডেট।
- প্রকাশ করা: প্রতিটি আর্টিফ্যাক্টের জন্য মার্কেটপ্লেসের প্রক্রিয়া।