NeboAI
NeboAI
Anza

Marejeleo ya plugin.json

plugin.json ni manifesti ambayo Nebo husoma ili kusakinisha na kuendesha programu-jalizi. Funguo zimeandikwa kwa camelCase. Ukurasa huu unaorodhesha kila sehemu ambayo Nebo husoma leo na kazi ya kila moja.

Sehemu za ngazi ya juu

SehemuAinaInahitajikaMaana
idstringndiyoKitambulisho cha programu-jalizi sokoni. Tumia slug wakati wa kuunda.
slugstringndiyoKitambulisho thabiti. [a-z0-9-], herufi 64 kwa zaidi, bila kistari mwanzoni, mwishoni wala kistari mara mbili. Hutaja zana ya plugin__<slug> na kigezo cha <SLUG>_BIN.
namestringndiyoJina la kuonyeshwa. Taja huduma inayounganishwa nayo.
versionstringndiyoToleo la kisemantiki, kama 0.1.0.
platformsmapndiyoUfunguo wa jukwaa kwenda kwenye faili tekelezi. Tazama Majukwaa.
descriptionstringhapanaSentensi moja kwa watu na wafanyakazi.
authorstringhapanaJina la mchapishaji.
categorystringhapanaHuwasaidia wafanyakazi kupata programu-jalizi.
triggersorodha ya maandishihapanaManeno yanayoeleza wakati programu-jalizi inatumika. Hutumika katika vidokezo vya utafutaji.
entrySkillsorodha ya maandishihapanaUjuzi uliojumuishwa wa kutajwa kwanza katika maelezo ya zana ya programu-jalizi.
dependenciesorodha ya {name, version, optional}hapanaProgramu-jalizi nyingine ambazo hii huendesha. version kwa chaguo-msingi ni "*"; optional ni false. Njia zao za <SLUG>_BIN huwekwa kwenye kila mwito.
authobjecthapanaKuingia na akaunti. Tazama Auth.
capabilitiesobjecthapanaconfigSchema, hooks, commands, routes, providers.
permissionsobjecthapanaUchujaji wa mazingira na kikomo cha juu cha muda.
eventslisthapanaVifuatiliaji vinavyolisha mitiririko ya kazi ya wafanyakazi.
interfaceBindingsmaphapanaShughuli zenye aina ambazo programu-jalizi hutoa.
channelobjecthapanaDaraja la kudumu kwenda kwenye huduma ya ujumbe.
setupobjecthapanaMchawi wa usanidi wa hatua kwa hatua.

Nebo huthibitisha usakinishaji kutoka sokoni: kanuni za slug, toleo la kisemantiki, angalau jukwaa moja, binaryName isiyo na vitenganishi vya njia wala .., amri ya login isipokuwa auth.type ni env, majina ya matukio na amri yasiyo tupu, na violezo vya ufungaji vinavyochanganuliwa vizuri. Programu-jalizi zilizo kwenye saraka ya programu-jalizi za mtumiaji haziuthibitishwi.

Majukwaa

Funguo ni darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 na windows-amd64. Kila kipengee kina sehemu zote tano zilizo hapa chini. Unapochapisha, soko huandika hashi halisi, ukubwa, sahihi na URL ya kupakua, kwa hiyo ziache tupu katika faili unayopakia.

"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": "" }
}
SehemuMaana
binaryNameJina la faili tekelezi. Ongeza .exe kwenye Windows.
sha256Hashi ya faili tekelezi. Hukaguliwa wakati wa kusakinisha.
signatureSahihi ya faili tekelezi. Hukaguliwa wakati wa kusakinisha ufunguo wa kutia sahihi unapopatikana.
sizeUkubwa kwa baiti.
downloadUrlMahali Nebo inapopakua kifurushi.

Auth

