NeboAI
NeboAI
Malite

Ntụaka plugin.json

plugin.json bụ manifest Nebo na-agụ iji wụnye ma gbaa plugin. Igodo dị na camelCase. Ibe a na-edepụta mpaghara ọ bụla Nebo na-agụ taa na ihe nke ọ bụla na-eme.

Mpaghara ọkwa elu

MpagharaỤdịA chọrọ yaIhe ọ pụtara
idstringeeNjirimara ahịa nke plugin ahụ. Jiri slug mgbe ị na-emepụta ya.
slugstringeeNjirimara kwụsiri ike. [a-z0-9-], ọ karịghị mkpụrụedemede 64, enweghị hyphen na mmalite, na njedebe ma ọ bụ hyphen abụọ. Ọ na-akpọ aha ngwaọrụ plugin__<slug> na mgbanwe <SLUG>_BIN.
namestringeeAha ngosi. Kpọọ aha ọrụ ọ na-ejikọ.
versionstringeeỤdị semantic, dị ka 0.1.0.
platformsmapeeIgodo nyiwe gaa na binary. Lee Nyiwe.
descriptionstringmbaOtu ahịrịokwu maka mmadụ na ndị ọrụ.
authorstringmbaAha onye mbipụta.
categorystringmbaNa-enyere ndị ọrụ aka ịchọta plugin ahụ.
triggersndepụta eriri okwumbaOkwu na-akọwa mgbe plugin ahụ dabara. A na-eji ya n'ndụmọdụ nchọta.
entrySkillsndepụta eriri okwumbaNka e kechiri ọnụ a ga-akpọ aha mbụ na nkọwa ngwaọrụ plugin ahụ.
dependenciesndepụta {name, version, optional}mbaPlugin ndị ọzọ nke a na-agba. version na-adị "*" site na ndabara; optional na-adị false. A na-etinye ụzọ <SLUG>_BIN ha na oku ọ bụla.
authobjectmbaỊbanye na akaụntụ. Lee Nkwenye.
capabilitiesobjectmbaconfigSchema, hooks, commands, routes, providers.
permissionsobjectmbaNzacha gburugburu na oke oge kachasị.
eventslistmbaNdị nche na-enye usoro ọrụ ndị ọrụ ihe.
interfaceBindingsmapmbaỌrụ nwere ụdị nke plugin ahụ na-enye.
channelobjectmbaAkwa mmiri na-adịgide adịgide gaa n'ọrụ ozi.
setupobjectmbaOnye nduzi nhazi nzọụkwụ na nzọụkwụ.

Nebo na-enyocha ihe e wụnyere site n'ahịa: iwu slug, ụdị semantic, ma ọ dịkarịa ala otu nyiwe, binaryName na-enweghị ihe nkewa ụzọ ma ọ bụ .., iwu login ma ọ bụrụ na auth.type abụghị env, aha ihe omume na iwu na-abụghị ihe efu, na ndebiri njikọ nwere ike ịgụ. Plugin dị na folda plugin onye ọrụ na-agafe nyocha.

Nyiwe

Igodo bụ darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 na windows-amd64. Ndenye ọ bụla nwere mpaghara ise niile dị n'okpuru. Mgbe ị bipụtara, ahịa na-ede hash n'ezie, nha, mbinye aka na URL nbudata, ya mere hapụ ha n'efu na faịlụ ị na-ebulite.

"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": "" }
}
MpagharaIhe ọ pụtara
binaryNameAha faịlụ nke ihe a na-agba. Tinye .exe na Windows.
sha256Hash nke binary ahụ. A na-enyocha ya mgbe a na-awụnye.
signatureMbinye aka nke binary ahụ. A na-enyocha ya mgbe a na-awụnye ma ọ bụrụ na igodo mbinye aka dị.
sizeNha na bytes.
downloadUrlEbe Nebo na-ebudata ngwugwu ahụ.

Nkwenye

