NeboAI
NeboAI
Magsimula

Reference ng plugin.json

Ang plugin.json ang manifest na binabasa ng Nebo para mag-install at magpatakbo ng plugin. Naka-camelCase ang mga key. Nakalista sa page na ito ang bawat field na binabasa ng Nebo ngayon at kung ano ang ginagawa ng bawat isa.

Mga top-level na field

FieldUriKailanganKahulugan
idstringooAng identifier ng plugin sa marketplace. Gamitin ang slug habang nagde-develop.
slugstringooMatatag na identifier. [a-z0-9-], hanggang 64 character, walang gitling sa simula, sa dulo o magkasunod. Pinapangalanan nito ang tool na plugin__<slug> at ang variable na <SLUG>_BIN.
namestringooDisplay name. Pangalanan ang service na kinokonekta nito.
versionstringooSemantic version, gaya ng 0.1.0.
platformsmapooPlatform key papunta sa binary. Tingnan ang Platforms.
descriptionstringhindiIsang pangungusap para sa mga tao at mga empleyado.
authorstringhindiPangalan ng publisher.
categorystringhindiTumutulong sa mga empleyado na mahanap ang plugin.
triggerslistahan ng mga stringhindiMga salitang naglalarawan kung kailan angkop ang plugin. Ginagamit sa mga search hint.
entrySkillslistahan ng mga stringhindiMga kasamang skill na unang babanggitin sa tool description ng plugin.
dependencieslistahan ng {name, version, optional}hindiIba pang plugin na pinapatakbo nito. Default ng version ang "*"; ng optional ang false. Itinatakda ang mga <SLUG>_BIN path nila sa bawat tawag.
authobjecthindiSign-in at mga account. Tingnan ang Auth.
capabilitiesobjecthindiconfigSchema, hooks, commands, routes, providers.
permissionsobjecthindiPag-filter ng environment at ang pinakamataas na timeout.
eventslisthindiMga watcher na nagpapakain sa mga workflow ng empleyado.
interfaceBindingsmaphindiMga typed operation na ibinibigay ng plugin.
channelobjecthindiIsang tuloy-tuloy na tulay papunta sa isang messaging service.
setupobjecthindiIsang hakbang-hakbang na setup wizard.

Vina-validate ng Nebo ang mga install mula sa marketplace: ang mga patakaran sa slug, isang semantic version, kahit isang platform, isang binaryName na walang path separator o .., isang login command maliban kung env ang auth.type, mga event name at command na hindi blangko, at mga binding template na napa-parse. Hindi dumadaan sa validation ang mga plugin sa user plugins directory.

Mga platform

Ang mga key ay darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 at windows-amd64. Bawat entry ay may lahat ng limang field sa ibaba. Kapag nag-publish ka, ang marketplace ang sumusulat ng totoong hash, size, signature at download URL, kaya iwan mong blangko ang mga ito sa file na ia-upload mo.

"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": "" }
}
FieldKahulugan
binaryNameAng file name ng executable. Dagdagan ng .exe sa Windows.
sha256Hash ng binary. Sinusuri sa pag-install.
signatureSignature ng binary. Sinusuri sa pag-install kapag may available na signing key.
sizeLaki sa bytes.
downloadUrlKung saan dina-download ng Nebo ang package.

Auth

FieldKahulugan
typeoauth_cli para sa browser sign-in na pinapatakbo ng plugin; env para sa mga credential na inilalagay bilang value; neboai para matanggap ang NeboAI token ng may-ari sa bawat auth.env key na nagtatapos sa _TOKEN.
envMap ng variable name papunta sa default value. Ito rin ang tanging mga credential name na ipinapasa ng Nebo sa login.
commands.loginNagsa-sign in. Kailangan maliban kung env ang type. Tumatakbo nang nakatakda ang account folder.
commands.statusNagpi-print ng JSON na nagsasabi kung naka-sign in ang account.
commands.refreshNire-renew ang token nang walang interaksyon.
commands.logoutNagsa-sign out. Ang may-ari lang ang makakapagpatakbo nito.
profileDirEnvVariable na tumatanggap ng hiwalay na credential folder para sa bawat empleyado at account. Kung wala ito, iisang shared account lang ang hawak ng plugin.
label, descriptionText sa connect card.
help{url, urlLabel, text} na ipinapakita habang kumokonekta.
publicRedirectItakda sa true kapag tumatanggi ang provider sa mga http://localhost redirect; dadaan ang sign-in sa public redirect ng NeboAI.

Binabasa ng Nebo ang una sa authenticated, isAuthenticated, logged_in, loggedIn o token_valid sa status output. Ang hindi blangkong token_error, o ang value na none sa credential_source, auth_method, storage o status, ay nangangahulugang naka-sign out. May 45 segundo ang status command.

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

configSchema

Inilalarawan ng capabilities.configSchema ang mga value na itinatakda ng may-ari para sa plugin. Bawat value ay umaabot sa binary bilang environment variable na pinangalanan ng key. Para sa mga credential key na nakalista rin sa auth.env, nilalagyan ng schema ng label ang mga field ng connect form ng bawat empleyado.

FieldUriDefaultKahulugan
keystringkailanganPangalan ng environment variable.
labelstringkailanganLabel ng field.
descriptionstring""Help text.
fieldTypestring"string"Uri ng input, gaya ng string, number, boolean, select o password.
defaultstringwalaValue na nakapaunang nakalagay.
requiredbooleanfalseHindi pa handa ang plugin hangga't hindi naitatakda ang value.
secretbooleanfalseNaka-mask ang value kapag binasa ulit.
optionslistahan ng mga stringwalaMga pagpipilian para sa select.

