Chan nivo siperyè
| Chan | Tip | Obligatwa | Siyifikasyon |
|---|---|---|---|
id | string | wi | Idantifyan plugin la nan makètplas la. Sèvi ak slug la pandan w ap devlope. |
slug | string | wi | Idantifyan estab. [a-z0-9-], 64 karaktè pou pi plis, san tirè nan kòmansman, nan fen oswa de tirè youn dèyè lòt. Li bay non zouti plugin__<slug> la ak varyab <SLUG>_BIN la. |
name | string | wi | Non ki afiche. Bay non sèvis li konekte ak li a. |
version | string | wi | Vèsyon semantik, tankou 0.1.0. |
platforms | map | wi | Kle platfòm vè binè. Gade Platfòm. |
description | string | non | Yon fraz pou moun ak pou anplwaye yo. |
author | string | non | Non piblikatè a. |
category | string | non | Ede anplwaye yo jwenn plugin la. |
triggers | lis chèn karaktè | non | Mo ki dekri ki lè plugin la aplike. Yo sèvi ak yo nan sijesyon rechèch. |
entrySkills | lis chèn karaktè | non | Konpetans ki enkli pou nonmen an premye nan deskripsyon zouti plugin la. |
dependencies | lis {name, version, optional} | non | Lòt plugin plugin sa a itilize. version pa defo se "*"; optional pa defo se false. Chemen <SLUG>_BIN yo defini nan chak apèl. |
auth | object | non | Koneksyon ak kont. Gade Otantifikasyon. |
capabilities | object | non | configSchema, hooks, commands, routes, providers. |
permissions | object | non | Filtraj anviwònman an ak limit maksimòm delè a. |
events | list | non | Siveyan ki alimante pwosesis travay anplwaye yo. |
interfaceBindings | map | non | Operasyon tipe plugin la bay. |
channel | object | non | Yon pon pèmanan ak yon sèvis mesaj. |
setup | object | non | Yon asistan konfigirasyon etap pa etap. |
Nebo valide enstalasyon ki soti nan makètplas la: règ slug yo, yon vèsyon semantik, omwen yon platfòm, yon binaryName san separatè chemen ni .., yon kòmand login sòf si auth.type se env, non evènman ak kòmand ki pa vid, ak modèl liyezon ki ka analize. Plugin ki nan dosye plugin itilizatè a pa pase nan validasyon.
Platfòm
Kle yo se darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 ak windows-amd64. Chak antre gen tout senk chan ki anba yo. Lè w pibliye, makètplas la ekri vrè hash la, gwosè a, siyati a ak URL telechajman an, kidonk kite yo vid nan fichye w voye a.
"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": "" }
} | Chan | Siyifikasyon |
|---|---|
binaryName | Non fichye egzekitab la. Ajoute .exe sou Windows. |
sha256 | Hash binè a. Yo verifye l pandan enstalasyon an. |
signature | Siyati binè a. Yo verifye l pandan enstalasyon an lè gen yon kle siyati disponib. |
size | Gwosè an okte. |
downloadUrl | Kote Nebo telechaje pake a. |
Otantifikasyon
| Chan | Siyifikasyon |
|---|---|
type | oauth_cli pou yon koneksyon nan navigatè plugin la jere; env pou idantifyan yo antre kòm valè; neboai pou resevwa jeton NeboAI pwopriyetè a nan chak kle auth.env ki fini ak _TOKEN. |
env | Kat non varyab vè valè pa defo. Se tou sèl non idantifyan Nebo pase bay login. |
commands.login | Konekte. Obligatwa sòf si type se env. Li mache ak dosye kont lan defini. |
commands.status | Afiche JSON ki di si kont lan konekte. |
commands.refresh | Renouvle yon jeton san entèraksyon. |
commands.logout | Dekonekte. Se pwopriyetè a sèlman ki ka lanse l. |
profileDirEnv | Varyab ki resevwa yon dosye idantifyan apa pou chak anplwaye ak chak kont. San li, plugin la kenbe yon sèl kont pataje. |
label, description | Tèks sou kat koneksyon an. |
help | {url, urlLabel, text} ki parèt pandan koneksyon an ap fèt. |
publicRedirect | Mete true lè founisè a refize redireksyon http://localhost; konsa koneksyon an pase pa redireksyon piblik NeboAI a. |
Nebo li premye nan authenticated, isAuthenticated, logged_in, loggedIn oswa token_valid nan rezilta estati a. Yon token_error ki pa vid, oswa valè none nan credential_source, auth_method, storage oswa status, vle di kont lan dekonekte. Kòmand estati a gen 45 segonn.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema dekri valè yon pwopriyetè fikse pou plugin la. Chak valè rive nan binè a kòm yon varyab anviwònman ki pote non key la. Pou kle idantifyan ki nan lis auth.env tou, chema a bay etikèt chan fòm koneksyon chak anplwaye a.
| Chan | Tip | Pa defo | Siyifikasyon |
|---|---|---|---|
key | string | obligatwa | Non varyab anviwònman an. |
label | string | obligatwa | Etikèt chan an. |
description | string | "" | Tèks èd. |
fieldType | string | "string" | Tip antre, tankou string, number, boolean, select oswa password. |
default | string | okenn | Valè ki ranpli davans. |
required | boolean | false | Plugin la pa pare toutotan valè a pa defini. |
secret | boolean | false | Valè a kache lè yo li l ankò. |
options | lis chèn karaktè | okenn | Chwa pou select. |
permissions
| Chan | Pa defo | Siyifikasyon |
|---|---|---|
envAllow | [] | Varyab eritye plugin la gen dwa wè. Si li vid, tout pase. |
envDeny | [] | Varyab eritye ki toujou retire. |
maxTimeoutSeconds | 300 | Limit siperyè pou delè nenpòt apèl. |
network | false | Deklare itilizasyon rezo a. Pou enfòmasyon sèlman; yo pa aplike l. |
events
Yon evènman se yon siveyan ki mache pandan lontan. Nebo lanse l lè pwosesis travay yon anplwaye ap siveye l, e li relanse l si li kanpe. Chak liy siveyan an ekri nan stdout se yon evènman. Non evènman an pran slug la devan l lè l ap mache, konsa note.created vin notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Chan | Siyifikasyon |
|---|---|
name | Non evènman an, san slug la. Obligatwa. |
command | Agiman ki lanse siveyan an. Obligatwa. {{key}} ranplase pa valè antre anplwaye a. |
description | Sa ki lakòz evènman an. |
multiplexed | Lè li true, yon sèl siveyan emèt plizyè tip evènman e chak liy pote yon chan "event". |
Pwosesis travay yo abòne ak evènman yo avèk yon deklanchè watch. Gade Deklanchè.
interfaceBindings
Yon liyezon konekte yon operasyon entèfas ak youn nan kòmand ou yo. Chak liyezon vin yon zouti tipe pou anplwaye yo, ki pote non operasyon an an miniskil ak pwen ak tirè yo vin soulinyen: notes.search vin notes_search. Se avèk liyezon yon plugin satisfè kapasite yon anplwaye bezwen; gade Kapasite.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Kote pou ranplase | Vin tounen |
|---|---|
{field} | Valè chan an kòm yon sèl mo. Chan an pa pase kòm drapo tou. |
{field[]:--flag} | Yon pè --flag <item> pou chak eleman nan yon chan lis. |
{field?:--flag} | --flag <value> lè chan an la; anyen lè li pa la. |
{field:cents->dollars} | Yon montan antye an santim, ekri an dola. |
Chan antre yon modèl pa nonmen ajoute nan fen kòm --field value. Kote pou ranplase lis ak opsyonèl yo dwe mo antye. Yon operasyon ki bezwen apwobasyon pa ka rive si yo rele menm kòmand lan atravè plugin__<slug>.
Hook, kòmand slash ak wout
"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
Yon hook lanse kòmand ou nan yon moman pandan tou yon anplwaye. Nebo ekri yon payload JSON nan stdin. Yo inyore sa yon hook action bay. Yon hook filter retounen {"payload": ..., "handled": false}; "handled": true kanpe hook ki vin apre yo. Erè ak delè ki depase kenbe payload anvan an epi yo pa janm bloke tou a. Apre twa echèk youn dèyè lòt, yon hook mete an poz pou senk minit.
| Chan | Pa defo | Siyifikasyon |
|---|---|---|
hook | obligatwa | Youn nan tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action oswa filter. |
command | obligatwa | Agiman pou binè ou. |
priority | 100 | Sa ki pi ba a mache an premye. |
timeoutMs | 500 | Limit tan an milisegonn. |
commands
Avèk "slash": true, lè w tape /name args nan chat la, sa lanse command args dirèkteman, san anplwaye a. Rezilta a se repons lan. Limit tan an se 30 segonn.
routes
Yon wout reponn demann HTTP nan /api/v1/plugins/<slug>/api/<path> sou bot la, daprè path ak method. Kò demann lan ale nan stdin e stdout ou a se repons lan. Limit tan an se 30 segonn.
providers
Yon founisè ajoute yon sous modèl chat. Deklare id, displayName, providerType, modelsCommand ak chatCommand. Nebo voye yon demann chat an JSON sou stdin bay chatCommand e li li evènman an kouran kòm JSON separe pa liy sou stdout, pandan jiska 300 segonn. Se sèlman chat an kouran yo itilize jodi a.
channel
Yon chanèl fè pon ak yon sèvis mesaj. Nebo kenbe command ap mache, li li mesaj k ap antre nan stdout li e li ekri repons yo nan stdin li, toude kòm JSON separe pa liy.
| Chan | Pa defo | Siyifikasyon |
|---|---|---|
command | obligatwa | Agiman ki lanse pon an. |
name, description | "" | Parèt nan paramèt yo. |
restartDelaySecs | 5 | Tan pou tann anvan relanse apre yon pann. |
shared | false | Yon sèl pon pou tout anplwaye yo; mesaj yo dirije daprè non anplwaye a e repons yo pote idantite chak anplwaye. |
needsLocalApi | false | Bay pon an adrès API lokal bot la, yon jeton ak id anplwaye a. Dezaktive sòf si ou bezwen l. |
setup
Yon asistan konfigirasyon mennen pwopriyetè a atravè etap yon sèl fòmilè pa ka kouvri. Valè ki soti nan etap form ranpli {{key}} nan agiman generate ki vin apre yo. Valè ki soti nan etap credentials anrejistre kòm varyab anviwònman ekstansyon an.
"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" }
]
} | Kalite etap | Chan |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Li montre rezilta kòmand lan pou kopye. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Etap la fini lè verifyCommand reyisi. |
Chan yo gen key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) ak required.