NeboAI
NeboAI
Kom igång

plugin.json-referens

plugin.json är manifestet som Nebo läser för att installera och köra ett plugin. Nycklarna skrivs i camelCase. Den här sidan listar varje fält som Nebo läser i dag och vad vart och ett gör.

Fält på toppnivå

FältTypObligatorisktBetydelse
idstringjaPluginets identifierare på marknadsplatsen. Använd slug-värdet under utvecklingen.
slugstringjaStabil identifierare. [a-z0-9-], högst 64 tecken, inget inledande, avslutande eller dubbelt bindestreck. Namnger verktyget plugin__<slug> och variabeln <SLUG>_BIN.
namestringjaVisningsnamn. Ange tjänsten det ansluter till.
versionstringjaSemantisk version, till exempel 0.1.0.
platformsmapjaPlattformsnyckel till binärfil. Se Plattformar.
descriptionstringnejEn mening för människor och medarbetare.
authorstringnejUtgivarens namn.
categorystringnejHjälper medarbetare att hitta pluginet.
triggerslista med strängarnejOrd som beskriver när pluginet är aktuellt. Används i söktips.
entrySkillslista med strängarnejMedföljande färdigheter att nämna först i pluginets verktygsbeskrivning.
dependencieslista med {name, version, optional}nejAndra plugins som det här kör. version är som standard "*"; optional är false. Deras sökvägar <SLUG>_BIN sätts vid varje anrop.
authobjectnejInloggning och konton. Se Autentisering.
capabilitiesobjectnejconfigSchema, hooks, commands, routes, providers.
permissionsobjectnejMiljöfiltrering och övre gräns för tidsgränsen.
eventslistnejBevakare som matar medarbetarnas arbetsflöden.
interfaceBindingsmapnejTypade operationer som pluginet tillhandahåller.
channelobjectnejEn beständig brygga till en meddelandetjänst.
setupobjectnejEn installationsguide steg för steg.

Nebo validerar installationer från marknadsplatsen: slug-reglerna, en semantisk version, minst en plattform, ett binaryName utan sökvägsavgränsare eller .., ett login-kommando om inte auth.type är env, händelsenamn och kommandon som inte är tomma, och bindningsmallar som går att tolka. Plugins i användarens plugin-katalog hoppar över valideringen.

Plattformar

Nycklarna är darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 och windows-amd64. Varje post har alla fem fälten nedan. När du publicerar skriver marknadsplatsen in den riktiga hashen, storleken, signaturen och nedladdningsadressen, så lämna dem tomma i filen du laddar upp.

"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": "" }
}
FältBetydelse
binaryNameDen körbara filens namn. Lägg till .exe på Windows.
sha256Binärfilens hash. Kontrolleras vid installation.
signatureBinärfilens signatur. Kontrolleras vid installation när en signeringsnyckel finns.
sizeStorlek i byte.
downloadUrlVar Nebo laddar ner paketet.

Autentisering

FältBetydelse
typeoauth_cli för en webbläsarinloggning som pluginet kör; env för inloggningsuppgifter som anges som värden; neboai för att få ägarens NeboAI-token i varje auth.env-nyckel som slutar på _TOKEN.
envMappning från variabelnamn till standardvärde. Också de enda namn på inloggningsuppgifter som Nebo skickar till login.
commands.loginLoggar in. Obligatoriskt om inte type är env. Körs med kontomappen angiven.
commands.statusSkriver ut JSON som anger om kontot är inloggat.
commands.refreshFörnyar en token utan interaktion.
commands.logoutLoggar ut. Bara ägaren kan köra det.
profileDirEnvVariabel som får en separat mapp för inloggningsuppgifter för varje medarbetare och konto. Utan den har pluginet ett enda delat konto.
label, descriptionText på anslutningskortet.
help{url, urlLabel, text} som visas under anslutningen.
publicRedirectSätt true när leverantören vägrar omdirigeringar till http://localhost; inloggningen går då via NeboAI:s publika omdirigering.

Nebo läser det första av authenticated, isAuthenticated, logged_in, loggedIn eller token_valid i statusutdata. En token_error som inte är tom, eller värdet none i credential_source, auth_method, storage eller status, betyder utloggad. Statuskommandot har 45 sekunder på sig.

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

configSchema

capabilities.configSchema beskriver de värden en ägare anger för pluginet. Varje värde når binärfilen som en miljövariabel med det namn som key anger. För nycklar för inloggningsuppgifter som också listas i auth.env sätter schemat etiketter på fälten i anslutningsformuläret per medarbetare.