permissions

FieldDefaultKahulugan
envAllow[]Mga minanang variable na puwedeng makita ng plugin. Kapag blangko, pinapayagan lahat.
envDeny[]Mga minanang variable na laging inaalis.
maxTimeoutSeconds300Pinakamataas na limit para sa timeout ng kahit anong tawag.
networkfalseIdinedeklara ang paggamit ng network. Pang-impormasyon lang; hindi ipinapatupad.

events

Ang event ay isang watcher na matagal tumatakbo. Sinisimulan ito ng Nebo kapag binabantayan ito ng workflow ng isang empleyado, at sinisimulan ulit kapag huminto ito. Bawat linyang isinusulat ng watcher sa stdout ay isang event. Dinadagdagan ng slug sa unahan ang event name habang tumatakbo, kaya nagiging notes-sync.note.created ang note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
FieldKahulugan
namePangalan ng event, nang walang slug. Kailangan.
commandMga argument na nagsisimula sa watcher. Kailangan. Pinapalitan ang {{key}} mula sa mga input value ng empleyado.
descriptionKung ano ang nagdudulot ng event.
multiplexedKapag true, isang watcher ang naglalabas ng ilang uri ng event at may field na "event" ang bawat linya.

Nagsu-subscribe ang mga workflow sa mga event gamit ang watch trigger. Tingnan ang Triggers.

interfaceBindings

Ikinakabit ng binding ang isang interface operation sa isa sa mga command mo. Nagiging typed tool para sa mga empleyado ang bawat binding, na pinangalanan ayon sa operation sa lowercase at ginawang underscore ang mga tuldok at gitling: nagiging notes_search ang notes.search. Sa pamamagitan ng mga binding natutugunan ng plugin ang mga capability na kailangan ng isang empleyado; tingnan ang Capabilities.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
PlaceholderNagiging
{field}Ang value ng field bilang isang salita. Hindi na rin ipinapasa ang field bilang flag.
{field[]:--flag}Isang pares na --flag <item> para sa bawat item sa isang list field.
{field?:--flag}--flag <value> kapag naroon ang field; wala kapag wala ito.
{field:cents->dollars}Isang integer na halaga sa cents, isinusulat bilang dollars.

Ang mga input field na hindi binabanggit ng template ay idinudugtong bilang --field value. Dapat buong salita ang mga list at optional na placeholder. Hindi maaabot ang isang operation na nangangailangan ng approval sa pagtawag sa parehong command sa pamamagitan ng plugin__<slug>.

Hooks, slash commands at routes

"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

Pinapatakbo ng hook ang command mo sa isang punto ng turn ng empleyado. Nagsusulat ang Nebo ng JSON payload sa stdin. Binabalewala ang output ng action hook. Nagbabalik ang filter hook ng {"payload": ..., "handled": false}; pinahihinto ng "handled": true ang mga susunod na hook. Pinapanatili ng mga error at timeout ang naunang payload at hindi kailanman hinaharangan ang turn. Pagkatapos ng tatlong sunod-sunod na pagpalya, naka-pause ang hook nang limang minuto.

FieldDefaultKahulugan
hookkailanganIsa sa tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action o filter.
commandkailanganMga argument para sa binary mo.
priority100Mas mababa, mas naunang tumatakbo.
timeoutMs500Limit ng oras sa milliseconds.

commands

Kapag "slash": true, ang pag-type ng /name args sa chat ay direktang nagpapatakbo ng command args, nang hindi dumadaan sa empleyado. Ang output ang sagot. 30 segundo ang limit ng oras.

routes

Sumasagot ang isang route sa mga HTTP request sa /api/v1/plugins/<slug>/api/<path> sa bot, tinutugma ayon sa path at method. Napupunta sa stdin ang request body at ang stdout mo ang response. 30 segundo ang limit ng oras.

providers

Nagdadagdag ang provider ng pinagmumulan ng chat model. Ideklara ang id, displayName, providerType, modelsCommand at chatCommand. Nagpapadala ang Nebo ng chat request bilang JSON sa stdin papunta sa chatCommand at nagbabasa ng mga streamed event bilang newline-delimited JSON sa stdout, nang hanggang 300 segundo. Chat streaming lang ang ginagamit sa ngayon.

channel

Ikinokonekta ng channel ang isang messaging service. Pinapanatiling tumatakbo ng Nebo ang command, binabasa ang mga papasok na mensahe mula sa stdout nito at isinusulat ang mga sagot sa stdin nito, parehong bilang newline-delimited JSON.

FieldDefaultKahulugan
commandkailanganMga argument na nagsisimula sa bridge.
name, description""Ipinapakita sa settings.
restartDelaySecs5Paghihintay bago mag-restart pagkatapos ng crash.
sharedfalseIsang bridge para sa lahat ng empleyado; niru-route ang mga mensahe ayon sa pangalan ng empleyado at dala ng mga sagot ang pagkakakilanlan ng bawat empleyado.
needsLocalApifalseIbigay sa bridge ang lokal na API address ng bot, isang token at ang employee id. Naka-off maliban kung kailangan mo ito.

setup

Ginagabayan ng setup wizard ang may-ari sa mga hakbang na hindi kaya ng iisang form. Pinupunan ng mga value mula sa mga hakbang na form ang {{key}} sa mga susunod na argument ng generate. Sine-save bilang mga environment variable ng plugin ang mga value mula sa mga hakbang na 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" }
  ]
}
Uri ng hakbangMga field
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Ipinapakita ang output ng command para makopya.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Nakukumpleto ang hakbang kapag nagtagumpay ang verifyCommand.

May key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) at required ang mga field.