Slik fungerer tillegg
Et tillegg er en kjørbar fil pluss et manifest. Nebo holder ingen tilleggsprosess i gang mellom kallene. Hver gang en ansatt bruker tillegget, starter Nebo binærfilen med en kommando og argumenter, venter til den avslutter, og gir utdataene tilbake til den ansatte.
- Kommandoer er argumenter. Den ansatte velger en kommando, for eksempel
notes search, og navngitte argumenter. Nebo sender hvert argument som--name value. Det finnes ikke noe skall, så rør og omdirigeringer gjelder aldri. - Utdata er stdout. Skriv resultater til stdout. JSON fungerer godt.
- Standard inndata er lukket for vanlige kall. Hooks, ruter og chatleverandører bruker stdin; se plugin.json-referansen.
Hvert installert og aktivert tillegg vises for ansatte som ett verktøy med navnet plugin__<slug>. En ansatt kaller det slik:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo kjører:
notes-sync notes search --query "quarterly plan" --limit 5
| Parameter | Type | Betydning |
|---|---|---|
command | streng, obligatorisk | Tilleggskommandoen og eventuelle posisjonsord. |
args | objekt med strenger | Navngitte argumenter. Hvert blir --key value. |
timeout | integer | Sekunder å vente. Standard 120, begrenset av manifestets permissions.maxTimeoutSeconds. |
display | string | Setningen eieren ser når kallet trenger godkjenning. |
Bygg ditt første tillegg
Skriv en binærfil i hvilket som helst språk som leser kommandoen fra argumentene og skriver ut et resultat. Legg den deretter ved siden av en plugin.json i brukermappen for tillegg på en bot.
<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 obligatoriske. I brukermappen for tillegg kan platforms-kartet være tomt: Nebo ser etter en binærfil oppkalt etter sluggen ved siden av plugin.json, deretter i target/release/ og target/debug/. Når du publiserer, fyller markedsplassen inn platforms for hver binærfil du laster opp.
<data> er ~/Library/Application Support/Nebo på macOS, %APPDATA%\Nebo på Windows og ~/.local/share/nebo på Linux, eller verdien av NEBO_HOME. Et tillegg i brukermappen overstyrer et tillegg fra markedsplassen med samme slug, noe som gjør det til stedet for å teste et nytt bygg.
Lær ansatte å bruke det
Legg en skills/-mappe ved siden av plugin.json. Hver ferdighet i den er tilgjengelig for alle ansatte mens tillegget er installert, og oppgir tillegget som en avhengighet automatisk. Bruk ferdigheten til å si hvilke kommandoer som finnes, hva de returnerer og når hver av dem skal brukes. Nevn de mest nyttige ferdighetene i entrySkills, slik at tilleggets verktøybeskrivelse peker på dem først.
Oppføringen på markedsplassen er en egen fil, PLUGIN.md. Nebo leser den ikke under kjøring; det er siden folk ser før de installerer. Se Levere et tillegg.
Miljø
Hvert kall arver botens miljø med variabler for laster og skallinjeksjon fjernet, og legger deretter til disse verdiene. Senere oppføringer vinner.
| Variabel | Verdi |
|---|---|
auth.env-nøkler | Standardverdier fra manifestet. |
<SLUG>_BIN | Stien til dette tilleggets binærfil og til hvert tillegg det er avhengig av. Sluggen skrives med store bokstaver og med bindestreker som understreker. |
NEBO_DATA_DIR | Tilleggets egen datamappe, <data>/appdata/plugins/<slug>/. Den er også arbeidsmappen, og den overlever avinstallering. |
PATH | Tilleggsmapper først, deretter den arvede stien. |
| Innstillinger | Verdier eieren har lagret for configSchema-felt. |
NEBO_AGENT_ID | Den ansatte som gjør kallet. |
profileDirEnv | Kontomappen for denne ansatte og kontoen, når tillegget støtter kontoer. |
permissions.envAllow og permissions.envDeny begrenser hva tillegget arver fra boten. De fjerner aldri tilleggets egne autentiseringsvariabler.
Kontoer og påloggingsopplysninger
Et tillegg som logger inn på en tjeneste, bør ha én konto per ansatt. Regnskapsføreren logger inn med økonomipåloggingen og assistenten med sin egen, og ingen av dem ser den andres tokener. Du oppgir dette i manifestet; Nebo gjør 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.envnavngir påloggingsopplysningene.capabilities.configSchemagir dem etiketter og bestemmer rekkefølgen i tilkoblingsskjemaet.auth.profileDirEnvnavngir variabelen tillegget ditt leser for mappen med påloggingsopplysninger. Nebo oppretter én mappe for hver ansatt og konto og angir den variabelen ved hvert kall.- Når eieren kobler til en konto, kjører Nebo
login-kommandoen din med verdiene eieren skrev inn og kontomappen angitt. Tillegget ditt lagrer det det trenger i den mappen. Nebo beholder ikke verdiene. status-kommandoen din skriver ut JSON som{"authenticated": true}. Når et token utløper, kjører Neborefreshhvis du har oppgitt en.
For en nettleserinnlogging setter du type til oauth_cli og lar login skrive ut eller åpne leverandørens innloggings-URL. Ansatte logger aldri inn på egen hånd: når et kall trenger en innlogging, ser eieren et tilkoblingskort. En ansatt med flere kontoer velger én ved å legge til --account <label> i en kommando. Nebo fjerner det flagget før binærfilen din ser det.
Oppgi tjenesten, ikke formen. Navnet på et tillegg sier hva det kobler til, for eksempel «Example Notes». Skriv aldri «CLI» i navnet på et tillegg; for ansatte og eiere er det en tilkobling, ikke en kommandolinje.
Neste
- plugin.json-referanse: hvert felt, inkludert hendelser, hooks og typede operasjoner.
- Levere et tillegg: plattformer, binærfiler, signering og oppdateringer.
- Publisering: markedsplassflyten for alle typer innhold.