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; иесінің NeboAI токенін _TOKEN деп аяқталатын әр auth.env кілтінде алу үшін 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> арқылы шақырып қол жеткізу мүмкін емес.

Хуктар, slash-командалар және маршруттар

"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 чат сұрауын JSON ретінде stdin арқылы chatCommand командасына жібереді және ағынды оқиғаларды stdout-тан жаңа жолмен бөлінген JSON ретінде 300 секундқа дейін оқиды. Қазір тек чат ағыны пайдаланылады.

channel

Арна хабар алмасу қызметімен көпір жасайды. Nebo command командасын үздіксіз жұмыс күйінде ұстайды, кіріс хабарламаларды оның stdout-ынан оқиды және жауаптарды оның stdin-іне жазады, екеуі де жаңа жолмен бөлінген 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 бар.