Felter på øverste niveau
| Felt | Type | Påkrævet | Betydning |
|---|---|---|---|
id | string | ja | Pluginets identifikator på markedspladsen. Brug sluggen under udvikling. |
slug | string | ja | Stabil identifikator. [a-z0-9-], højst 64 tegn, ingen bindestreg først, sidst eller dobbelt. Navngiver værktøjet plugin__<slug> og variablen <SLUG>_BIN. |
name | string | ja | Visningsnavn. Nævn den tjeneste, det forbinder til. |
version | string | ja | Semantisk version, f.eks. 0.1.0. |
platforms | map | ja | Platformsnøgle til binærfil. Se Platforme. |
description | string | nej | Én sætning til mennesker og medarbejdere. |
author | string | nej | Udgiverens navn. |
category | string | nej | Hjælper medarbejdere med at finde pluginet. |
triggers | liste af strenge | nej | Ord, der beskriver, hvornår pluginet er relevant. Bruges i søgetip. |
entrySkills | liste af strenge | nej | Medfølgende færdigheder, der skal nævnes først i pluginets værktøjsbeskrivelse. |
dependencies | liste af {name, version, optional} | nej | Andre plugins, som dette kører. version er som standard "*"; optional er som standard false. Deres <SLUG>_BIN-stier angives ved hvert kald. |
auth | object | nej | Login og konti. Se Auth. |
capabilities | object | nej | configSchema, hooks, commands, routes, providers. |
permissions | object | nej | Filtrering af miljøvariabler og loftet for timeout. |
events | list | nej | Overvågere, der leverer input til medarbejdernes arbejdsgange. |
interfaceBindings | map | nej | Typede operationer, som pluginet stiller til rådighed. |
channel | object | nej | En vedvarende bro til en beskedtjeneste. |
setup | object | nej | En trin-for-trin-opsætningsguide. |
Nebo validerer installationer fra markedspladsen: slugreglerne, en semantisk version, mindst én platform, et binaryName uden stiseparatorer eller .., en login-kommando, medmindre auth.type er env, hændelsesnavne og kommandoer, der ikke er tomme, og bindingsskabeloner, der kan fortolkes. Plugins i brugerens plugin-mappe springer valideringen over.
Platforme
Nøglerne er darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 og windows-amd64. Hver post har alle fem felter nedenfor. Når du udgiver, skriver markedspladsen den rigtige hash, størrelse, signatur og download-URL, så lad dem være tomme i den fil, du uploader.
"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": "" }
} | Felt | Betydning |
|---|---|
binaryName | Den eksekverbare fils navn. Tilføj .exe på Windows. |
sha256 | Binærfilens hash. Tjekkes ved installation. |
signature | Binærfilens signatur. Tjekkes ved installation, når en signeringsnøgle er tilgængelig. |
size | Størrelse i bytes. |
downloadUrl | Hvor Nebo downloader pakken. |
Auth
| Felt | Betydning |
|---|---|
type | oauth_cli for et browserlogin, som pluginet kører; env for loginoplysninger, der indtastes som værdier; neboai for at modtage ejerens NeboAI-token i hver auth.env-nøgle, der ender på _TOKEN. |
env | Kort fra variabelnavn til standardværdi. Også de eneste navne på loginoplysninger, Nebo sender til login. |
commands.login | Logger ind. Påkrævet, medmindre type er env. Kører med kontomappen angivet. |
commands.status | Udskriver JSON, der siger, om kontoen er logget ind. |
commands.refresh | Fornyer et token uden interaktion. |
commands.logout | Logger ud. Kun ejeren kan køre den. |
profileDirEnv | Variabel, der modtager en separat mappe med loginoplysninger for hver medarbejder og konto. Uden den har pluginet én fælles konto. |
label, description | Tekst på tilslutningskortet. |
help | {url, urlLabel, text} vist under tilslutningen. |
publicRedirect | Sæt til true, når udbyderen afviser omdirigeringer til http://localhost; login går så gennem NeboAI’s offentlige omdirigering. |
Nebo læser den første af authenticated, isAuthenticated, logged_in, loggedIn eller token_valid i statusoutputtet. En token_error, der ikke er tom, eller værdien none i credential_source, auth_method, storage eller status betyder logget ud. Statuskommandoen har 45 sekunder.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema beskriver de værdier, en ejer angiver for pluginet. Hver værdi når binærfilen som en miljøvariabel, der er navngivet efter key. For nøgler til loginoplysninger, der også står i auth.env, mærker skemaet felterne i tilslutningsformularen pr. medarbejder.
| Felt | Type | Standard | Betydning |
|---|---|---|---|
key | string | påkrævet | Navn på miljøvariabel. |
label | string | påkrævet | Feltetiket. |
description | string | "" | Hjælpetekst. |
fieldType | string | "string" | Inputtype, f.eks. string, number, boolean, select eller password. |
default | string | ingen | Forudfyldt værdi. |
required | boolean | false | Pluginet er ikke klar, før værdien er angivet. |
secret | boolean | false | Værdien maskeres, når den læses tilbage. |
options | liste af strenge | ingen | Valgmuligheder for select. |
permissions
| Felt | Standard | Betydning |
|---|---|---|
envAllow | [] | Nedarvede variabler, som pluginet må se. Tom tillader alle. |
envDeny | [] | Nedarvede variabler, der altid fjernes. |
maxTimeoutSeconds | 300 | Øvre grænse for ethvert kalds timeout. |
network | false | Erklærer netværksbrug. Kun til information; håndhæves ikke. |
events
En hændelse er en langvarig overvåger. Nebo starter den, når en medarbejders arbejdsgang overvåger den, og genstarter den, hvis den afslutter. Hver linje, overvågeren skriver til stdout, er én hændelse. Hændelsesnavnet får sluggen som præfiks ved kørsel, så note.created bliver til notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Felt | Betydning |
|---|---|
name | Hændelsesnavn uden sluggen. Påkrævet. |
command | Argumenter, der starter overvågeren. Påkrævet. {{key}} erstattes med medarbejderens inputværdier. |
description | Hvad der udløser hændelsen. |
multiplexed | Når den er true, udsender én overvåger flere hændelsestyper, og hver linje har et "event"-felt. |
Arbejdsgange abonnerer på hændelser med en watch-udløser. Se Udløsere.
interfaceBindings
En binding knytter en grænsefladeoperation til en af dine kommandoer. Hver binding bliver til et typet værktøj for medarbejdere, navngivet efter operationen med små bogstaver og med punktummer og bindestreger som understregninger: notes.search bliver til notes_search. Bindinger er måden, et plugin opfylder de kapabiliteter, en medarbejder kræver; se Kapabiliteter.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Pladsholder | Udvides til |
|---|---|
{field} | Feltets værdi som ét ord. Feltet sendes ikke også som et flag. |
{field[]:--flag} | Ét --flag <item>-par for hvert element i et listefelt. |
{field?:--flag} | --flag <value>, når feltet findes; intet, når det mangler. |
{field:cents->dollars} | Et heltalsbeløb i cent, skrevet som dollars. |
Inputfelter, som en skabelon ikke nævner, tilføjes som --field value. Liste- og valgfrie pladsholdere skal være hele ord. En operation, der kræver godkendelse, kan ikke nås ved at kalde den samme kommando gennem plugin__<slug>.
Hooks, skråstregskommandoer og ruter
"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ører din kommando på et bestemt tidspunkt i en medarbejders tur. Nebo skriver en JSON-payload til stdin. Outputtet fra en action-hook ignoreres. En filter-hook returnerer {"payload": ..., "handled": false}; "handled": true stopper senere hooks. Fejl og timeouts beholder den forrige payload og blokerer aldrig turen. Efter tre fejl i træk sættes en hook på pause i fem minutter.
| Felt | Standard | Betydning |
|---|---|---|
hook | påkrævet | En af tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action eller filter. |
command | påkrævet | Argumenter til din binærfil. |
priority | 100 | Lavere kører først. |
timeoutMs | 500 | Tidsgrænse i millisekunder. |
commands
Med "slash": true kører det at skrive /name args i chatten command args direkte, uden medarbejderen. Outputtet er svaret. Tidsgrænsen er 30 sekunder.
routes
En rute besvarer HTTP-forespørgsler på /api/v1/plugins/<slug>/api/<path> på botten, matchet efter path og method. Forespørgslens indhold går til stdin, og din stdout er svaret. Tidsgrænsen er 30 sekunder.
providers
En udbyder tilføjer en kilde til chatmodeller. Angiv id, displayName, providerType, modelsCommand og chatCommand. Nebo sender en chatforespørgsel som JSON på stdin til chatCommand og læser streamede hændelser som linjeopdelt JSON på stdout i op til 300 sekunder. Kun chatstreaming bruges i dag.
channel
En kanal bygger bro til en beskedtjeneste. Nebo holder command kørende, læser indgående beskeder fra dens stdout og skriver svar til dens stdin, begge som linjeopdelt JSON.
| Felt | Standard | Betydning |
|---|---|---|
command | påkrævet | Argumenter, der starter broen. |
name, description | "" | Vises i indstillinger. |
restartDelaySecs | 5 | Ventetid før genstart efter et nedbrud. |
shared | false | Én bro for alle medarbejdere; beskeder dirigeres efter medarbejdernavn, og svar bærer hver medarbejders identitet. |
needsLocalApi | false | Giv broen bottens lokale API-adresse, et token og medarbejder-id’et. Slået fra, medmindre du har brug for det. |
setup
En opsætningsguide fører ejeren gennem trin, som en enkelt formular ikke kan dække. Værdier fra form-trin udfylder {{key}} i senere generate-argumenter. Værdier fra credentials-trin gemmes som pluginnets 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" }
]
} | Trintype | Felter |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Viser kommandoens output, så det kan kopieres. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Trinnet er fuldført, når verifyCommand lykkes. |
Felter har key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) og required.