Àwọn àyè ìpele òkè
| Àyè | Irú | Dandan | Ìtumọ̀ |
|---|---|---|---|
id | string | bẹ́ẹ̀ ni | Àmì ìdánimọ̀ plugin náà ní ọjà. Lo slug nígbà tí o bá ń ṣe ìdàgbàsókè. |
slug | string | bẹ́ẹ̀ ni | Àmì ìdánimọ̀ tí kì í yí padà. [a-z0-9-], ó pọ̀jù ohun-kíkọ 64, kò sí àmì-ìsopọ̀ (hyphen) ní ìbẹ̀rẹ̀, ní òpin tàbí méjì papọ̀. Ó ń dárúkọ irinṣẹ́ plugin__<slug> àti àyípadà <SLUG>_BIN. |
name | string | bẹ́ẹ̀ ni | Orúkọ ìfihàn. Dárúkọ iṣẹ́ tí ó ń so pọ̀ mọ́. |
version | string | bẹ́ẹ̀ ni | Ẹ̀yà oní-ìtumọ̀ (semantic version), bí 0.1.0. |
platforms | map | bẹ́ẹ̀ ni | Kọ́kọ́rọ́ pèpéle sí binary. Wo Platforms. |
description | string | rárá | Gbólóhùn kan fún àwọn ènìyàn àti àwọn òṣìṣẹ́. |
author | string | rárá | Orúkọ olùtẹ̀jáde. |
category | string | rárá | Ó ń ran àwọn òṣìṣẹ́ lọ́wọ́ láti rí plugin náà. |
triggers | àkójọ àwọn ọ̀rọ̀ (strings) | rárá | Àwọn ọ̀rọ̀ tí ń ṣàpèjúwe ìgbà tí plugin náà wúlò. A ń lò wọ́n nínú àwọn ìtọ́ka ìwádìí. |
entrySkills | àkójọ àwọn ọ̀rọ̀ (strings) | rárá | Àwọn ọgbọ́n tí a dì pọ̀ láti dárúkọ ṣáájú nínú àpèjúwe irinṣẹ́ plugin náà. |
dependencies | àkójọ {name, version, optional} | rárá | Àwọn plugin mìíràn tí èyí ń ṣiṣẹ́. version ń lọ sí "*" ní àtilẹ̀wá; optional sí false. A ń ṣètò ipa ọ̀nà <SLUG>_BIN wọn lórí ìpè kọ̀ọ̀kan. |
auth | object | rárá | Ìwọlé àti àwọn àkọọ́lẹ̀. Wo Auth. |
capabilities | object | rárá | configSchema, hooks, commands, routes, providers. |
permissions | object | rárá | Ìsẹ́ àyíká àti òkè àkókò ìdúró. |
events | list | rárá | Àwọn olùṣọ́ tí ń bọ́ àwọn ìlànà iṣẹ́ òṣìṣẹ́. |
interfaceBindings | map | rárá | Àwọn iṣẹ́ onírú tí plugin náà ń pèsè. |
channel | object | rárá | Afárá tí ó wà títí lọ sí iṣẹ́ ìfiránṣẹ́ kan. |
setup | object | rárá | Olùtọ́sọ́nà ìṣètò ìgbésẹ̀-sí-ìgbésẹ̀. |
Nebo ń fìdí àwọn ìfisórí láti ọjà múlẹ̀: àwọn òfin slug, ẹ̀yà oní-ìtumọ̀, ó kéré tán pèpéle kan, binaryName tí kò ní àmì ìyàsọ́tọ̀ ipa ọ̀nà tàbí .., àṣẹ login àyàfi tí auth.type bá jẹ́ env, orúkọ ìṣẹ̀lẹ̀ àti àṣẹ tí kò ṣófo, àti àwọn àwòṣe ìsopọ̀ (binding templates) tí ó ṣeé túmọ̀. Àwọn plugin nínú fódà plugin olùmúlò kì í kọjá ìfìdímúlẹ̀ yìí.
Àwọn pèpéle
Àwọn kọ́kọ́rọ́ ni darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 àti windows-amd64. Ohun kọ̀ọ̀kan ní gbogbo àyè márààrún tí ó wà nísàlẹ̀. Nígbà tí o bá tẹ̀jáde, ọjà ń kọ hash gidi, ìwọ̀n, ìbuwọ́lù àti URL ìgbàsílẹ̀, nítorí náà fi wọ́n sílẹ̀ ní òfo nínú fáìlì tí o gbé sókè.
"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": "" }
} | Àyè | Ìtumọ̀ |
|---|---|
binaryName | Orúkọ fáìlì ohun tí ó ṣeé ṣiṣẹ́. Ṣàfikún .exe lórí Windows. |
sha256 | Hash binary náà. A ń ṣàyẹ̀wò rẹ̀ nígbà ìfisórí. |
signature | Ìbuwọ́lù binary náà. A ń ṣàyẹ̀wò rẹ̀ nígbà ìfisórí tí kọ́kọ́rọ́ ìbuwọ́lù bá wà. |
size | Ìwọ̀n ní bytes. |
downloadUrl | Ibi tí Nebo ti ń ṣe ìgbàsílẹ̀ àpò náà. |
Auth
| Àyè | Ìtumọ̀ |
|---|---|
type | oauth_cli fún ìwọlé nínú aṣàwákiri tí plugin náà ń ṣiṣẹ́; env fún àwọn ìwé ẹ̀rí tí a tẹ̀ wọlé gẹ́gẹ́ bí iye; neboai láti gba token NeboAI ẹni tó ni í nínú gbogbo kọ́kọ́rọ́ auth.env tí ó parí pẹ̀lú _TOKEN. |
env | Àkójọ orúkọ àyípadà sí iye àtilẹ̀wá. Àwọn wọ̀nyí tún ni orúkọ ìwé ẹ̀rí kan ṣoṣo tí Nebo ń fi ránṣẹ́ sí login. |
commands.login | Ó ń wọlé. Ó pọn dandan àyàfi tí type bá jẹ́ env. Ó ń ṣiṣẹ́ pẹ̀lú fódà àkọọ́lẹ̀ tí a ti ṣètò. |
commands.status | Ó ń tẹ JSON jáde tí ó sọ bóyá àkọọ́lẹ̀ náà ti wọlé. |
commands.refresh | Ó ń sọ token dọ̀tun láìsí ìbáṣepọ̀. |
commands.logout | Ó ń jáde. Ẹni tó ni í nìkan ló lè ṣiṣẹ́ rẹ̀. |
profileDirEnv | Àyípadà tí ń gba fódà ìwé ẹ̀rí ìwọlé ọ̀tọ̀ fún òṣìṣẹ́ àti àkọọ́lẹ̀ kọ̀ọ̀kan. Láìsí i, plugin náà ń mú àkọọ́lẹ̀ kan ṣoṣo tí gbogbo wọn ń pín. |
label, description | Ọ̀rọ̀ lórí káàdì ìsopọ̀. |
help | {url, urlLabel, text} tí a ń fi hàn nígbà ìsopọ̀. |
publicRedirect | Ṣètò rẹ̀ sí true nígbà tí olùpèsè bá kọ àwọn ìdarí http://localhost; ìwọlé yóò wá gba ìdarí gbangba NeboAI kọjá. |
Nebo ń ka èyí tí ó kọ́kọ́ wà nínú authenticated, isAuthenticated, logged_in, loggedIn tàbí token_valid nínú àbájáde ipò. token_error tí kò ṣófo, tàbí iye none nínú credential_source, auth_method, storage tàbí status, túmọ̀ sí pé ó ti jáde. Àṣẹ ipò ní ìṣẹ́jú-àáyá 45.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema ń ṣàpèjúwe àwọn iye tí ẹni tó ni í ń ṣètò fún plugin náà. Iye kọ̀ọ̀kan ń dé ọ̀dọ̀ binary gẹ́gẹ́ bí àyípadà àyíká tí key dárúkọ. Fún àwọn kọ́kọ́rọ́ ìwé ẹ̀rí tí ó tún wà nínú auth.env, schema náà ń fi àmì sí àwọn àyè fọ́ọ̀mù ìsopọ̀ fún òṣìṣẹ́ kọ̀ọ̀kan.
| Àyè | Irú | Àtilẹ̀wá | Ìtumọ̀ |
|---|---|---|---|
key | string | dandan | Orúkọ àyípadà àyíká. |
label | string | dandan | Àmì àyè. |
description | string | "" | Ọ̀rọ̀ ìrànlọ́wọ́. |
fieldType | string | "string" | Irú ìwọlé, bí string, number, boolean, select tàbí password. |
default | string | kò sí | Iye tí a ti kọ sílẹ̀ ṣáájú. |
required | boolean | false | Plugin náà kò tíì ṣetán títí a ó fi ṣètò iye náà. |
secret | boolean | false | A ń bo iye náà mọ́lẹ̀ nígbà tí a bá kà á padà. |
options | àkójọ àwọn ọ̀rọ̀ (strings) | kò sí | Àwọn àṣàyàn fún select. |
permissions
| Àyè | Àtilẹ̀wá | Ìtumọ̀ |
|---|---|---|
envAllow | [] | Àwọn àyípadà tí a jogún tí plugin náà lè rí. Bí ó bá ṣófo, gbogbo wọn ni a gbà láàyè. |
envDeny | [] | Àwọn àyípadà tí a jogún tí a máa ń yọ kúrò nígbà gbogbo. |
maxTimeoutSeconds | 300 | Òkè ààlà fún àkókò ìdúró ìpè èyíkéyìí. |
network | false | Ó ń kéde lílo nẹ́tíwọ́ọ̀kì. Fún ìmọ̀ nìkan ni; a kì í fi múni. |
events
Ìṣẹ̀lẹ̀ kan jẹ́ olùṣọ́ tí ń ṣiṣẹ́ fún ìgbà pípẹ́. Nebo ń bẹ̀rẹ̀ rẹ̀ nígbà tí ìlànà iṣẹ́ òṣìṣẹ́ kan bá ń ṣọ́ ọ, ó sì ń tún un bẹ̀rẹ̀ bí ó bá jáde. Ìlà kọ̀ọ̀kan tí olùṣọ́ náà bá kọ sí stdout jẹ́ ìṣẹ̀lẹ̀ kan. A ń fi slug ṣáájú orúkọ ìṣẹ̀lẹ̀ náà nígbà ìṣiṣẹ́, nítorí náà note.created ń di notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Àyè | Ìtumọ̀ |
|---|---|
name | Orúkọ ìṣẹ̀lẹ̀, láìsí slug. Ó pọn dandan. |
command | Àwọn àríyànjiyàn (arguments) tí ń bẹ̀rẹ̀ olùṣọ́ náà. Ó pọn dandan. A ń fi àwọn iye ìwọlé òṣìṣẹ́ náà rọ́pò {{key}}. |
description | Ohun tí ń fa ìṣẹ̀lẹ̀ náà. |
multiplexed | Nígbà tí ó bá jẹ́ true, olùṣọ́ kan ń gbé oríṣiríṣi ìṣẹ̀lẹ̀ jáde, ìlà kọ̀ọ̀kan sì ní àyè "event". |
Àwọn ìlànà iṣẹ́ ń forúkọ sílẹ̀ fún àwọn ìṣẹ̀lẹ̀ pẹ̀lú ohun ìbẹ̀rẹ̀ watch. Wo Àwọn ohun ìbẹ̀rẹ̀.
interfaceBindings
Ìsopọ̀ (binding) kan ń so iṣẹ́ interface kan mọ́ ọ̀kan nínú àwọn àṣẹ rẹ. Ìsopọ̀ kọ̀ọ̀kan ń di irinṣẹ́ onírú fún àwọn òṣìṣẹ́, tí a dárúkọ lẹ́yìn iṣẹ́ náà ní lẹ́tà kékeré tí a fi underscore rọ́pò àwọn àmì ìdúró (dots) àti hyphen: notes.search ń di notes_search. Àwọn ìsopọ̀ ni ọ̀nà tí plugin kan fi ń pèsè àwọn agbára tí òṣìṣẹ́ kan nílò; wo Àwọn agbára.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Àmì àyè | Ó ń di |
|---|---|
{field} | Iye àyè náà gẹ́gẹ́ bí ọ̀rọ̀ kan. A kò tún fi àyè náà ránṣẹ́ gẹ́gẹ́ bí flag. |
{field[]:--flag} | Ẹ̀ẹ̀kan --flag <item> fún ohun kọ̀ọ̀kan nínú àyè oníàkójọ. |
{field?:--flag} | --flag <value> nígbà tí àyè náà bá wà; kò sí nǹkankan nígbà tí kò bá sí. |
{field:cents->dollars} | Iye owó odidi ní sẹ́ǹtì, tí a kọ ní dọ́là. |
Àwọn àyè ìwọlé tí àwòṣe kan kò dárúkọ ni a ń so mọ́ ìparí gẹ́gẹ́ bí --field value. Àwọn àmì àyè oníàkójọ àti èyí tí kò pọn dandan gbọ́dọ̀ jẹ́ odidi ọ̀rọ̀. Iṣẹ́ tí ó nílò ìfọwọ́sí kò ṣeé dé nípa pípe àṣẹ kan náà nípasẹ̀ plugin__<slug>.
Hooks, àwọn àṣẹ slash àti routes
"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 máa ń ṣiṣẹ́ àṣẹ rẹ ní àkókò kan nínú ìyípo òṣìṣẹ́ kan. Nebo máa ń kọ JSON payload sí stdin. A kò ka àbájáde hook action sí. Hook filter máa ń dá {"payload": ..., "handled": false} padà; "handled": true máa ń dá àwọn hook tí ó tẹ̀lé e dúró. Àwọn àṣìṣe àti àkókò tí ó tán máa ń pa payload ti tẹ́lẹ̀ mọ́, wọn kì í sì í dí ìyípo náà lọ́wọ́ láé. Lẹ́yìn ìkùnà mẹ́ta léraléra, a máa dá hook kan dúró fún ìṣẹ́jú márùn-ún.
| Àyè | Àtilẹ̀wá | Ìtumọ̀ |
|---|---|---|
hook | dandan | Ọ̀kan nínú tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action tàbí filter. |
command | dandan | Àwọn àríyànjiyàn fún binary rẹ. |
priority | 100 | Èyí tí ó kéré ló ń kọ́kọ́ ṣiṣẹ́. |
timeoutMs | 500 | Ààlà àkókò ní mílíṣẹ́kọ́ǹdì. |
commands
Pẹ̀lú "slash": true, títẹ /name args nínú ìjíròrò ń ṣiṣẹ́ command args tààrà, láìsí òṣìṣẹ́ náà. Àbájáde ni èsì. Ààlà àkókò jẹ́ ìṣẹ́jú-àáyá 30.
routes
Route kan ń dáhùn àwọn ìbéèrè HTTP ní /api/v1/plugins/<slug>/api/<path> lórí bot náà, tí a bá mu pẹ̀lú path àti method. Ara ìbéèrè náà ń lọ sí stdin, stdout rẹ sì ni ìdáhùn. Ààlà àkókò jẹ́ ìṣẹ́jú-àáyá 30.
providers
Olùpèsè kan ń ṣàfikún orísun àwòṣe ìjíròrò. Kéde id, displayName, providerType, modelsCommand àti chatCommand. Nebo ń fi ìbéèrè ìjíròrò ránṣẹ́ gẹ́gẹ́ bí JSON lórí stdin sí chatCommand, ó sì ń ka àwọn ìṣẹ̀lẹ̀ tí ń ṣàn wá gẹ́gẹ́ bí JSON tí a fi ìlà tuntun yà sọ́tọ̀ lórí stdout, fún ìṣẹ́jú-àáyá 300 ó pọ̀jù. Ìṣàn ìjíròrò nìkan ni a ń lò lónìí.
channel
Ìkànnì kan ń so iṣẹ́ ìfiránṣẹ́ kan pọ̀. Nebo ń jẹ́ kí command máa ṣiṣẹ́ lọ, ó ń ka àwọn ìránṣẹ́ tí ń wọlé láti stdout rẹ̀, ó sì ń kọ àwọn èsì sí stdin rẹ̀, méjèèjì gẹ́gẹ́ bí JSON tí a fi ìlà tuntun yà sọ́tọ̀.
| Àyè | Àtilẹ̀wá | Ìtumọ̀ |
|---|---|---|
command | dandan | Àwọn àríyànjiyàn tí ń bẹ̀rẹ̀ afárá náà. |
name, description | "" | A ń fi hàn nínú ètò. |
restartDelaySecs | 5 | Dúró kí o tó tún bẹ̀rẹ̀ lẹ́yìn tí ó bá já. |
shared | false | Afárá kan fún gbogbo òṣìṣẹ́; a ń darí àwọn ìránṣẹ́ nípa orúkọ òṣìṣẹ́, àwọn èsì sì ń gbé ìdánimọ̀ òṣìṣẹ́ kọ̀ọ̀kan. |
needsLocalApi | false | Fún afárá náà ní àdírẹ́sì API agbègbè bot náà, token kan àti id òṣìṣẹ́ náà. Ó wà ní pípa àyàfi tí o bá nílò rẹ̀. |
setup
Olùtọ́sọ́nà ìṣètò máa ń mú olúwa la àwọn ìgbésẹ̀ tí fọ́ọ̀mù kan ṣoṣo kò lè bò kọjá. Àwọn iye láti àwọn ìgbésẹ̀ form máa ń kún {{key}} nínú àwọn àríyànjiyàn generate tí ó tẹ̀lé e. Àwọn iye láti àwọn ìgbésẹ̀ credentials ni a máa ń fi pamọ́ gẹ́gẹ́ bí àwọn environment variable plugin náà.
"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" }
]
} | Irú ìgbésẹ̀ | Àwọn àyè |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Ó ń fi àbájáde àṣẹ náà hàn fún ẹ̀dà. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Ìgbésẹ̀ náà ń parí nígbà tí verifyCommand bá yọrí sí rere. |
Àwọn àyè ní key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) àti required.