Velden op het hoogste niveau
| Veld | Type | Verplicht | Betekenis |
|---|---|---|---|
id | string | ja | De marktplaats-identificatie van de plugin. Gebruik de slug tijdens het ontwikkelen. |
slug | string | ja | Stabiele identificatie. [a-z0-9-], maximaal 64 tekens, geen koppelteken aan het begin of eind en geen dubbel koppelteken. Geeft de naam aan de tool plugin__<slug> en de variabele <SLUG>_BIN. |
name | string | ja | Weergavenaam. Noem de dienst waarmee hij verbindt. |
version | string | ja | Semantische versie, zoals 0.1.0. |
platforms | map | ja | Platformsleutel naar binary. Zie Platforms. |
description | string | nee | Eén zin voor mensen en medewerkers. |
author | string | nee | Naam van de uitgever. |
category | string | nee | Helpt medewerkers de plugin te vinden. |
triggers | lijst met strings | nee | Woorden die beschrijven wanneer de plugin van toepassing is. Gebruikt in zoekhints. |
entrySkills | lijst met strings | nee | Meegeleverde skills die als eerste in de toolbeschrijving van de plugin worden genoemd. |
dependencies | lijst met {name, version, optional} | nee | Andere plugins die deze plugin uitvoert. version is standaard "*"; optional standaard false. Hun <SLUG>_BIN-paden worden bij elke aanroep ingesteld. |
auth | object | nee | Aanmelding en accounts. Zie Authenticatie. |
capabilities | object | nee | configSchema, hooks, commands, routes, providers. |
permissions | object | nee | Filtering van de omgeving en de maximale time-out. |
events | list | nee | Watchers die workflows van medewerkers voeden. |
interfaceBindings | map | nee | Getypeerde bewerkingen die de plugin levert. |
channel | object | nee | Een blijvende brug naar een berichtendienst. |
setup | object | nee | Een stapsgewijze installatiewizard. |
Nebo valideert installaties vanuit de marktplaats: de slugregels, een semantische versie, minstens één platform, een binaryName zonder padscheidingstekens of .., een login-opdracht tenzij auth.type gelijk is aan env, niet-lege eventnamen en opdrachten, en bindingsjablonen die geparsed kunnen worden. Plugins in de map met gebruikersplugins slaan de validatie over.
Platforms
Sleutels zijn darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 en windows-amd64. Elke vermelding heeft alle vijf de velden hieronder. Bij het publiceren schrijft de marktplaats de echte hash, grootte, handtekening en download-URL in, dus laat ze leeg in het bestand dat je uploadt.
"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": "" }
} | Veld | Betekenis |
|---|---|
binaryName | De bestandsnaam van het uitvoerbare bestand. Voeg .exe toe op Windows. |
sha256 | Hash van de binary. Wordt bij installatie gecontroleerd. |
signature | Handtekening van de binary. Wordt bij installatie gecontroleerd als er een ondertekeningssleutel beschikbaar is. |
size | Grootte in bytes. |
downloadUrl | Waar Nebo het pakket downloadt. |
Authenticatie
| Veld | Betekenis |
|---|---|
type | oauth_cli voor inloggen via de browser dat de plugin uitvoert; env voor inloggegevens die als waarden worden ingevoerd; neboai om de NeboAI-token van de eigenaar te ontvangen in elke auth.env-sleutel die eindigt op _TOKEN. |
env | Koppeling van variabelenaam naar standaardwaarde. Ook de enige namen van inloggegevens die Nebo aan login doorgeeft. |
commands.login | Logt in. Verplicht tenzij type gelijk is aan env. Draait met de accountmap ingesteld. |
commands.status | Drukt JSON af die aangeeft of het account is ingelogd. |
commands.refresh | Vernieuwt een token zonder interactie. |
commands.logout | Logt uit. Alleen de eigenaar kan dit uitvoeren. |
profileDirEnv | Variabele die een aparte map met inloggegevens krijgt voor elke medewerker en elk account. Zonder deze variabele heeft de plugin één gedeeld account. |
label, description | Tekst op de verbindingskaart. |
help | {url, urlLabel, text}, getoond tijdens het verbinden. |
publicRedirect | Zet op true als de provider redirects naar http://localhost weigert; het inloggen loopt dan via de openbare redirect van NeboAI. |
Nebo leest de eerste van authenticated, isAuthenticated, logged_in, loggedIn of token_valid in de statusuitvoer. Een niet-lege token_error, of de waarde none in credential_source, auth_method, storage of status, betekent uitgelogd. De statusopdracht heeft 45 seconden.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema beschrijft de waarden die een eigenaar voor de plugin instelt. Elke waarde bereikt de binary als omgevingsvariabele met de naam uit key. Voor sleutels van inloggegevens die ook in auth.env staan, geeft het schema de velden van het verbindingsformulier per medewerker een label.
| Veld | Type | Standaard | Betekenis |
|---|---|---|---|
key | string | verplicht | Naam van de omgevingsvariabele. |
label | string | verplicht | Veldlabel. |
description | string | "" | Helptekst. |
fieldType | string | "string" | Invoertype, zoals string, number, boolean, select of password. |
default | string | geen | Vooraf ingevulde waarde. |
required | boolean | false | De plugin is pas gereed als de waarde is ingesteld. |
secret | boolean | false | De waarde wordt gemaskeerd bij het teruglezen. |
options | lijst met strings | geen | Keuzes voor select. |
permissions
| Veld | Standaard | Betekenis |
|---|---|---|
envAllow | [] | Overgenomen variabelen die de plugin mag zien. Leeg staat alles toe. |
envDeny | [] | Overgenomen variabelen die altijd worden verwijderd. |
maxTimeoutSeconds | 300 | Bovengrens voor de time-out van elke aanroep. |
network | false | Geeft netwerkgebruik aan. Informatief; wordt niet afgedwongen. |
events
Een event is een langlopende watcher. Nebo start hem wanneer de workflow van een medewerker hem bewaakt, en start hem opnieuw als hij stopt. Elke regel die de watcher naar stdout schrijft, is één event. Tijdens het uitvoeren krijgt de eventnaam de slug als voorvoegsel, zodat note.created wordt tot notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Veld | Betekenis |
|---|---|
name | Eventnaam, zonder de slug. Verplicht. |
command | Argumenten die de watcher starten. Verplicht. {{key}} wordt vervangen door de invoerwaarden van de medewerker. |
description | Wat het event veroorzaakt. |
multiplexed | Bij true geeft één watcher meerdere eventtypen af en bevat elke regel een veld "event". |
Workflows abonneren zich op events met een watch-trigger. Zie Triggers.
interfaceBindings
Een binding koppelt een interfacebewerking aan een van je opdrachten. Elke binding wordt een getypeerde tool voor medewerkers, genoemd naar de bewerking in kleine letters met punten en koppeltekens als underscores: notes.search wordt notes_search. Met bindings voldoet een plugin aan de capabilities die een medewerker vereist; zie Capabilities.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Placeholder | Wordt |
|---|---|
{field} | De waarde van het veld als één woord. Het veld wordt niet ook als flag doorgegeven. |
{field[]:--flag} | Eén --flag <item>-paar voor elk item in een lijstveld. |
{field?:--flag} | --flag <value> als het veld aanwezig is; niets als het ontbreekt. |
{field:cents->dollars} | Een geheel bedrag in centen, geschreven als dollars. |
Invoervelden die een sjabloon niet noemt, worden toegevoegd als --field value. Lijst- en optionele placeholders moeten hele woorden zijn. Een bewerking waarvoor goedkeuring nodig is, kan niet worden bereikt door dezelfde opdracht via plugin__<slug> aan te roepen.
Hooks, slash-opdrachten en 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
Een hook voert je opdracht uit op een bepaald moment in de beurt van een medewerker. Nebo schrijft een JSON-payload naar stdin. De uitvoer van een action-hook wordt genegeerd. Een filter-hook geeft {"payload": ..., "handled": false} terug; "handled": true stopt latere hooks. Bij fouten en time-outs blijft de vorige payload staan en wordt de beurt nooit geblokkeerd. Na drie fouten op rij wordt een hook vijf minuten gepauzeerd.
| Veld | Standaard | Betekenis |
|---|---|---|
hook | verplicht | Een van tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action of filter. |
command | verplicht | Argumenten voor je binary. |
priority | 100 | Lager draait eerst. |
timeoutMs | 500 | Tijdslimiet in milliseconden. |
commands
Met "slash": true voert het typen van /name args in de chat direct command args uit, zonder de medewerker. De uitvoer is het antwoord. De tijdslimiet is 30 seconden.
routes
Een route beantwoordt HTTP-verzoeken op /api/v1/plugins/<slug>/api/<path> op de bot, gematcht op path en method. De body van het verzoek gaat naar stdin en je stdout is het antwoord. De tijdslimiet is 30 seconden.
providers
Een provider voegt een bron voor chatmodellen toe. Declareer id, displayName, providerType, modelsCommand en chatCommand. Nebo stuurt een chatverzoek als JSON via stdin naar chatCommand en leest gestreamde events als JSON met één object per regel op stdout, tot 300 seconden lang. Vandaag wordt alleen chatstreaming gebruikt.
channel
Een channel overbrugt een berichtendienst. Nebo houdt command draaiende, leest inkomende berichten uit de stdout ervan en schrijft antwoorden naar de stdin, beide als JSON met één object per regel.
| Veld | Standaard | Betekenis |
|---|---|---|
command | verplicht | Argumenten die de brug starten. |
name, description | "" | Getoond in de instellingen. |
restartDelaySecs | 5 | Wachttijd voor een herstart na een crash. |
shared | false | Eén brug voor alle medewerkers; berichten worden gerouteerd op naam van de medewerker en antwoorden dragen de identiteit van elke medewerker. |
needsLocalApi | false | Geef de brug het lokale API-adres van de bot, een token en het id van de medewerker. Uit, tenzij je het nodig hebt. |
setup
Een installatiewizard leidt de eigenaar door stappen die met één formulier niet te doen zijn. Waarden uit form-stappen vullen {{key}} in latere generate-argumenten. Waarden uit credentials-stappen worden opgeslagen als omgevingsvariabelen van de plugin.
"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" }
]
} | Soort stap | Velden |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Toont de uitvoer van de opdracht om te kopiëren. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. De stap is voltooid wanneer verifyCommand slaagt. |
Velden hebben key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) en required.