Felt på toppnivå
| Felt | Type | Obligatorisk | Betydning |
|---|---|---|---|
id | string | ja | Tilleggets identifikator på markedsplassen. Bruk sluggen under utvikling. |
slug | string | ja | Stabil identifikator. [a-z0-9-], maks 64 tegn, ingen bindestrek først, sist eller dobbelt. Gir navn til verktøyet plugin__<slug> og variabelen <SLUG>_BIN. |
name | string | ja | Visningsnavn. Oppgi tjenesten det kobler til. |
version | string | ja | Semantisk versjon, for eksempel 0.1.0. |
platforms | map | ja | Plattformnøkkel til binærfil. Se Plattformer. |
description | string | nei | Én setning for mennesker og ansatte. |
author | string | nei | Navnet på utgiveren. |
category | string | nei | Hjelper ansatte med å finne tillegget. |
triggers | liste med strenger | nei | Ord som beskriver når tillegget er aktuelt. Brukes i søkehint. |
entrySkills | liste med strenger | nei | Medfølgende ferdigheter som skal nevnes først i tilleggets verktøybeskrivelse. |
dependencies | liste med {name, version, optional} | nei | Andre tillegg dette tillegget kjører. version er som standard "*"; optional er false. Stiene <SLUG>_BIN deres angis ved hvert kall. |
auth | object | nei | Innlogging og kontoer. Se Autentisering. |
capabilities | object | nei | configSchema, hooks, commands, routes, providers. |
permissions | object | nei | Miljøfiltrering og øvre grense for tidsavbrudd. |
events | list | nei | Overvåkere som mater ansattes arbeidsflyter. |
interfaceBindings | map | nei | Typede operasjoner tillegget tilbyr. |
channel | object | nei | En vedvarende bro til en meldingstjeneste. |
setup | object | nei | En trinnvis oppsettsveiviser. |
Nebo validerer installasjoner fra markedsplassen: reglene for sluggen, en semantisk versjon, minst én plattform, et binaryName uten stiskilletegn eller .., en login-kommando med mindre auth.type er env, hendelsesnavn og kommandoer som ikke er tomme, og bindingsmaler som lar seg tolke. Tillegg i brukermappen for tillegg hopper over valideringen.
Plattformer
Nøklene er darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 og windows-amd64. Hver oppføring har alle de fem feltene nedenfor. Når du publiserer, skriver markedsplassen inn den ekte hashen, størrelsen, signaturen og nedlastings-URL-en, så la dem stå tomme i filen du laster opp.
"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 | Filnavnet til den kjørbare filen. Legg til .exe på Windows. |
sha256 | Hashen til binærfilen. Kontrolleres ved installasjon. |
signature | Signaturen til binærfilen. Kontrolleres ved installasjon når en signeringsnøkkel er tilgjengelig. |
size | Størrelse i byte. |
downloadUrl | Hvor Nebo laster ned pakken. |
Autentisering
| Felt | Betydning |
|---|---|
type | oauth_cli for en nettleserinnlogging som tillegget kjører; env for påloggingsopplysninger som skrives inn som verdier; neboai for å motta eierens NeboAI-token i hver auth.env-nøkkel som slutter på _TOKEN. |
env | Kart fra variabelnavn til standardverdi. Også de eneste navnene på påloggingsopplysninger Nebo sender til login. |
commands.login | Logger inn. Obligatorisk med mindre type er env. Kjører med kontomappen angitt. |
commands.status | Skriver ut JSON som sier om kontoen er logget inn. |
commands.refresh | Fornyer et token uten interaksjon. |
commands.logout | Logger ut. Bare eieren kan kjøre den. |
profileDirEnv | Variabel som får en egen mappe for påloggingsopplysninger for hver ansatt og konto. Uten den har tillegget én felles konto. |
label, description | Tekst på tilkoblingskortet. |
help | {url, urlLabel, text} som vises under tilkoblingen. |
publicRedirect | Sett til true når leverandøren avviser omdirigeringer til http://localhost; innloggingen går da gjennom NeboAIs offentlige omdirigering. |
Nebo leser den første av authenticated, isAuthenticated, logged_in, loggedIn eller token_valid i statusutdataene. En token_error som ikke er tom, eller verdien none i credential_source, auth_method, storage eller status, betyr logget ut. Statuskommandoen har 45 sekunder.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema beskriver verdiene en eier angir for tillegget. Hver verdi når binærfilen som en miljøvariabel med navnet i key. For nøkler for påloggingsopplysninger som også står i auth.env, gir skjemaet etiketter til feltene i tilkoblingsskjemaet per ansatt.
| Felt | Type | Standard | Betydning |
|---|---|---|---|
key | string | obligatorisk | Navn på miljøvariabel. |
label | string | obligatorisk | Feltetikett. |
description | string | "" | Hjelpetekst. |
fieldType | string | "string" | Inndatatype, for eksempel string, number, boolean, select eller password. |
default | string | ingen | Forhåndsutfylt verdi. |
required | boolean | false | Tillegget er ikke klart før verdien er angitt. |
secret | boolean | false | Verdien maskeres når den leses tilbake. |
options | liste med strenger | ingen | Valg for select. |
permissions
| Felt | Standard | Betydning |
|---|---|---|
envAllow | [] | Arvede variabler tillegget kan se. Tom tillater alle. |
envDeny | [] | Arvede variabler som alltid fjernes. |
maxTimeoutSeconds | 300 | Øvre grense for tidsavbruddet til et hvilket som helst kall. |
network | false | Oppgir nettverksbruk. Kun til informasjon; håndheves ikke. |
events
En hendelse er en langvarig overvåker. Nebo starter den når en ansatts arbeidsflyt overvåker den, og starter den på nytt hvis den avslutter. Hver linje overvåkeren skriver til stdout, er én hendelse. Hendelsesnavnet får sluggen som prefiks under kjøring, slik at 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"
}
] | Felt | Betydning |
|---|---|
name | Hendelsesnavn, uten sluggen. Obligatorisk. |
command | Argumenter som starter overvåkeren. Obligatorisk. {{key}} erstattes med den ansattes inndataverdier. |
description | Hva som utløser hendelsen. |
multiplexed | Når true, sender én overvåker ut flere hendelsestyper, og hver linje har et "event"-felt. |
Arbeidsflyter abonnerer på hendelser med en watch-utløser. Se Utløsere.
interfaceBindings
En binding knytter en grensesnittoperasjon til en av kommandoene dine. Hver binding blir et typet verktøy for ansatte, oppkalt etter operasjonen med små bokstaver og med punktum og bindestreker som understreker: notes.search blir notes_search. Bindinger er måten et tillegg oppfyller funksjonene en ansatt krever; se Funksjoner.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Plassholder | Utvides til |
|---|---|
{field} | Verdien til feltet som ett ord. Feltet sendes ikke i tillegg som et flagg. |
{field[]:--flag} | Ett --flag <item>-par for hvert element i et listefelt. |
{field?:--flag} | --flag <value> når feltet finnes; ingenting når det mangler. |
{field:cents->dollars} | Et heltallsbeløp i cent, skrevet som dollar. |
Inndatafelt som en mal ikke nevner, legges til som --field value. Liste- og valgfrie plassholdere må være hele ord. En operasjon som krever godkjenning, kan ikke nås ved å kalle den samme kommandoen gjennom plugin__<slug>.
Hooks, skråstrekkommandoer 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 krok kjører kommandoen din på et bestemt punkt i en ansatts tur. Nebo skriver en JSON-nyttelast til stdin. Utdata fra en action-krok ignoreres. En filter-krok returnerer {"payload": ..., "handled": false}; "handled": true stopper senere kroker. Feil og tidsavbrudd beholder forrige nyttelast og blokkerer aldri turen. Etter tre feil på rad settes en krok på pause i fem minutter.
| Felt | Standard | Betydning |
|---|---|---|
hook | obligatorisk | En 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. |
command | obligatorisk | Argumenter til binærfilen din. |
priority | 100 | Lavere kjører først. |
timeoutMs | 500 | Tidsgrense i millisekunder. |
commands
Med "slash": true kjører det å skrive /name args i chatten command args direkte, uten den ansatte. Utdataene er svaret. Tidsgrensen er 30 sekunder.
routes
En rute svarer på HTTP-forespørsler på /api/v1/plugins/<slug>/api/<path> på boten, matchet etter path og method. Forespørselsinnholdet går til stdin, og stdout fra deg er svaret. Tidsgrensen er 30 sekunder.
providers
En leverandør legger til en kilde for chatmodeller. Oppgi id, displayName, providerType, modelsCommand og chatCommand. Nebo sender en chatforespørsel som JSON på stdin til chatCommand og leser strømmede hendelser som linjeskilt JSON på stdout, i opptil 300 sekunder. Bare chatstrømming brukes i dag.
channel
En kanal bygger bro til en meldingstjeneste. Nebo holder command i gang, leser innkommende meldinger fra stdout og skriver svar til stdin, begge som linjeskilt JSON.
| Felt | Standard | Betydning |
|---|---|---|
command | obligatorisk | Argumenter som starter broen. |
name, description | "" | Vises i innstillingene. |
restartDelaySecs | 5 | Ventetid før omstart etter et krasj. |
shared | false | Én bro for alle ansatte; meldinger rutes etter navnet på den ansatte, og svarene bærer hver ansatts identitet. |
needsLocalApi | false | Gi broen botens lokale API-adresse, et token og ID-en til den ansatte. Av med mindre du trenger det. |
setup
En oppsettsveiviser leder eieren gjennom steg som ett enkelt skjema ikke kan dekke. Verdier fra form-steg fyller ut {{key}} i senere generate-argumenter. Verdier fra credentials-steg lagres som tilleggets 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" }
]
} | Trinntype | Felt |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Viser utdataene fra kommandoen slik at de kan kopieres. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Trinnet er fullført når verifyCommand lykkes. |
Feltene har key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) og required.