NeboAI
NeboAI
Qallariy

plugin.json Referencia

plugin.jsonqa Nebo huk pluginta instalanapaq purichinapaqpas ñawinchasqan manifiestom. Llavekunaqa camelCasepim. Kay paginaqa kunan Nebo ñawinchasqan llapan campokunata, sapanka ima ruwasqantapas willan.

Hawa campokuna

CampoTipoMañakunNinan
idstringaríPluginpa Mercadopi riqsichiqnin. Ruwashaspaqa slugta llamk'achiy.
slugstringaríMana tikrakuq riqsichiq. [a-z0-9-], aswanqa 64 caracterkama, mana qallariypi, tukukuypi utaq iskay guionniyuqchu. plugin__<slug> llamk'anata hinaspa <SLUG>_BIN variableta sutichin.
namestringaríRikuchinapaq suti. T'inkisqan serviciota sutichiy.
versionstringaríSemántica versión, 0.1.0 hina.
platformsmaparíPlataforma llave binarioman. Plataformakuna nisqata qhaway.
descriptionstringmanaRunakunapaq llamk'aqkunapaqpas huk rimay.
authorstringmanaPublicaqpa sutin.
categorystringmanaLlamk'aqkunata pluginta tarinankupaq yanapan.
triggersstring listamanaPlugin hayk'aq yanapasqanta willaq simikuna. Maskaypi yanapanapaq llamk'achikun.
entrySkillsstring listamanaPluginpa llamk'ana willakuyninpi ñawpaqta sutichinapaq atiykuna.
dependencies{name, version, optional} listamanaKay plugin purichisqan huk pluginkuna. version mana churasqa kaptin "*"; optional false. Paykunapa <SLUG>_BIN ñankunaqa sapa waqyaypim churakun.
authobjectmanaYaykuy hinaspa cuentakuna. Auth nisqata qhaway.
capabilitiesobjectmanaconfigSchema, hooks, commands, routes, providers.
permissionsobjectmanaEntorno filtray hinaspa timeoutpa aswan hatun kaynin.
eventslistmanaLlamk'aqkunapa llamk'ay ñanninkunata mikhuchiq qhawaqkuna.
interfaceBindingsmapmanaPlugin quykusqan tipoyuq operacionkuna.
channelobjectmanaMensaje servicioman mana tukukuq chaka.
setupobjectmanaSapa pasomanta ruwana yanapaq.

Nebo Mercadomanta instalasqakunata qhawan: slugpa kamachiyninkuna, semántica versión, huk plataformapas, mana ñan rakiqniyuq nitaq ..niyuq binaryName, auth.type env mana kaptinqa login comando, mana ch'usaq evento sutikuna comandokunapas, allinta ñawinchakuq binding plantillakunapas. Usuariopa plugin carpetanpi kaq pluginkunaqa manam qhawasqachu kanku.

Plataformakuna

Llavekunaqa kaykunam: darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 hinaspa windows-amd64. Sapa entradaqa uraypi kaq pichqa campokunayuqmi. Publicaptiykiqa Mercadom chiqap hashta, sayayta, firmata, descarga URLtapas qillqan, chayrayku cargasqayki archivopiqa ch'usaqta saqiy.

"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": "" }
}
CampoNinan
binaryNamePurichikuq archivopa sutin. Windowspiqa .exe yapay.
sha256Binariopa hashnin. Instalaspa qhawakun.
signatureBinariopa firman. Firma llave kaptinqa instalaspa qhawakun.
sizeSayaynin byte-kunapi.
downloadUrlMaymanta Nebo paquetekunata descargan.

Auth

