Felső szintű mezők
| Mező | Típus | Kötelező | Jelentés |
|---|---|---|---|
id | string | igen | A bővítmény piactéri azonosítója. Fejlesztés közben használja a slugot. |
slug | string | igen | Állandó azonosító. [a-z0-9-], legfeljebb 64 karakter, nem kezdődhet és nem végződhet kötőjellel, és nem tartalmazhat dupla kötőjelet. Ez adja a plugin__<slug> eszköz és a <SLUG>_BIN változó nevét. |
name | string | igen | Megjelenített név. Nevezze meg a szolgáltatást, amelyhez kapcsolódik. |
version | string | igen | Szemantikus verzió, például 0.1.0. |
platforms | map | igen | Platformkulcs és bináris összerendelése. Lásd: Platformok. |
description | string | nem | Egy mondat embereknek és munkatársaknak. |
author | string | nem | A kiadó neve. |
category | string | nem | Segít a munkatársaknak megtalálni a bővítményt. |
triggers | karakterláncok listája | nem | Szavak, amelyek leírják, mikor alkalmazható a bővítmény. Keresési javaslatokhoz használatos. |
entrySkills | karakterláncok listája | nem | A csomagban lévő készségek, amelyeket elsőként kell megnevezni a bővítmény eszközleírásában. |
dependencies | {name, version, optional} listája | nem | Más bővítmények, amelyeket ez futtat. A version alapértéke "*", az optional értéke false. A <SLUG>_BIN elérési útjaik minden hívásnál be vannak állítva. |
auth | object | nem | Bejelentkezés és fiókok. Lásd: Hitelesítés. |
capabilities | object | nem | configSchema, hooks, commands, routes, providers. |
permissions | object | nem | Környezeti szűrés és az időkorlát felső határa. |
events | list | nem | Figyelők, amelyek a munkatársak munkafolyamatait táplálják. |
interfaceBindings | map | nem | A bővítmény által nyújtott típusos műveletek. |
channel | object | nem | Tartós híd egy üzenetküldő szolgáltatás felé. |
setup | object | nem | Lépésenkénti beállítási varázsló. |
A Nebo ellenőrzi a piactéri telepítéseket: a slug szabályait, a szemantikus verziót, legalább egy platformot, az útvonal-elválasztót és .. részt nem tartalmazó binaryName értéket, a login parancsot (hacsak az auth.type nem env), a nem üres eseményneveket és parancsokat, valamint azt, hogy a kötési sablonok értelmezhetők-e. A felhasználói bővítménymappában lévő bővítmények kihagyják az ellenőrzést.
Platformok
A kulcsok: darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 és windows-amd64. Minden bejegyzés tartalmazza az alábbi öt mezőt. Közzétételkor a piactér beírja a valódi hasht, méretet, aláírást és letöltési URL-t, ezért a feltöltött fájlban hagyja ezeket üresen.
"platforms": {
"darwin-arm64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"linux-amd64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
} | Mező | Jelentés |
|---|---|
binaryName | A futtatható fájl neve. Windowson tegye hozzá a .exe kiterjesztést. |
sha256 | A bináris hashe. Telepítéskor ellenőrzi. |
signature | A bináris aláírása. Telepítéskor ellenőrzi, ha elérhető aláírókulcs. |
size | Méret bájtban. |
downloadUrl | Ahonnan a Nebo letölti a csomagot. |
Hitelesítés
| Mező | Jelentés |
|---|---|
type | oauth_cli a bővítmény által futtatott böngészős bejelentkezéshez; env értékként megadott hitelesítő adatokhoz; neboai, hogy a bővítmény megkapja a tulajdonos NeboAI-tokenjét minden _TOKEN végű auth.env kulcsban. |
env | Változónév és alapérték összerendelése. Egyben ezek az egyetlen hitelesítőadat-nevek, amelyeket a Nebo átad a login parancsnak. |
commands.login | Bejelentkeztet. Kötelező, hacsak a type nem env. A fiókmappa beállításával fut. |
commands.status | JSON-t ír ki arról, hogy a fiók be van-e jelentkezve. |
commands.refresh | Felhasználói beavatkozás nélkül megújít egy tokent. |
commands.logout | Kijelentkeztet. Csak a tulajdonos futtathatja. |
profileDirEnv | Változó, amely munkatársanként és fiókonként külön hitelesítőadat-mappát kap. Enélkül a bővítmény egyetlen közös fiókot használ. |
label, description | A csatlakozási kártya szövege. |
help | Csatlakozás közben megjelenő {url, urlLabel, text}. |
publicRedirect | Állítsa true értékre, ha a szolgáltató elutasítja a http://localhost átirányításokat; ekkor a bejelentkezés a NeboAI nyilvános átirányításán keresztül történik. |
A Nebo az állapotkimenetben az elsőt olvassa be a következők közül: authenticated, isAuthenticated, logged_in, loggedIn vagy token_valid. Egy nem üres token_error, vagy a none érték a credential_source, auth_method, storage vagy status mezőben kijelentkezett állapotot jelent. Az állapotparancsnak 45 másodperce van.
{"authenticated": true, "account": "finance@example.com"} configSchema
A capabilities.configSchema azokat az értékeket írja le, amelyeket a tulajdonos beállít a bővítményhez. Minden érték a key által megnevezett környezeti változóként jut el a binárishoz. Az auth.env alatt is felsorolt hitelesítőadat-kulcsok esetén a séma a munkatársankénti csatlakozási űrlap mezőinek címkéit adja.
| Mező | Típus | Alapérték | Jelentés |
|---|---|---|---|
key | string | kötelező | Környezeti változó neve. |
label | string | kötelező | A mező címkéje. |
description | string | "" | Súgószöveg. |
fieldType | string | "string" | Bemeneti típus, például string, number, boolean, select vagy password. |
default | string | nincs | Előre kitöltött érték. |
required | boolean | false | A bővítmény addig nem áll készen, amíg az érték nincs beállítva. |
secret | boolean | false | Visszaolvasáskor az érték maszkolva jelenik meg. |
options | karakterláncok listája | nincs | Választási lehetőségek a select típushoz. |
permissions
| Mező | Alapérték | Jelentés |
|---|---|---|
envAllow | [] | Örökölt változók, amelyeket a bővítmény láthat. Üresen mindet engedi. |
envDeny | [] | Örökölt változók, amelyek mindig eltávolításra kerülnek. |
maxTimeoutSeconds | 300 | Bármely hívás időkorlátjának felső határa. |
network | false | Hálózathasználatot jelez. Tájékoztató jellegű; nincs kikényszerítve. |
events
Az esemény egy hosszan futó figyelő. A Nebo akkor indítja el, amikor egy munkatárs munkafolyamata figyeli, és újraindítja, ha leáll. A figyelő által a stdoutra írt minden sor egy esemény. Futáskor az esemény neve elé kerül a slug, így a note.created ebből lesz: notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Mező | Jelentés |
|---|---|
name | Az esemény neve slug nélkül. Kötelező. |
command | A figyelőt elindító argumentumok. Kötelező. A {{key}} helyére a munkatárs bemeneti értékei kerülnek. |
description | Mi váltja ki az eseményt. |
multiplexed | Ha true, egy figyelő több eseménytípust bocsát ki, és minden sor tartalmaz egy "event" mezőt. |
A munkafolyamatok watch indítóval iratkoznak fel az eseményekre. Lásd: Indítók.
interfaceBindings
A kötés egy interfészműveletet rendel az Ön egyik parancsához. Minden kötésből típusos eszköz lesz a munkatársak számára, amelynek neve a művelet neve kisbetűvel, a pontok és kötőjelek helyén aláhúzással: a notes.search ebből lesz: notes_search. A bővítmény a kötésekkel teljesíti azokat a képességeket, amelyeket egy munkatárs megkövetel; lásd: Képességek.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Helyőrző | Erre bővül |
|---|---|
{field} | A mező értéke egyetlen szóként. A mezőt nem adja át kapcsolóként is. |
{field[]:--flag} | Egy --flag <item> pár egy listamező minden eleméhez. |
{field?:--flag} | --flag <value>, ha a mező jelen van; semmi, ha hiányzik. |
{field:cents->dollars} | Centben megadott egész összeg, dollárban kiírva. |
A sablon által meg nem nevezett bemeneti mezők --field value formában a végére kerülnek. A lista- és opcionális helyőrzőknek teljes szavaknak kell lenniük. Egy jóváhagyást igénylő művelet nem érhető el úgy, hogy ugyanazt a parancsot a plugin__<slug> eszközön keresztül hívják meg.
Hookok, perjeles parancsok és útvonalak
"capabilities": {
"hooks": [
{ "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
],
"commands": [
{ "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
],
"routes": [
{ "path": "/callback", "method": "GET", "command": "http callback" }
]
} hooks
A hook az Ön parancsát futtatja egy munkatárs körének egy adott pontján. A Nebo JSON-adatot ír a stdin bemenetre. Az action hook kimenetét a rendszer figyelmen kívül hagyja. A filter hook {"payload": ..., "handled": false} értéket ad vissza; a "handled": true leállítja a későbbi hookokat. Hibák és időtúllépések esetén az előző adat marad meg, és a kör soha nem akad el. Három egymást követő hiba után a hook öt percre szünetel.
| Mező | Alapérték | Jelentés |
|---|---|---|
hook | kötelező | A következők egyike: tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action vagy filter. |
command | kötelező | Argumentumok a binárisához. |
priority | 100 | Az alacsonyabb fut előbb. |
timeoutMs | 500 | Időkorlát ezredmásodpercben. |
commands
A "slash": true beállítással a csevegésbe írt /name args közvetlenül futtatja a command args parancsot, a munkatárs nélkül. A kimenet a válasz. Az időkorlát 30 másodperc.
routes
Az útvonal a boton a /api/v1/plugins/<slug>/api/<path> címen válaszol HTTP-kérésekre, a path és a method alapján illesztve. A kérés törzse a stdinre kerül, az Ön stdout kimenete pedig a válasz. Az időkorlát 30 másodperc.
providers
A szolgáltató egy csevegőmodell-forrást ad hozzá. Adja meg az id, displayName, providerType, modelsCommand és chatCommand értékeket. A Nebo a csevegési kérést JSON-ként küldi a chatCommand stdin bemenetére, és legfeljebb 300 másodpercig olvassa a stdoutról a soronként elválasztott JSON formátumú, folyamatosan érkező eseményeket. Jelenleg csak a csevegés folyamatos továbbítása használatos.
channel
A csatorna egy üzenetküldő szolgáltatást köt be. A Nebo folyamatosan futtatja a command parancsot, a stdoutjáról olvassa a bejövő üzeneteket, és a stdinjére írja a válaszokat, mindkettőt soronként elválasztott JSON-ként.
| Mező | Alapérték | Jelentés |
|---|---|---|
command | kötelező | A hidat elindító argumentumok. |
name, description | "" | A beállításokban jelenik meg. |
restartDelaySecs | 5 | Várakozás összeomlás utáni újraindítás előtt. |
shared | false | Egy híd az összes munkatársnak; az üzenetek a munkatárs neve alapján kerülnek továbbításra, és a válaszok az egyes munkatársak identitását hordozzák. |
needsLocalApi | false | Megadja a hídnak a bot helyi API-címét, egy tokent és a munkatárs azonosítóját. Kikapcsolva, hacsak nincs rá szüksége. |
setup
A beállítási varázsló végigvezeti a tulajdonost azokon a lépéseken, amelyeket egyetlen űrlap nem tud lefedni. A form lépések értékei kitöltik a {{key}} helyőrzőket a későbbi generate argumentumokban. A credentials lépések értékei a bővítmény környezeti változóiként mentődnek.
"setup": {
"title": "Connect Example Chat",
"steps": [
{ "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
{ "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
{ "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
{ "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
]
} | Lépés típusa | Mezők |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Megjeleníti a parancs kimenetét másoláshoz. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. A lépés akkor teljesül, amikor a verifyCommand sikeresen lefut. |
A mezők tulajdonságai: key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) és required.