MpagharaIhe ọ pụtara
typeoauth_cli maka ịbanye site na ihe nchọgharị nke plugin na-agba; env maka nzere a tinyere dị ka uru; neboai iji nata token NeboAI nke onye nwe ya n'igodo auth.env ọ bụla na-ejedebe na _TOKEN.
envMap nke aha mgbanwe gaa na uru ndabara. Ọ bụkwa naanị aha nzere Nebo na-enyefe login.
commands.loginNa-abanye. A chọrọ ya ma ọ bụrụ na type abụghị env. Ọ na-agba mgbe e debere folda akaụntụ ahụ.
commands.statusNa-ebipụta JSON na-ekwu ma akaụntụ ahụ abanyela.
commands.refreshNa-emeghari token na-enweghị mmekọrịta.
commands.logoutNa-apụ. Ọ bụ naanị onye nwe ya nwere ike ịgba ya.
profileDirEnvMgbanwe na-anata folda nzere dị iche maka onye ọrụ na akaụntụ ọ bụla. Na-enweghị ya, plugin ahụ na-ejide otu akaụntụ a na-ekerịta.
label, descriptionEderede dị na kaadị njikọ.
help{url, urlLabel, text} a na-egosi mgbe a na-ejikọ.
publicRedirectTinye true mgbe onye na-eweta ọrụ jụrụ ntụgharị http://localhost; ịbanye ga-esi n'ntụgharị ọha nke NeboAI.

Nebo na-agụ nke mbụ n'ime authenticated, isAuthenticated, logged_in, loggedIn ma ọ bụ token_valid na mwepụta ọnọdụ. token_error na-abụghị ihe efu, ma ọ bụ uru none na credential_source, auth_method, storage ma ọ bụ status, pụtara na ọ pụọla. Iwu ọnọdụ nwere sekọnd 45.

{"authenticated": true, "account": "finance@example.com"}

configSchema

capabilities.configSchema na-akọwa uru onye nwe ya na-etinye maka plugin ahụ. Uru ọ bụla na-eru binary ahụ dị ka mgbanwe gburugburu nke key kpọrọ aha. Maka igodo nzere e depụtakwara na auth.env, schema ahụ na-akpọ aha mpaghara nke fọm njikọ maka onye ọrụ ọ bụla.

MpagharaỤdịNdabaraIhe ọ pụtara
keystringa chọrọ yaAha mgbanwe gburugburu.
labelstringa chọrọ yaAha mpaghara.
descriptionstring""Ederede enyemaka.
fieldTypestring"string"Ụdị ntinye, dị ka string, number, boolean, select ma ọ bụ password.
defaultstringọ dịghịUru e jupụtara na mbụ.
requiredbooleanfalsePlugin ahụ adịghị njikere ruo mgbe e tinyere uru ahụ.
secretbooleanfalseA na-ekpuchi uru ahụ mgbe a na-agụghachi ya.
optionsndepụta eriri okwuọ dịghịNhọrọ maka select.

permissions

MpagharaNdabaraIhe ọ pụtara
envAllow[]Mgbanwe e ketara nke plugin ahụ nwere ike ịhụ. Ọ bụrụ na ọ tọgbọ chakoo, ọ na-ekwe ha niile.
envDeny[]Mgbanwe e ketara nke a na-ewepụ mgbe niile.
maxTimeoutSeconds300Oke kachasị maka oge njedebe nke oku ọ bụla.
networkfalseNa-ekwupụta iji netwọk. Ọ bụ maka ozi; a naghị amanye ya.

events

Ihe omume bụ onye nche na-agba ogologo oge. Nebo na-amalite ya mgbe usoro ọrụ onye ọrụ na-ele ya anya, ma malitekwa ya ọzọ ma ọ pụọ. Ahịrị ọ bụla onye nche ahụ dere na stdout bụ otu ihe omume. A na-etinye slug n'ihu aha ihe omume ahụ mgbe ọ na-agba, ya mere note.created na-aghọ notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
MpagharaIhe ọ pụtara
nameAha ihe omume, na-enweghị slug. A chọrọ ya.
commandArụmụka na-amalite onye nche ahụ. A chọrọ ya. A na-eji uru ntinye onye ọrụ ahụ dochie {{key}}.
descriptionIhe na-akpata ihe omume ahụ.
multiplexedMgbe ọ bụ true, otu onye nche na-ewepụta ọtụtụ ụdị ihe omume, ahịrị ọ bụla na-ebukwa mpaghara "event".

Usoro ọrụ na-edenye aha maka ihe omume site na ihe mkpalite watch. Lee Ihe mkpalite.

interfaceBindings

