NeboAI
NeboAI
Kezdés

Bővítmények

A bővítmény olyasmit ad a munkatársaknak, amin dolgozhatnak: egy online szolgáltatást, egy üzleti rendszert vagy egy programot a számítógépen. Parancssori binárisként készíti el, és plugin.json jegyzékkel írja le. A munkatársak meghívják a parancsait, a Nebo pedig gondoskodik a telepítésről, a munkatársankénti fiókokról és a frissítésekről.

Hogyan működnek a bővítmények

A bővítmény egy futtatható fájl és egy jegyzék. A Nebo nem tart futó bővítményfolyamatot a hívások között. Minden alkalommal, amikor egy munkatárs használja a bővítményt, a Nebo elindítja a binárist egy paranccsal és argumentumokkal, megvárja, amíg kilép, és visszaadja a kimenetet a munkatársnak.

  • A parancsok argumentumok. A munkatárs kiválaszt egy parancsot, például a notes search parancsot, és megnevezett argumentumokat. A Nebo minden argumentumot --name value formában ad át. Nincs shell, így csövek és átirányítások soha nem érvényesek.
  • A kimenet a stdout. Az eredményeket a stdoutra írja. A JSON jól működik.
  • A szabványos bemenet zárva van a szokásos hívásoknál. A hookok, útvonalak és csevegési szolgáltatók használják a stdint; lásd a plugin.json referenciát.

Minden telepített és engedélyezett bővítmény egyetlen, plugin__<slug> nevű eszközként jelenik meg a munkatársak számára. Egy munkatárs így hívja meg:

{
  "command": "notes search",
  "args": { "query": "quarterly plan", "limit": "5" },
  "display": "Search notes for the quarterly plan"
}

A Nebo ezt futtatja:

notes-sync notes search --query "quarterly plan" --limit 5
ParaméterTípusJelentés
commandkarakterlánc, kötelezőA bővítmény parancsa és az esetleges pozicionális szavak.
argskarakterláncokból álló objektumMegnevezett argumentumok. Mindegyikből --key value lesz.
timeoutintegerVárakozás másodpercben. Alapérték 120, felső határa a jegyzék permissions.maxTimeoutSeconds értéke.
displaystringA mondat, amelyet a tulajdonos lát, amikor a hívás jóváhagyást igényel.

Az első bővítmény elkészítése

Írjon bármilyen nyelven egy binárist, amely az argumentumokból olvassa a parancsát, és kiír egy eredményt. Ezután tegye egy plugin.json mellé egy bot felhasználói bővítménymappájába.

<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": {}
}

Az id, slug, name, version és platforms kötelező. A felhasználói bővítménymappában a platforms leképezés lehet üres: a Nebo a slug nevű binárist a plugin.json mellett keresi, majd a target/release/ és a target/debug/ mappában. Közzétételkor a piactér minden feltöltött binárishoz kitölti a platforms részt.

A <data> macOS-en a ~/Library/Application Support/Nebo, Windowson a %APPDATA%\Nebo, Linuxon a ~/.local/share/nebo, vagy a NEBO_HOME értéke. A felhasználói mappában lévő bővítmény felülírja az azonos slugú piactéri bővítményt, ezért itt érdemes tesztelni egy új buildet.

Tanítsa meg a munkatársaknak a használatát

Tegyen egy skills/ mappát a plugin.json mellé. A benne lévő minden készség elérhető minden munkatárs számára, amíg a bővítmény telepítve van, és automatikusan függőségként jelöli a bővítményt. A készségben írja le, milyen parancsok léteznek, mit adnak vissza, és mikor melyiket érdemes használni. A leghasznosabb készségeket nevezze meg az entrySkills mezőben, hogy a bővítmény eszközleírása elsőként rájuk mutasson.

A piactéri adatlap egy külön fájl, a PLUGIN.md. A Nebo futás közben nem olvassa be; ez az az oldal, amelyet az emberek telepítés előtt látnak. Lásd: Bővítmény kiadása.

Környezet

Minden hívás örökli a bot környezetét a betöltő- és shell-injektálási változók nélkül, majd hozzáadja ezeket az értékeket. A későbbi bejegyzések felülírják a korábbiakat.

VáltozóÉrték
auth.env kulcsokAlapértékek a jegyzékből.
<SLUG>_BINA bővítmény binárisának, valamint minden olyan bővítménynek az elérési útja, amelytől függ. A slug nagybetűs, a kötőjelek helyén aláhúzással.
NEBO_DATA_DIRA bővítmény saját adatmappája, <data>/appdata/plugins/<slug>/. Ez egyben a munkakönyvtár is, és eltávolítás után is megmarad.
PATHElőbb a bővítménymappák, majd az örökölt útvonal.
BeállításokA tulajdonos által a configSchema mezőkhöz mentett értékek.
NEBO_AGENT_IDA hívást indító munkatárs.
profileDirEnvAz adott munkatárs és fiók fiókmappája, ha a bővítmény támogatja a fiókokat.

A permissions.envAllow és a permissions.envDeny szűkíti, mit örököl a bővítmény a bottól. A bővítmény saját hitelesítési változóit soha nem távolítják el.

Fiókok és hitelesítő adatok

Egy szolgáltatásba bejelentkező bővítménynek munkatársanként egy fiókot kell kezelnie. A könyvelő a pénzügyi belépéssel jelentkezik be, az asszisztens a sajátjával, és egyikük sem látja a másik tokenjeit. Ezt a jegyzékben adja meg; a többit a Nebo intézi.

"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 }
  ]
}
  1. Az auth.env megnevezi a hitelesítő adatokat. A capabilities.configSchema címkéket ad nekik, és meghatározza a sorrendjüket a csatlakozási űrlapon.
  2. Az auth.profileDirEnv azt a változót nevezi meg, amelyből a bővítmény a hitelesítőadat-mappáját olvassa. A Nebo minden munkatárshoz és fiókhoz létrehoz egy mappát, és minden hívásnál beállítja ezt a változót.
  3. Amikor a tulajdonos csatlakoztat egy fiókot, a Nebo lefuttatja az Ön login parancsát a tulajdonos által beírt értékekkel és a beállított fiókmappával. A bővítmény ebbe a mappába menti, amire szüksége van. A Nebo nem tárolja az értékeket.
  4. A status parancsa JSON-t ír ki, például {"authenticated": true}. Amikor egy token lejár, a Nebo futtatja a refresh parancsot, ha megad ilyet.

Böngészős bejelentkezéshez állítsa a type értékét oauth_cli-ra, és a login írja ki vagy nyissa meg a szolgáltató bejelentkezési URL-jét. A munkatársak soha nem jelentkeznek be maguktól: amikor egy hívás bejelentkezést igényel, a tulajdonos csatlakozási kártyát lát. Egy több fiókkal rendelkező munkatárs úgy választ közülük, hogy a parancshoz hozzáadja a --account <label> kapcsolót. A Nebo eltávolítja ezt a kapcsolót, mielőtt a bináris megkapná.

A szolgáltatást nevezze meg, ne a formát. A bővítmény neve azt mondja meg, mihez kapcsolódik, például „Example Notes”. Soha ne írja a „CLI” szót a bővítmény nevébe; a munkatársak és a tulajdonosok számára ez kapcsolat, nem parancssor.

Következő