Sådan fungerer plugins
Et plugin er en eksekverbar fil plus et manifest. Nebo holder ingen pluginproces kørende mellem kald. Hver gang en medarbejder bruger pluginet, starter Nebo binærfilen med en kommando og argumenter, venter på, at den afslutter, og giver outputtet tilbage til medarbejderen.
- Kommandoer er argumenter. Medarbejderen vælger en kommando, f.eks.
notes search, og navngivne argumenter. Nebo sender hvert argument som--name value. Der er ingen shell, så pipes og omdirigeringer gælder aldrig. - Output er stdout. Skriv resultater til stdout. JSON fungerer godt.
- Standardinput er lukket ved almindelige kald. Hooks, ruter og chatudbydere bruger stdin; se referencen for plugin.json.
Hvert installeret og aktiveret plugin vises for medarbejdere som ét værktøj med navnet plugin__<slug>. En medarbejder kalder det sådan:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo kører:
notes-sync notes search --query "quarterly plan" --limit 5
| Parameter | Type | Betydning |
|---|---|---|
command | streng, påkrævet | Pluginkommandoen og eventuelle positionelle ord. |
args | objekt af strenge | Navngivne argumenter. Hvert bliver til --key value. |
timeout | integer | Sekunder at vente. Standard 120, begrænset af manifestets permissions.maxTimeoutSeconds. |
display | string | Den sætning, ejeren ser, når kaldet kræver godkendelse. |
Byg dit første plugin
Skriv en binærfil i et hvilket som helst sprog, der læser sin kommando fra argumenterne og udskriver et resultat. Læg den derefter ved siden af en plugin.json i en bots brugermappe til 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 og platforms er påkrævet. I brugermappen til plugins kan platforms-kortet være tomt: Nebo leder efter en binærfil, der er navngivet efter sluggen, ved siden af plugin.json, derefter i target/release/ og target/debug/. Når du udgiver, udfylder markedspladsen platforms for hver binærfil, du uploader.
<data> er ~/Library/Application Support/Nebo på macOS, %APPDATA%\Nebo på Windows og ~/.local/share/nebo på Linux eller værdien af NEBO_HOME. Et plugin i brugermappen tilsidesætter et markedspladsplugin med samme slug, hvilket gør det til stedet, hvor du tester et nyt build.
Lær medarbejderne at bruge det
Læg en skills/-mappe ved siden af plugin.json. Hver færdighed i den er tilgængelig for alle medarbejdere, så længe pluginet er installeret, og angiver automatisk pluginet som en afhængighed. Brug færdigheden til at fortælle, hvilke kommandoer der findes, hvad de returnerer, og hvornår hver enkelt skal bruges. Nævn de mest nyttige færdigheder i entrySkills, så pluginets værktøjsbeskrivelse peger på dem først.
Markedspladsens opslag er en separat fil, PLUGIN.md. Nebo læser den ikke ved kørsel; det er den side, folk ser, før de installerer. Se Udgiv et plugin.
Miljø
Hvert kald arver bottens miljø, hvor loader- og shell-injektionsvariabler er fjernet, og tilføjer derefter disse værdier. Senere poster vinder.
| Variabel | Værdi |
|---|---|
auth.env-nøgler | Standardværdier fra manifestet. |
<SLUG>_BIN | Stien til dette plugins binærfil og til hvert plugin, det afhænger af. Sluggen skrives med store bogstaver og med bindestreger som understregninger. |
NEBO_DATA_DIR | Pluginets egen datamappe, <data>/appdata/plugins/<slug>/. Den er også arbejdsmappen, og den overlever afinstallation. |
PATH | Pluginmapper først, derefter den nedarvede sti. |
| Indstillinger | Værdier, ejeren har gemt for configSchema-felter. |
NEBO_AGENT_ID | Den medarbejder, der foretager kaldet. |
profileDirEnv | Kontomappen for denne medarbejder og konto, når pluginet understøtter konti. |
permissions.envAllow og permissions.envDeny begrænser, hvad pluginet arver fra botten. De fjerner aldrig pluginets egne godkendelsesvariabler.
Konti og loginoplysninger
Et plugin, der logger ind på en tjeneste, bør have én konto pr. medarbejder. Bogholderen logger ind med økonomiafdelingens login og assistenten med sit eget, og ingen af dem ser den andens tokens. Du erklærer det i manifestet; Nebo klarer 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.envnavngiver loginoplysningerne.capabilities.configSchemamærker dem og bestemmer deres rækkefølge i tilslutningsformularen.auth.profileDirEnvnavngiver den variabel, dit plugin læser for sin mappe med loginoplysninger. Nebo opretter én mappe for hver medarbejder og konto og angiver den variabel ved hvert kald.- Når ejeren tilslutter en konto, kører Nebo din
login-kommando med de værdier, ejeren indtastede, og med kontomappen angivet. Dit plugin gemmer, hvad det har brug for, i den mappe. Nebo beholder ikke værdierne. - Din
status-kommando udskriver JSON som{"authenticated": true}. Når et token udløber, kører Neborefresh, hvis du har angivet en.
Til et browserlogin skal du sætte type til oauth_cli og lade login udskrive eller åbne udbyderens login-URL. Medarbejdere logger aldrig ind på egen hånd: Når et kald kræver et login, ser ejeren et tilslutningskort. En medarbejder med flere konti vælger én ved at tilføje --account <label> til en kommando. Nebo fjerner det flag, før din binærfil ser det.
Nævn tjenesten, ikke formen. Et plugins navn siger, hvad det forbinder til, f.eks. "Example Notes". Skriv aldrig "CLI" i et pluginnavn; for medarbejdere og ejere er det en forbindelse, ikke en kommandolinje.
Næste
- Reference for plugin.json: alle felter, inklusive hændelser, hooks og typede operationer.
- Udgiv et plugin: platforme, binærfiler, signering og opdateringer.
- Udgivelse: markedspladsforløbet for alle typer indhold.