Njikọ na-ejikọ ọrụ interface na otu n'ime iwu gị. Njikọ ọ bụla na-aghọ ngwaọrụ nwere ụdị maka ndị ọrụ, nke a kpọrọ aha ọrụ ahụ na mkpụrụedemede nta, ebe ntụpọ na hyphen ghọrọ underscore: notes.search na-aghọ notes_search. Njikọ bụ otú plugin si emezu ikike onye ọrụ chọrọ; lee Ikike.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
Ihe nnọchiỌ na-agbasa ghọọ
{field}Uru mpaghara ahụ dị ka otu okwu. A naghị enyefekwa mpaghara ahụ dị ka flag.
{field[]:--flag}Otu ụzọ --flag <item> maka ihe ọ bụla dị na mpaghara ndepụta.
{field?:--flag}--flag <value> mgbe mpaghara ahụ dị; ọ dịghị ihe mgbe ọ na-adịghị.
{field:cents->dollars}Ọnụọgụ zuru oke na cents, e dere dị ka dollar.

A na-agbakwunye mpaghara ntinye ndebiri anaghị akpọ aha dị ka --field value. Ihe nnọchi ndepụta na nke nhọrọ ga-abụ okwu zuru oke. Ọrụ chọrọ nkwado enweghị ike iru site n'ịkpọ otu iwu ahụ site na plugin__<slug>.

Hooks, iwu slash na ụzọ

"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

Hook na-agba iwu gị n'otu ebe n'oge onye ọrụ na-eme ihe. Nebo na-ede JSON payload na stdin. A na-eleghara ihe hook action na-ewepụta anya. Hook filter na-eweghachi {"payload": ..., "handled": false}; "handled": true na-akwụsị hook ndị na-esote. Njehie na oge gafere na-edebe payload gara aga, ha anaghịkwa egbochi oge ahụ. Mgbe ọdịda atọ n'usoro, a na-akwụsịtụ hook ruo nkeji ise.

MpagharaNdabaraIhe ọ pụtara
hooka chọrọ yaOtu n'ime tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action ma ọ bụ filter.
commanda chọrọ yaArụmụka maka binary gị.
priority100Nke dị ala na-ebu ụzọ agba.
timeoutMs500Oke oge na millisekọnd.

commands

Site na "slash": true, ide /name args na nkata na-agba command args ozugbo, na-enweghị onye ọrụ ahụ. Mwepụta ahụ bụ azịza ya. Oke oge bụ sekọnd 30.

routes

Ụzọ na-aza arịrịọ HTTP na /api/v1/plugins/<slug>/api/<path> na bọt ahụ, nke e jikọtara site na path na method. Ahụ arịrịọ na-aga na stdin, stdout gị bụkwa nzaghachi. Oke oge bụ sekọnd 30.

providers

Onye na-eweta na-agbakwunye isi iyi ụdị nkata. Kwupụta id, displayName, providerType, modelsCommand na chatCommand. Nebo na-ezigara chatCommand arịrịọ nkata dị ka JSON na stdin ma gụọ ihe omume e mere ka ha na-asọ dị ka JSON e kewara site n'ahịrị ọhụrụ na stdout, ruo sekọnd 300. Ọ bụ naanị nkata na-asọ ka a na-eji taa.

channel

Ọwa na-ejikọ ọrụ ozi. Nebo na-eme ka command na-agba mgbe niile, na-agụ ozi na-abata site na stdout ya ma na-ede nzaghachi na stdin ya, ha abụọ dị ka JSON e kewara site n'ahịrị ọhụrụ.

MpagharaNdabaraIhe ọ pụtara
commanda chọrọ yaArụmụka na-amalite akwa mmiri ahụ.
name, description""A na-egosi ya na ntọala.
restartDelaySecs5Chere tupu ịmalite ọzọ mgbe ọ dara.
sharedfalseOtu akwa mmiri maka ndị ọrụ niile; a na-eduzi ozi site n'aha onye ọrụ, nzaghachi na-ebukwa njirimara onye ọrụ nke ọ bụla.
needsLocalApifalseNye akwa mmiri ahụ adreesị API mpaghara nke bọt ahụ, token na id onye ọrụ ahụ. Ọ na-anọ na mgbanyụ belụsọ na ịchọrọ ya.

setup

Ihe nduzi nhazi na-eduga onye nwe ya n'ime nzọụkwụ otu fọm na-apụghị ikpuchi. Uru sitere na nzọụkwụ form na-ejuputa {{key}} n'arụmụka generate na-esote. A na-echekwa uru sitere na nzọụkwụ credentials dịka environment variables nke plugin ahụ.

"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" }
  ]
}
Ụdị nzọụkwụMpaghara
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Na-egosi mwepụta iwu ahụ ka e depụta ya.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Nzọụkwụ ahụ na-agwụ mgbe verifyCommand gara nke ọma.

Mpaghara nwere key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) na required.