SehemuMaana
typeoauth_cli kwa kuingia kupitia kivinjari kunakoendeshwa na programu-jalizi; env kwa vitambulisho vinavyoingizwa kama thamani; neboai ili kupokea tokeni ya NeboAI ya mmiliki katika kila ufunguo wa auth.env unaoishia na _TOKEN.
envRamani ya jina la kigezo kwenda thamani ya chaguo-msingi. Pia ndiyo majina pekee ya vitambulisho ambayo Nebo hupitisha kwa login.
commands.loginHuingia. Inahitajika isipokuwa type ni env. Huendeshwa folda ya akaunti ikiwa imewekwa.
commands.statusHuchapisha JSON inayoeleza kama akaunti imeingia.
commands.refreshHuhuisha tokeni bila mwingiliano.
commands.logoutHutoka. Mmiliki pekee ndiye anayeweza kuiendesha.
profileDirEnvKigezo kinachopokea folda tofauti ya vitambulisho kwa kila mfanyakazi na akaunti. Bila hicho programu-jalizi hushikilia akaunti moja ya pamoja.
label, descriptionMaandishi kwenye kadi ya kuunganisha.
help{url, urlLabel, text} huonyeshwa wakati wa kuunganisha.
publicRedirectWeka true mtoa huduma anapokataa uelekezaji upya wa http://localhost; kuingia hupitia uelekezaji upya wa umma wa NeboAI.

Nebo husoma ya kwanza kati ya authenticated, isAuthenticated, logged_in, loggedIn au token_valid katika tokeo la hali. token_error isiyo tupu, au thamani none katika credential_source, auth_method, storage au status, inamaanisha hajaingia. Amri ya hali ina sekunde 45.

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

configSchema

capabilities.configSchema hueleza thamani ambazo mmiliki huweka kwa programu-jalizi. Kila thamani hufika kwenye faili tekelezi kama kigezo cha mazingira kilichopewa jina na key. Kwa funguo za vitambulisho zilizoorodheshwa pia katika auth.env, schema huweka lebo kwenye sehemu za fomu ya kuunganisha ya kila mfanyakazi.

SehemuAinaChaguo-msingiMaana
keystringinahitajikaJina la kigezo cha mazingira.
labelstringinahitajikaLebo ya sehemu.
descriptionstring""Maandishi ya msaada.
fieldTypestring"string"Aina ya ingizo, kama string, number, boolean, select au password.
defaultstringhakunaThamani iliyojazwa mapema.
requiredbooleanfalseProgramu-jalizi haiko tayari hadi thamani iwekwe.
secretbooleanfalseThamani hufichwa inaposomwa tena.
optionsorodha ya maandishihakunaMachaguo ya select.

permissions

SehemuChaguo-msingiMaana
envAllow[]Vigezo vilivyorithiwa ambavyo programu-jalizi inaweza kuona. Tupu huruhusu vyote.
envDeny[]Vigezo vilivyorithiwa ambavyo huondolewa kila mara.
maxTimeoutSeconds300Kikomo cha juu cha muda wa mwito wowote.
networkfalseHutangaza matumizi ya mtandao. Ni kwa taarifa tu; hailazimishwi.

events

Tukio ni kifuatiliaji kinachoendeshwa kwa muda mrefu. Nebo hukianzisha mtiririko wa kazi wa mfanyakazi unapokifuatilia, na hukianzisha upya kikitoka. Kila mstari ambao kifuatiliaji huandika kwenye stdout ni tukio moja. Jina la tukio hutanguliwa na slug wakati wa kuendesha, kwa hiyo note.created huwa notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
SehemuMaana
nameJina la tukio, bila slug. Inahitajika.
commandHoja zinazoanzisha kifuatiliaji. Inahitajika. {{key}} hubadilishwa kwa thamani za ingizo za mfanyakazi.
descriptionKinachosababisha tukio.
multiplexedIkiwa true, kifuatiliaji kimoja hutoa aina kadhaa za matukio na kila mstari hubeba sehemu ya "event".

Mitiririko ya kazi hujisajili kwa matukio kwa kichochezi cha watch. Tazama Vichochezi.

interfaceBindings

