Kijan plugin yo mache
Yon plugin se yon egzekitab plis yon manifès. Nebo pa kenbe okenn pwosesis plugin k ap mache ant apèl yo. Chak fwa yon anplwaye sèvi ak plugin la, Nebo lanse binè a ak yon kòmand ak agiman, li tann li fini, epi li remèt rezilta a bay anplwaye a.
- Kòmand yo se agiman. Anplwaye a chwazi yon kòmand, tankou
notes search, ak agiman ki gen non. Nebo pase chak agiman kòm--name value. Pa gen shell, kidonk tiyo ak redireksyon pa janm aplike. - Rezilta a se stdout. Ekri rezilta yo nan stdout. JSON mache byen.
- Antre estanda a fèmen pou apèl òdinè. Hook, wout ak founisè chat yo sèvi ak stdin; gade referans plugin.json la.
Chak plugin ki enstale e ki aktive parèt devan anplwaye yo kòm yon sèl zouti ki rele plugin__<slug>. Yon anplwaye rele l konsa:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo lanse:
notes-sync notes search --query "quarterly plan" --limit 5
| Paramèt | Tip | Siyifikasyon |
|---|---|---|
command | chèn karaktè, obligatwa | Kòmand plugin la ak nenpòt mo pozisyonèl. |
args | objè chèn karaktè | Agiman ki gen non. Chak vin --key value. |
timeout | integer | Segonn pou tann. Pa defo 120, limite pa permissions.maxTimeoutSeconds manifès la. |
display | string | Fraz pwopriyetè a wè lè apèl la bezwen apwobasyon. |
Konstwi premye plugin ou
Ekri yon binè nan nenpòt langaj ki li kòmand li nan agiman yo epi ki afiche yon rezilta. Apre sa mete l bò kote yon plugin.json nan dosye plugin itilizatè yon 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 ak platforms obligatwa. Nan dosye plugin itilizatè a, kat platforms la ka vid: Nebo chèche yon binè ki pote non slug la bò kote plugin.json, apre sa nan target/release/ ak target/debug/. Lè w pibliye, makètplas la ranpli platforms pou chak binè ou voye.
<data> se ~/Library/Application Support/Nebo sou macOS, %APPDATA%\Nebo sou Windows, ak ~/.local/share/nebo sou Linux, oswa valè NEBO_HOME. Yon plugin nan dosye itilizatè a pran plas yon plugin makètplas ki gen menm slug la, sa ki fè l bon kote pou teste yon nouvo konpilasyon.
Aprann anplwaye yo sèvi avè l
Mete yon dosye skills/ bò kote plugin.json. Chak konpetans ladan l disponib pou chak anplwaye toutotan plugin la enstale, e li mete plugin la kòm depandans otomatikman. Sèvi ak konpetans lan pou di ki kòmand ki egziste, sa yo retounen, ak ki lè pou sèvi ak chak. Nonmen konpetans ki pi itil yo nan entrySkills pou deskripsyon zouti plugin la montre yo an premye.
Fich makètplas la se yon fichye apa, PLUGIN.md. Nebo pa li l pandan l ap mache; se paj moun wè anvan yo enstale. Gade Pibliye yon plugin.
Anviwònman
Chak apèl eritye anviwònman bot la san varyab chajè ak varyab enjeksyon shell yo, apre sa li ajoute valè sa yo. Sa ki vini apre yo genyen.
| Varyab | Valè |
|---|---|
Kle auth.env | Valè pa defo ki soti nan manifès la. |
<SLUG>_BIN | Chemen binè plugin sa a, ak chak plugin li depann de li. Slug la ekri an majiskil ak tirè yo vin soulinyen. |
NEBO_DATA_DIR | Pwòp dosye done plugin la, <data>/appdata/plugins/<slug>/. Se li tou ki dosye travay la, e li rete apre dezenstalasyon. |
PATH | Dosye plugin yo an premye, apre sa chemen eritye a. |
| Paramèt | Valè pwopriyetè a anrejistre pou chan configSchema yo. |
NEBO_AGENT_ID | Anplwaye k ap fè apèl la. |
profileDirEnv | Dosye kont pou anplwaye sa a ak kont sa a, lè plugin la sipòte kont. |
permissions.envAllow ak permissions.envDeny limite sa plugin la eritye nan bot la. Yo pa janm retire pwòp varyab otantifikasyon plugin la.
Kont ak idantifyan
Yon plugin ki konekte nan yon sèvis ta dwe kenbe yon kont pou chak anplwaye. Kontab la konekte ak idantifyan finans lan e asistan an ak pa l, e youn pa wè jeton lòt la. Ou deklare sa nan manifès la; Nebo fè rès la.
"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.envbay non idantifyan yo.capabilities.configSchemaba yo etikèt e li fikse lòd yo nan fòm koneksyon an.auth.profileDirEnvbay non varyab plugin ou li pou dosye idantifyan li. Nebo kreye yon dosye pou chak anplwaye ak chak kont e li defini varyab sa a nan chak apèl.- Lè pwopriyetè a konekte yon kont, Nebo lanse kòmand
loginou a ak valè pwopriyetè a tape yo epi dosye kont lan defini. Plugin ou anrejistre sa li bezwen nan dosye sa a. Nebo pa kenbe valè yo. - Kòmand
statusou a enprime JSON tankou{"authenticated": true}. Lè yon jeton ekspire, Nebo lanserefreshsi ou deklare youn.
Pou yon koneksyon nan navigatè, mete type sou oauth_cli epi fè login afiche oswa louvri URL koneksyon founisè a. Anplwaye yo pa janm konekte pou kont yo: lè yon apèl bezwen koneksyon, pwopriyetè a wè yon kat koneksyon. Yon anplwaye ki gen plizyè kont chwazi youn lè li ajoute --account <label> nan yon kòmand. Nebo retire drapo sa a anvan binè ou wè l.
Bay non sèvis la, pa fòm nan. Non yon plugin di ak kisa li konekte, tankou "Example Notes". Pa janm mete "CLI" nan non yon plugin; pou anplwaye yo ak pwopriyetè yo, se yon koneksyon, pa yon liy kòmand.
Apre sa
- Referans plugin.json: chak chan, ansanm ak evènman, hook ak operasyon tipe.
- Pibliye yon plugin: platfòm, binè, siyati ak mizajou.
- Piblikasyon: pwosesis makètplas la pou chak kreyasyon.