FältTypStandardBetydelse
keystringobligatorisktMiljövariabelns namn.
labelstringobligatorisktFältets etikett.
descriptionstring""Hjälptext.
fieldTypestring"string"Inmatningstyp, till exempel string, number, boolean, select eller password.
defaultstringingetFörifyllt värde.
requiredbooleanfalsePluginet är inte redo förrän värdet är angivet.
secretbooleanfalseVärdet maskeras när det läses tillbaka.
optionslista med strängaringetVal för select.

permissions

FältStandardBetydelse
envAllow[]Ärvda variabler som pluginet får se. Tomt tillåter alla.
envDeny[]Ärvda variabler som alltid tas bort.
maxTimeoutSeconds300Övre gräns för alla anrops tidsgräns.
networkfalseAnger nätverksanvändning. Informativt; tillämpas inte.

events

En händelse är en långvarig bevakare. Nebo startar den när en medarbetares arbetsflöde bevakar den, och startar om den om den avslutas. Varje rad bevakaren skriver till stdout är en händelse. Händelsenamnet får slug-värdet som prefix vid körning, så note.created blir notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
FältBetydelse
nameHändelsenamn, utan slug-värdet. Obligatoriskt.
commandArgument som startar bevakaren. Obligatoriskt. {{key}} ersätts med medarbetarens indatavärden.
descriptionVad som utlöser händelsen.
multiplexedNär true sänder en bevakare flera händelsetyper och varje rad har ett "event"-fält.

Arbetsflöden prenumererar på händelser med en watch-utlösare. Se Utlösare.

interfaceBindings

En bindning kopplar en gränssnittsoperation till ett av dina kommandon. Varje bindning blir ett typat verktyg för medarbetare, namngivet efter operationen med gemener och med punkter och bindestreck som understreck: notes.search blir notes_search. Bindningar är hur ett plugin uppfyller de förmågor som en medarbetare kräver; se Förmågor.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
PlatshållareExpanderas till
{field}Fältets värde som ett ord. Fältet skickas inte också som flagga.
{field[]:--flag}Ett --flag <item>-par för varje objekt i ett listfält.
{field?:--flag}--flag <value> när fältet finns; ingenting när det saknas.
{field:cents->dollars}Ett heltalsbelopp i cent, skrivet som dollar.

Indatafält som en mall inte namnger läggs till som --field value. List- och valfria platshållare måste vara hela ord. En operation som kräver godkännande går inte att nå genom att anropa samma kommando via plugin__<slug>.

Hooks, snedstreckskommandon och 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

En hook kör ditt kommando vid en viss punkt i en medarbetares tur. Nebo skriver en JSON-nyttolast till stdin. Utdata från en action-hook ignoreras. En filter-hook returnerar {"payload": ..., "handled": false}; "handled": true stoppar senare hooks. Fel och timeouts behåller den föregående nyttolasten och blockerar aldrig turen. Efter tre misslyckanden i rad pausas en hook i fem minuter.

FältStandardBetydelse
hookobligatorisktEn av tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action eller filter.
commandobligatorisktArgument till din binärfil.
priority100Lägre körs först.
timeoutMs500Tidsgräns i millisekunder.

commands

Med "slash": true kör /name args i chatten command args direkt, utan medarbetaren. Utdata är svaret. Tidsgränsen är 30 sekunder.

routes

En route besvarar HTTP-förfrågningar på /api/v1/plugins/<slug>/api/<path> på boten, matchade på path och method. Förfrågans innehåll går till stdin och din stdout är svaret. Tidsgränsen är 30 sekunder.

providers

En leverantör lägger till en källa för chattmodeller. Ange id, displayName, providerType, modelsCommand och chatCommand. Nebo skickar en chattförfrågan som JSON på stdin till chatCommand och läser strömmade händelser som radavgränsad JSON på stdout, i upp till 300 sekunder. I dag används bara strömmande chatt.

channel

En kanal bryggar en meddelandetjänst. Nebo håller command igång, läser inkommande meddelanden från dess stdout och skriver svar till dess stdin, båda som radavgränsad JSON.

FältStandardBetydelse
commandobligatorisktArgument som startar bryggan.
name, description""Visas i inställningarna.
restartDelaySecs5Väntetid innan omstart efter en krasch.
sharedfalseEn brygga för alla medarbetare; meddelanden dirigeras efter medarbetarens namn och svaren bär varje medarbetares identitet.
needsLocalApifalseGe bryggan botens lokala API-adress, en token och medarbetar-id:t. Av om du inte behöver det.

setup

En installationsguide leder ägaren genom steg som ett enda formulär inte kan täcka. Värden från form-steg fyller i {{key}} i senare generate-argument. Värden från credentials-steg sparas som pluginets miljövariabler.

"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" }
  ]
}
StegtypFält
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Visar kommandots utdata för kopiering.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Steget är klart när verifyCommand lyckas.

Fälten har key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) och required.