CampoNinan
typePlugin purichisqan navegadorpi yaykunapaq oauth_cli; valor hina qillqasqa credencialkunapaq env; _TOKEN-pi tukukuq sapa auth.env llavepi dueñopa NeboAI tokenninta chaskinapaq neboai.
envVariable sutimanta ñawpaqmanta valorman mapa. Nebo login-man pasachisqan credencial sutikunapas kaykunallam.
commands.loginYaykun. type env mana kaptinqa mañakunmi. Cuenta carpeta churasqawan purin.
commands.statusCuenta yaykusqachus kasqanta niq JSONta qillqan.
commands.refreshMana tapukuspa tokenta musuqyachin.
commands.logoutLluqsin. Dueñolla purichiyta atin.
profileDirEnvSapa llamk'aqpaq sapa cuentapaqpas sapaq credencial carpetata chaskiq variable. Mana kaptinqa pluginqa huk rakinakusqa cuentallatam hap'in.
label, descriptionT'inkiy tarjetapi qillqa.
helpT'inkishaspa rikuchisqa {url, urlLabel, text}.
publicRedirectProveedor http://localhost redirecciónkunata mana chaskiptin true churay; chaypachaqa yaykuyqa NeboAIpa público redirecciónnintam pasan.

Nebo estado lluqsiypi kaykunamanta ñawpaq kaqtam ñawinchan: authenticated, isAuthenticated, logged_in, loggedIn utaq token_valid. Mana ch'usaq token_error, utaq credential_source, auth_method, storage utaq status-pi none valor kaptinqa, lluqsisqa ninanmi. Estado comandoqa 45 segundoyuqmi.

{"authenticated": true, "account": "finance@example.com"}

configSchema

capabilities.configSchema dueño pluginpaq churasqan valorkunata willan. Sapa valormi binarioman key-wan sutichasqa entorno variable hina chayan. auth.env-pipas kaq credencial llavekunapaqqa, schemam sapa llamk'aqpaq t'inkiy formulariopa campokunata sutichan.

CampoTipoÑawpaqmantaNinan
keystringmañakunEntorno variablepa sutin.
labelstringmañakunCampopa sutin.
descriptionstring""Yanapa qillqa.
fieldTypestring"string"Yaykuy tipo, string, number, boolean, select utaq password hina.
defaultstringmana imapasÑawpaqmanta hunt'asqa valor.
requiredbooleanfalseValor mana churasqa kaptinqa pluginqa manam listochu.
secretbooleanfalseKutichispa ñawinchaptinqa valorqa pakasqam.
optionsstring listamana imapasselect-paq akllanakuna.

permissions

CampoÑawpaqmantaNinan
envAllow[]Plugin rikunan herenciamanta variablekuna. Ch'usaq kaptinqa llapantam saqin.
envDeny[]Herenciamanta chayamuq variablekuna, sapa kutim hurqusqa.
maxTimeoutSeconds300Mayqin waqyaypa timeoutninpa aswan hatun kaynin.
networkfalseRed llamk'achiyta willan. Willakuyllapaqmi; manam kamachikunchu.

events

Eventoqa unay purinan qhawaqmi. Nebo qallarichin huk llamk'aqpa llamk'ay ñannin qhawaptin, lluqsiptintaq yapamanta qallarichin. Qhawaq stdoutman qillqasqan sapa siqiqa huk eventom. Purichispa evento sutipa ñawpaqninmanmi slug churakun, chayrayku note.created notes-sync.note.created tukun.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
CampoNinan
nameEvento suti, mana slugniyuq. Mañakun.
commandQhawaqta qallarichiq argumentokuna. Mañakun. {{key}}-qa llamk'aqpa yaykuy valorninkunawan tikrakun.
descriptionEventota ima paqarichisqan.
multiplexedtrue kaptinqa, huk qhawaqmi achka evento tipokunata lluqsichin, sapa siqitaq "event" campoyuq.

Llamk'ay ñankunaqa watch qallarichiqwan eventokunaman suscribikunku. Qallarichiqkuna nisqata qhaway.

interfaceBindings

Huk bindingqa interfazpa operacionninta comandoykikunamanta hukninman tupachin. Sapa bindingmi llamk'aqkunapaq tipoyuq llamk'ana tukun, operacionpa sutinwan uchuy letrakunapi, puntokuna guionkunapas subrayado hina: notes.search notes_search tukun. Bindingkunawanmi pluginqa llamk'aq mañakusqan kallpakunata hunt'an; Kallpakuna nisqata qhaway.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
MarcadorKayman mast'arikun
{field}Campopa valorninqa huk simi hinam. Campoqa manam flag hinapas pasachikunchu.
{field[]:--flag}Lista campopi sapa imapaq huk --flag <item> par.
{field?:--flag}Campo kaptin --flag <value>; mana kaptin mana imapas.
{field:cents->dollars}Centavokunapi entero qullqi, dólarkunapi qillqasqa.

