Så fungerar plugins
Ett plugin är en körbar fil plus ett manifest. Nebo håller ingen pluginprocess igång mellan anropen. Varje gång en medarbetare använder pluginet startar Nebo binärfilen med ett kommando och argument, väntar tills den avslutas och lämnar utdata tillbaka till medarbetaren.
- Kommandon är argument. Medarbetaren väljer ett kommando, till exempel
notes search, och namngivna argument. Nebo skickar varje argument som--name value. Det finns inget skal, så pipes och omdirigeringar gäller aldrig. - Utdata är stdout. Skriv resultat till stdout. JSON fungerar bra.
- Standard in är stängd för vanliga anrop. Hooks, routes och chattleverantörer använder stdin; se plugin.json-referensen.
Varje installerat och aktiverat plugin visas för medarbetare som ett verktyg med namnet plugin__<slug>. En medarbetare anropar det så här:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo kör:
notes-sync notes search --query "quarterly plan" --limit 5
| Parameter | Typ | Betydelse |
|---|---|---|
command | sträng, obligatorisk | Pluginkommandot och eventuella positionsord. |
args | objekt med strängar | Namngivna argument. Vart och ett blir --key value. |
timeout | integer | Sekunder att vänta. Standard 120, begränsat av manifestets permissions.maxTimeoutSeconds. |
display | string | Meningen ägaren ser när anropet behöver godkännas. |
Bygg ditt första plugin
Skriv en binärfil i valfritt språk som läser sitt kommando från argumenten och skriver ut ett resultat. Lägg den sedan bredvid en plugin.json i en bots användarkatalog för plugins.
<data>/user/plugins/notes-sync/
├── plugin.json # runtime manifest
├── notes-sync # your binary, named after the slug
└── skills/ # optional: skills that teach employees to use it
└── notes-sync/
└── SKILL.md {
"id": "notes-sync",
"slug": "notes-sync",
"name": "Notes Sync",
"version": "0.1.0",
"description": "Search, read and create notes in Example Notes.",
"platforms": {}
} id, slug, name, version och platforms är obligatoriska. I användarens plugin-katalog kan mappningen platforms vara tom: Nebo letar efter en binärfil med slug-värdets namn bredvid plugin.json, och sedan i target/release/ och target/debug/. När du publicerar fyller marknadsplatsen i platforms för varje binärfil du laddar upp.
<data> är ~/Library/Application Support/Nebo på macOS, %APPDATA%\Nebo på Windows och ~/.local/share/nebo på Linux, eller värdet av NEBO_HOME. Ett plugin i användarkatalogen åsidosätter ett marknadsplatsplugin med samma slug, vilket gör den till platsen där du testar en ny version.
Lär medarbetarna att använda det
Lägg en mapp skills/ bredvid plugin.json. Varje färdighet i den är tillgänglig för alla medarbetare så länge pluginet är installerat, och listar automatiskt pluginet som ett beroende. Använd färdigheten för att berätta vilka kommandon som finns, vad de returnerar och när vart och ett ska användas. Ange de mest användbara färdigheterna i entrySkills så att pluginets verktygsbeskrivning pekar på dem först.
Marknadsplatsens sida är en separat fil, PLUGIN.md. Nebo läser den inte vid körning; det är sidan folk ser innan de installerar. Se Leverera ett plugin.
Miljö
Varje anrop ärver botens miljö med variabler för laddare och skalinjektion borttagna, och lägger sedan till dessa värden. Senare poster vinner.
| Variabel | Värde |
|---|---|
auth.env-nycklar | Standardvärden från manifestet. |
<SLUG>_BIN | Sökväg till det här pluginets binärfil, och till varje plugin det är beroende av. Slug-värdet skrivs med versaler och med bindestreck som understreck. |
NEBO_DATA_DIR | Pluginets egen datamapp, <data>/appdata/plugins/<slug>/. Det är också arbetskatalogen, och den finns kvar efter avinstallation. |
PATH | Pluginmappar först, sedan den ärvda sökvägen. |
| Inställningar | Värden som ägaren har sparat för configSchema-fält. |
NEBO_AGENT_ID | Medarbetaren som gör anropet. |
profileDirEnv | Kontomappen för den här medarbetaren och det här kontot, när pluginet stöder konton. |
permissions.envAllow och permissions.envDeny begränsar vad pluginet ärver från boten. De tar aldrig bort pluginets egna autentiseringsvariabler.
Konton och inloggningsuppgifter
Ett plugin som loggar in på en tjänst bör ha ett konto per medarbetare. Bokföraren loggar in med ekonomiinloggningen och assistenten med sin egen, och ingen av dem ser den andras token. Du anger detta i manifestet; Nebo sköter resten.
"auth": {
"type": "env",
"label": "Example Notes account",
"env": { "EXAMPLE_NOTES_TOKEN": "" },
"commands": { "login": "auth login", "status": "auth status", "logout": "auth logout" },
"profileDirEnv": "EXAMPLE_NOTES_CONFIG_DIR"
},
"capabilities": {
"configSchema": [
{ "key": "EXAMPLE_NOTES_TOKEN", "label": "API token", "fieldType": "password", "secret": true, "required": true }
]
} auth.envnamnger inloggningsuppgifterna.capabilities.configSchemasätter etiketter på dem och bestämmer deras ordning i anslutningsformuläret.auth.profileDirEnvnamnger variabeln som ditt plugin läser för sin mapp med inloggningsuppgifter. Nebo skapar en mapp för varje medarbetare och konto och sätter den variabeln vid varje anrop.- När ägaren ansluter ett konto kör Nebo ditt
login-kommando med de värden ägaren skrev in och kontomappen angiven. Ditt plugin sparar det som behövs i den mappen. Nebo behåller inte värdena. - Ditt
status-kommando skriver ut JSON som{"authenticated": true}. När en token går ut kör Neborefreshom du har deklarerat ett sådant.
För en webbläsarinloggning sätter du type till oauth_cli och låter login skriva ut eller öppna leverantörens inloggningsadress. Medarbetare loggar aldrig in på egen hand: när ett anrop kräver inloggning ser ägaren ett anslutningskort. En medarbetare med flera konton väljer ett genom att lägga till --account <label> i ett kommando. Nebo tar bort den flaggan innan din binärfil ser den.
Namnge tjänsten, inte formen. Ett plugins namn säger vad det ansluter till, till exempel ”Example Notes”. Skriv aldrig ”CLI” i ett pluginnamn; för medarbetare och ägare är det en anslutning, inte en kommandorad.
Nästa steg
- plugin.json-referens: varje fält, inklusive händelser, hooks och typade operationer.
- Leverera ett plugin: plattformar, binärfiler, signering och uppdateringar.
- Publicering: marknadsplatsflödet för varje artefakt.