Плагиндер қалай жұмыс істейді
Плагин — орындалатын файл мен манифест. Nebo шақырулар арасында плагин процесін жұмыс күйінде ұстамайды. Қызметкер плагинді пайдаланған сайын Nebo бинарлық файлды команда мен аргументтермен іске қосады, оның аяқталуын күтеді және шығысты қызметкерге қайтарады.
- Командалар — аргументтер. Қызметкер
notes searchсияқты команданы және аталған аргументтерді таңдайды. Nebo әр аргументті--name valueретінде береді. Shell жоқ, сондықтан құбырлар мен бағыттаулар ешқашан қолданылмайды. - Шығыс — 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 оны іске қосу кезінде оқымайды; бұл — адамдар орнатпас бұрын көретін бет. Плагинді шығару бөлімін қараңыз.
Орта
Әр шақыру жүктегіш және shell инъекциясы айнымалылары алынып тасталған бот ортасын мұралайды, содан кейін осы мәндерді қосады. Кейінгі жазбалар басым болады.
| Айнымалы | Мәні |
|---|---|
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 анықтамалығы: оқиғаларды, хуктарды және типтелген операцияларды қоса алғанда, әр өріс.
- Плагинді шығару: платформалар, бинарлық файлдар, қол қою және жаңартулар.
- Жариялау: әр туынды үшін маркетплейс процесі.