Plantilla mana sutichasqan yaykuy campokunaqa --field value hina qhipaman yapakunku. Lista hinaspa munaspalla placeholderkunaqa hunt'asqa simikunam kananku. Aprobacionta mañakuq operacionmanqa manam chayakunchu chay kikin comandota plugin__<slug>-wan waqyaspa.

Hookkuna, slash comandokuna, ñankunapas

"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

Huk hookqa comandoykitam purichin huk llamk'aqpa turnonpa huk pachanpi. Neboqa stdinmanmi huk JSON payloadta qillqan. Huk action hookpa lluqsisqanqa mana qhawasqam. Huk filter hookqa {"payload": ..., "handled": false} nisqatam kutichin; "handled": true nisqaqa qhipa hookkunatam sayachin. Errorkuna, timeoutkunapas ñawpaq payloadtam waqaychanku, manataq hayk'aqpas turnota hark'ankuchu. Qatiqnin kimsa kuti mana allin kaptinqa, huk hookqa pichqa minutopaqmi sayachisqa.

CampoÑawpaqmantaNinan
hookmañakunKaykunamanta huk: tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action utaq filter.
commandmañakunBinarioykipaq argumentokuna.
priority100Aswan uchuymi ñawpaqta purin.
timeoutMs500Milisegundokunapi tiempo limite.

commands

"slash": true kaptinqa, chatpi /name args qillqaspa command args-ta chiqaplla purichinki, mana llamk'aqwanchu. Lluqsiqmi kutichiy. Tiempo limiteqa 30 segundom.

routes

Huk ñanqa botpi /api/v1/plugins/<slug>/api/<path>-pi HTTP mañakuykunata kutichin, path hinaspa method-wan tupachisqa. Mañakuypa ukhunqa stdinmanmi rin, stdoutniykitaq kutichiy. Tiempo limiteqa 30 segundom.

providers

Huk proveedorqa chat modelo pukyuta yapan. Kaykunata willay: id, displayName, providerType, modelsCommand hinaspa chatCommand. Nebo chat mañakuyta JSON hina stdinpi chatCommand-man kachan, stdoutpitaq siqi siqimanta JSON eventokunata ñawinchan, 300 segundokama. Kunanqa chat streamingllam llamk'achikun.

channel

Huk canalqa mensaje servicioman chakan. Nebo command-ta purishaqta waqaychan, stdoutninmanta chayamuq mensajekunata ñawinchan, stdinninmantaq kutichiykunata qillqan, iskayninkupas siqi siqimanta JSON hina.

CampoÑawpaqmantaNinan
commandmañakunChakata qallarichiq argumentokuna.
name, description""Ajustekunapi rikuchisqa.
restartDelaySecs5Pakikuptin manaraq yapamanta qallarishaspa suyay.
sharedfalseLlapan llamk'aqkunapaq huk chakalla; mensajekunaqa llamk'aqpa sutinwanmi pusakunku, kutichiykunataq sapa llamk'aqpa riqsichiyninta apanku.
needsLocalApifalseChakaman botpa local API direccionninta, huk tokenta, llamk'aqpa idnintapas quy. Mana necesitaspaqa wañusqam.

setup

Huk setup wizardqa dueñotam pasokunapi pusan, huk sapallan forma mana atisqan kaqkunapi. form pasokunamanta valorkunaqa qhipa generate argumentokunapim {{key}} nisqata hunt'anku. credentials pasokunamanta valorkunaqa pluginpa entorno variablenkuna hinam waqaychakunku.

"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" }
  ]
}
Paso tipoCampokuna
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Copianapaq comandopa lluqsisqanta rikuchin.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. verifyCommand allinta lluqsiptinmi pasoqa tukukun.

Campokunaqa kaykunayuqmi: key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) hinaspa required.