Ufungaji huunganisha shughuli ya kiolesura na mojawapo ya amri zako. Kila ufungaji huwa zana yenye aina kwa wafanyakazi, iliyopewa jina la shughuli kwa herufi ndogo na nukta na vistari vikiwa mistari ya chini: notes.search huwa notes_search. Ufungaji ndiyo njia ambayo programu-jalizi hutimiza uwezo ambao mfanyakazi anauhitaji; tazama Uwezo.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
Kishika nafasiHupanuka kuwa
{field}Thamani ya sehemu kama neno moja. Sehemu haipitishwi pia kama bendera.
{field[]:--flag}Jozi moja ya --flag <item> kwa kila kipengee katika sehemu ya orodha.
{field?:--flag}--flag <value> sehemu ikiwepo; hakuna kitu ikikosekana.
{field:cents->dollars}Kiasi kamili kwa senti, kikiandikwa kama dola.

Sehemu za ingizo ambazo kiolezo hakizitaji huongezwa mwishoni kama --field value. Vishika nafasi vya orodha na vya hiari lazima viwe maneno kamili. Shughuli inayohitaji idhini haiwezi kufikiwa kwa kuita amri hiyo hiyo kupitia plugin__<slug>.

Hooks, amri za kufyeka na njia

"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 huendesha amri yako katika hatua fulani ya zamu ya mfanyakazi. Nebo huandika data ya JSON kwenye stdin. Matokeo ya hook ya action hupuuzwa. Hook ya filter hurudisha {"payload": ..., "handled": false}; "handled": true husimamisha hook zinazofuata. Hitilafu na kuisha kwa muda huhifadhi data ya awali na kamwe hazizuii zamu. Baada ya kushindwa mara tatu mfululizo, hook husitishwa kwa dakika tano.

SehemuChaguo-msingiMaana
hookinahitajikaMojawapo ya tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action au filter.
commandinahitajikaHoja za faili tekelezi yako.
priority100Ya chini huendeshwa kwanza.
timeoutMs500Kikomo cha muda kwa milisekunde.

commands

Kwa "slash": true, kuandika /name args kwenye gumzo huendesha command args moja kwa moja, bila mfanyakazi. Tokeo ndilo jibu. Kikomo cha muda ni sekunde 30.

routes

Njia hujibu maombi ya HTTP katika /api/v1/plugins/<slug>/api/<path> kwenye boti, yakilinganishwa kwa path na method. Mwili wa ombi huenda kwenye stdin na stdout yako ndiyo jibu. Kikomo cha muda ni sekunde 30.

providers

Mtoa huduma huongeza chanzo cha muundo wa gumzo. Tangaza id, displayName, providerType, modelsCommand na chatCommand. Nebo hutuma ombi la gumzo kama JSON kwenye stdin kwa chatCommand na husoma matukio yanayotiririshwa kama JSON iliyotenganishwa kwa mistari mipya kwenye stdout, kwa hadi sekunde 300. Utiririshaji wa gumzo pekee ndio unaotumika leo.

channel

Chaneli huunganisha huduma ya ujumbe. Nebo huiacha command ikiendelea kuendeshwa, husoma ujumbe unaoingia kutoka kwenye stdout yake na huandika majibu kwenye stdin yake, vyote kama JSON iliyotenganishwa kwa mistari mipya.

SehemuChaguo-msingiMaana
commandinahitajikaHoja zinazoanzisha daraja.
name, description""Huonyeshwa kwenye mipangilio.
restartDelaySecs5Subiri kabla ya kuanzisha upya baada ya hitilafu.
sharedfalseDaraja moja kwa wafanyakazi wote; ujumbe hupitishwa kwa jina la mfanyakazi na majibu hubeba utambulisho wa kila mfanyakazi.
needsLocalApifalseIpe daraja anwani ya API ya ndani ya boti, tokeni na kitambulisho cha mfanyakazi. Imezimwa isipokuwa unaihitaji.

setup

Mchawi wa usanidi humwongoza mmiliki kupitia hatua ambazo fomu moja haiwezi kushughulikia. Thamani kutoka hatua za form hujaza {{key}} katika hoja za generate zinazofuata. Thamani kutoka hatua za credentials huhifadhiwa kama vigezo vya mazingira vya programu-jalizi.

"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" }
  ]
}
Aina ya hatuaSehemu
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Huonyesha tokeo la amri ili kunakiliwa.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Hatua hukamilika verifyCommand inapofaulu.

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