Näin laajennukset toimivat
Laajennus on suoritettava tiedosto ja manifesti. Nebo ei pidä laajennuksen prosessia käynnissä kutsujen välillä. Aina kun työntekijä käyttää laajennusta, Nebo käynnistää binäärin komennolla ja argumenteilla, odottaa sen päättymistä ja palauttaa tulosteen työntekijälle.
- Komennot ovat argumentteja. Työntekijä valitsee komennon, kuten
notes search, ja nimetyt argumentit. Nebo välittää jokaisen argumentin muodossa--name value. Komentotulkkia ei ole, joten putket ja uudelleenohjaukset eivät koskaan päde. - Tuloste on stdout. Kirjoita tulokset stdoutiin. JSON toimii hyvin.
- Vakiosyöte on suljettu tavallisissa kutsuissa. Koukut, reitit ja keskustelupalveluntarjoajat käyttävät stdiniä; katso plugin.json-viite.
Jokainen asennettu ja käytössä oleva laajennus näkyy työntekijöille yhtenä työkaluna nimeltä plugin__<slug>. Työntekijä kutsuu sitä näin:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo suorittaa:
notes-sync notes search --query "quarterly plan" --limit 5
| Parametri | Tyyppi | Merkitys |
|---|---|---|
command | merkkijono, pakollinen | Laajennuksen komento ja mahdolliset sijaintiin perustuvat sanat. |
args | merkkijono-objekti | Nimetyt argumentit. Jokaisesta tulee --key value. |
timeout | integer | Odotusaika sekunteina. Oletus 120, enintään manifestin permissions.maxTimeoutSeconds. |
display | string | Lause, jonka omistaja näkee, kun kutsu vaatii hyväksynnän. |
Rakenna ensimmäinen laajennuksesi
Kirjoita millä tahansa kielellä binääri, joka lukee komentonsa argumenteista ja tulostaa tuloksen. Laita se sitten plugin.json-tiedoston viereen botin käyttäjän laajennuskansioon.
<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 ja platforms ovat pakollisia. Käyttäjän laajennuskansiossa platforms-kartta voi olla tyhjä: Nebo etsii slugin mukaan nimettyä binääriä plugin.json-tiedoston vierestä ja sitten kansioista target/release/ ja target/debug/. Kun julkaiset, kauppa täyttää platforms-kentän jokaiselle lataamallesi binäärille.
<data> on macOS:ssä ~/Library/Application Support/Nebo, Windowsissa %APPDATA%\Nebo ja Linuxissa ~/.local/share/nebo, tai muuttujan NEBO_HOME arvo. Käyttäjän kansiossa oleva laajennus ohittaa kaupan samannimisen laajennuksen, joten se on oikea paikka testata uutta koontiversiota.
Opeta työntekijät käyttämään sitä
Laita skills/-kansio plugin.json-tiedoston viereen. Jokainen sen taito on kaikkien työntekijöiden käytettävissä niin kauan kuin laajennus on asennettuna, ja se merkitsee laajennuksen automaattisesti riippuvuudekseen. Kerro taidossa, mitä komentoja on, mitä ne palauttavat ja milloin kutakin käytetään. Nimeä hyödyllisimmät taidot kentässä entrySkills, jotta laajennuksen työkalukuvaus ohjaa niihin ensin.
Kaupan esittelysivu on erillinen tiedosto, PLUGIN.md. Nebo ei lue sitä ajon aikana; se on sivu, jonka ihmiset näkevät ennen asennusta. Katso Laajennuksen julkaiseminen.
Ympäristö
Jokainen kutsu perii botin ympäristön ilman lataaja- ja komentotulkki-injektiomuuttujia ja lisää sitten nämä arvot. Myöhemmät merkinnät voittavat.
| Muuttuja | Arvo |
|---|---|
auth.env-avaimet | Manifestin oletusarvot. |
<SLUG>_BIN | Tämän laajennuksen binäärin polku sekä jokaisen laajennuksen, josta se riippuu. Slug kirjoitetaan isoin kirjaimin ja yhdysmerkit alaviivoina. |
NEBO_DATA_DIR | Laajennuksen oma datakansio, <data>/appdata/plugins/<slug>/. Se on myös työhakemisto, ja se säilyy asennuksen poiston yli. |
PATH | Ensin laajennuskansiot, sitten peritty polku. |
| Asetukset | Arvot, jotka omistaja tallensi configSchema-kenttiin. |
NEBO_AGENT_ID | Kutsun tekevä työntekijä. |
profileDirEnv | Tämän työntekijän ja tilin tilikansio, kun laajennus tukee tilejä. |
permissions.envAllow ja permissions.envDeny rajaavat, mitä laajennus perii botilta. Ne eivät koskaan poista laajennuksen omia todennusmuuttujia.
Tilit ja tunnistetiedot
Palveluun kirjautuvalla laajennuksella pitäisi olla yksi tili työntekijää kohden. Kirjanpitäjä kirjautuu talouden tunnuksilla ja assistentti omillaan, eikä kumpikaan näe toisen tunnuksia. Määrität tämän manifestissa; Nebo hoitaa loput.
"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.envnimeää tunnistetiedot.capabilities.configSchemaantaa niille nimiöt ja määrää niiden järjestyksen yhdistämislomakkeessa.auth.profileDirEnvnimeää muuttujan, josta laajennuksesi lukee tunnistetietokansionsa. Nebo luo yhden kansion jokaiselle työntekijälle ja tilille ja asettaa muuttujan jokaisessa kutsussa.- Kun omistaja yhdistää tilin, Nebo suorittaa
login-komentosi omistajan kirjoittamilla arvoilla ja tilikansio asetettuna. Laajennuksesi tallentaa tarvitsemansa tähän kansioon. Nebo ei säilytä arvoja. status-komentosi tulostaa JSONia, kuten{"authenticated": true}. Kun tunnus vanhenee, Nebo suorittaarefresh-komennon, jos määrität sellaisen.
Selainkirjautumista varten aseta type-arvoksi oauth_cli ja anna login-komennon tulostaa tai avata palveluntarjoajan kirjautumisosoite. Työntekijät eivät koskaan kirjaudu itse: kun kutsu vaatii kirjautumista, omistaja näkee yhdistämiskortin. Työntekijä, jolla on useita tilejä, valitsee yhden lisäämällä komentoon --account <label>. Nebo poistaa tämän lipun ennen kuin binäärisi näkee sen.
Nimeä palvelu, älä muotoa. Laajennuksen nimi kertoo, mihin se yhdistää, esimerkiksi ”Example Notes”. Älä koskaan laita laajennuksen nimeen sanaa ”CLI”; työntekijöille ja omistajille se on yhteys, ei komentorivi.
Seuraavaksi
- plugin.json-viite: jokainen kenttä, myös tapahtumat, koukut ja tyypitetyt toiminnot.
- Laajennuksen julkaiseminen: alustat, binäärit, allekirjoitus ja päivitykset.
- Julkaiseminen: kaupan julkaisuprosessi kaikille tuotoksille.