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হ্যাঁপ্ল্যাটফর্ম কী থেকে বাইনারির ম্যাপ। প্ল্যাটফর্ম দেখুন।
descriptionstringনামানুষ ও কর্মীদের জন্য এক বাক্যের বর্ণনা।
authorstringনাপ্রকাশকের নাম।
categorystringনাকর্মীদের প্লাগইনটি খুঁজে পেতে সাহায্য করে।
triggersস্ট্রিংয়ের তালিকানাপ্লাগইনটি কখন প্রযোজ্য তা বোঝায় এমন শব্দ। সার্চের ইঙ্গিতে ব্যবহৃত হয়।
entrySkillsস্ট্রিংয়ের তালিকানাপ্লাগইনের টুল বর্ণনায় প্রথমে যেসব বান্ডেল করা দক্ষতার নাম থাকবে।
dependencies{name, version, optional}-এর তালিকানাএই প্লাগইনটি অন্য যেসব প্লাগইন চালায়। version-এর ডিফল্ট "*"; optional-এর ডিফল্ট false। প্রতিটি কলে এদের <SLUG>_BIN পাথ সেট করা হয়।
authobjectনাসাইন-ইন ও অ্যাকাউন্ট। অথেনটিকেশন দেখুন।
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 যেখান থেকে প্যাকেজটি ডাউনলোড করে।

অথেনটিকেশন

ফিল্ডঅর্থ
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 পেলোড লেখে। 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আবশ্যকআপনার বাইনারির আর্গুমেন্ট।
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 stdin-এ JSON হিসেবে একটি চ্যাট অনুরোধ chatCommand-এ পাঠায় এবং সর্বোচ্চ 300 সেকেন্ড পর্যন্ত stdout-এ newline-delimited JSON হিসেবে স্ট্রিম হওয়া ইভেন্ট পড়ে। আজ কেবল চ্যাট স্ট্রিমিং ব্যবহৃত হয়।

channel

একটি চ্যানেল একটি মেসেজিং সার্ভিসের সাথে ব্রিজ তৈরি করে। Nebo command চালু রাখে, এর stdout থেকে আসা মেসেজ পড়ে এবং এর stdin-এ উত্তর লেখে, দুটোই newline-delimited JSON হিসেবে।

ফিল্ডডিফল্টঅর্থ
commandআবশ্যকযে আর্গুমেন্টগুলো দিয়ে ব্রিজ চালু হয়।
name, description""সেটিংসে দেখানো হয়।
restartDelaySecs5ক্র্যাশের পর আবার চালু করার আগে অপেক্ষার সময়।
sharedfalseসব কর্মীর জন্য একটি ব্রিজ; মেসেজগুলো কর্মীর নাম অনুযায়ী রুট হয় এবং উত্তরে প্রতিটি কর্মীর নিজস্ব পরিচয় থাকে।
needsLocalApifalseব্রিজকে বটের লোকাল API ঠিকানা, একটি টোকেন এবং কর্মীর আইডি দেয়। প্রয়োজন না হলে বন্ধ থাকে।

setup

সেটআপ উইজার্ড মালিককে এমন ধাপগুলো দিয়ে এগিয়ে নেয়, যা একটি মাত্র ফর্মে সম্ভব নয়। 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" }
  ]
}
ধাপের ধরনফিল্ড
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।