Bí àwọn plugin ṣe ń ṣiṣẹ́
Plugin kan jẹ́ ohun tí ó ṣeé ṣiṣẹ́ pẹ̀lú manifest kan. Nebo kì í jẹ́ kí ìlànà plugin kankan máa ṣiṣẹ́ láàárín àwọn ìpè. Ìgbàkígbà tí òṣìṣẹ́ kan bá lo plugin náà, Nebo ń bẹ̀rẹ̀ binary náà pẹ̀lú àṣẹ àti àwọn àríyànjiyàn, ó ń dúró kí ó jáde, ó sì ń dá àbájáde padà fún òṣìṣẹ́ náà.
- Àwọn àṣẹ jẹ́ àríyànjiyàn. Òṣìṣẹ́ náà ń yan àṣẹ kan, bí
notes search, àti àwọn àríyànjiyàn tí a dárúkọ. Nebo ń fi àríyànjiyàn kọ̀ọ̀kan ránṣẹ́ gẹ́gẹ́ bí--name value. Kò sí shell, nítorí náà pipes àti redirects kì í ṣiṣẹ́ láé. - Àbájáde ni stdout. Kọ àwọn àbájáde sí stdout. JSON ń ṣiṣẹ́ dáadáa.
- Ìwọlé boṣewa ti wà ní títì fún àwọn ìpè lásán. Hooks, routes àti àwọn olùpèsè ìjíròrò ń lo stdin; wo ìtọ́kasí plugin.json.
Gbogbo plugin tí a ti fi sórí ẹ̀rọ tí a sì ti tàn ń farahàn sí àwọn òṣìṣẹ́ gẹ́gẹ́ bí irinṣẹ́ kan tí a ń pè ní plugin__<slug>. Òṣìṣẹ́ kan ń pè é báyìí:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo ń ṣiṣẹ́:
notes-sync notes search --query "quarterly plan" --limit 5
| Pàrámítà | Irú | Ìtumọ̀ |
|---|---|---|
command | string, dandan | Àṣẹ plugin náà àti àwọn ọ̀rọ̀ ipò èyíkéyìí. |
args | object àwọn ọ̀rọ̀ (strings) | Àwọn àríyànjiyàn tí a dárúkọ. Ọ̀kọ̀ọ̀kan ń di --key value. |
timeout | integer | Ìṣẹ́jú-àáyá láti dúró. Àtilẹ̀wá jẹ́ 120, pẹ̀lú òkè ààlà permissions.maxTimeoutSeconds manifest náà. |
display | string | Gbólóhùn tí ẹni tó ni í ń rí nígbà tí ìpè náà bá nílò ìfọwọ́sí. |
Kọ plugin àkọ́kọ́ rẹ
Kọ binary ní èdè èyíkéyìí tí ń ka àṣẹ rẹ̀ láti inú àwọn àríyànjiyàn tí ó sì ń tẹ àbájáde jáde. Lẹ́yìn náà fi sí ẹ̀gbẹ́ plugin.json kan nínú fódà plugin olùmúlò ti bot kan.
<data>/user/plugins/notes-sync/
├── plugin.json # runtime manifest
├── notes-sync # your binary, named after the slug
└── skills/ # optional: skills that teach employees to use it
└── notes-sync/
└── SKILL.md {
"id": "notes-sync",
"slug": "notes-sync",
"name": "Notes Sync",
"version": "0.1.0",
"description": "Search, read and create notes in Example Notes.",
"platforms": {}
} id, slug, name, version àti platforms pọn dandan. Nínú fódà plugin olùmúlò, àkójọ platforms lè ṣófo: Nebo ń wá binary tí a dárúkọ bí slug ní ẹ̀gbẹ́ plugin.json, lẹ́yìn náà nínú target/release/ àti target/debug/. Nígbà tí o bá tẹ̀jáde, ọjà ń kún platforms fún gbogbo binary tí o gbé sókè.
<data> ni ~/Library/Application Support/Nebo lórí macOS, %APPDATA%\Nebo lórí Windows, àti ~/.local/share/nebo lórí Linux, tàbí iye NEBO_HOME. Plugin kan nínú fódà olùmúlò ń borí plugin ọjà tí ó ní slug kan náà, èyí sì sọ ọ́ di ibi tí a ti ń dán ẹ̀yà tuntun wò.
Kọ́ àwọn òṣìṣẹ́ bí wọ́n ṣe ń lò ó
Fi fódà skills/ sí ẹ̀gbẹ́ plugin.json. Ọgbọ́n kọ̀ọ̀kan nínú rẹ̀ wà fún gbogbo òṣìṣẹ́ nígbà tí plugin náà bá wà lórí ẹ̀rọ, ó sì ń kọ plugin náà sílẹ̀ gẹ́gẹ́ bí ohun tí ó gbára lé láìfọwọ́yí. Lo ọgbọ́n náà láti sọ àwọn àṣẹ tí ó wà, ohun tí wọ́n ń dá padà, àti ìgbà tí a ó lo ọ̀kọ̀ọ̀kan. Dárúkọ àwọn ọgbọ́n tí ó wúlò jù nínú entrySkills kí àpèjúwe irinṣẹ́ plugin náà lè kọ́kọ́ tọ́ka sí wọn.
Àkọsílẹ̀ ọjà jẹ́ fáìlì ọ̀tọ̀, PLUGIN.md. Nebo kì í kà á nígbà ìṣiṣẹ́; òun ni ojú ìwé tí àwọn ènìyàn ń rí kí wọ́n tó fi sórí ẹ̀rọ. Wo Fífi plugin ránṣẹ́.
Àyíká
Ìpè kọ̀ọ̀kan ń jogún àyíká bot náà, a yọ àwọn àyípadà loader àti ìfisínú shell kúrò, lẹ́yìn náà a ṣàfikún àwọn iye wọ̀nyí. Àwọn tí ó tẹ̀lé e ló ń borí.
| Àyípadà | Iye |
|---|---|
Àwọn kọ́kọ́rọ́ auth.env | Àwọn àtilẹ̀wá láti inú manifest. |
<SLUG>_BIN | Ipa ọ̀nà binary plugin yìí, àti ti plugin kọ̀ọ̀kan tí ó gbára lé. A ń kọ slug ní lẹ́tà ńlá, a sì ń fi underscore rọ́pò hyphen. |
NEBO_DATA_DIR | Fódà dátà tirẹ̀ plugin náà, <data>/appdata/plugins/<slug>/. Òun náà ni fódà iṣẹ́, ó sì ń wà títí lẹ́yìn yíyọ kúrò. |
PATH | Àwọn fódà plugin kọ́kọ́, lẹ́yìn náà ipa ọ̀nà tí a jogún. |
| Ètò | Àwọn iye tí ẹni tó ni í fi pamọ́ fún àwọn àyè configSchema. |
NEBO_AGENT_ID | Òṣìṣẹ́ tí ń ṣe ìpè náà. |
profileDirEnv | Fódà àkọọ́lẹ̀ fún òṣìṣẹ́ àti àkọọ́lẹ̀ yìí, nígbà tí plugin náà bá ṣàtìlẹ́yìn fún àwọn àkọọ́lẹ̀. |
permissions.envAllow àti permissions.envDeny ń dín ohun tí plugin náà ń jogún láti ọ̀dọ̀ bot kù. Wọn kì í yọ àwọn àyípadà ìwọlé tirẹ̀ plugin náà kúrò láé.
Àwọn àkọọ́lẹ̀ àti ìwé ẹ̀rí ìwọlé
Plugin tí ń wọlé sí iṣẹ́ kan gbọ́dọ̀ mú àkọọ́lẹ̀ kan fún òṣìṣẹ́ kọ̀ọ̀kan. Akọ̀wé owó ń wọlé pẹ̀lú ìwọlé ẹ̀ka ìnáwó, olùrànlọ́wọ́ sì ń wọlé pẹ̀lú tirẹ̀, kò sí ẹnì kankan nínú wọn tí ń rí token èkejì. O ń kéde èyí nínú manifest; Nebo ń ṣe ìyókù.
"auth": {
"type": "env",
"label": "Example Notes account",
"env": { "EXAMPLE_NOTES_TOKEN": "" },
"commands": { "login": "auth login", "status": "auth status", "logout": "auth logout" },
"profileDirEnv": "EXAMPLE_NOTES_CONFIG_DIR"
},
"capabilities": {
"configSchema": [
{ "key": "EXAMPLE_NOTES_TOKEN", "label": "API token", "fieldType": "password", "secret": true, "required": true }
]
} auth.envń dárúkọ àwọn ìwé ẹ̀rí.capabilities.configSchemań fi àmì sí wọn ó sì ń ṣètò bí wọ́n ṣe tò lẹ́sẹẹsẹ nínú fọ́ọ̀mù ìsopọ̀.auth.profileDirEnvń dárúkọ àyípadà tí plugin rẹ ń kà fún fódà ìwé ẹ̀rí rẹ̀. Nebo ń ṣẹ̀dá fódà kan fún òṣìṣẹ́ àti àkọọ́lẹ̀ kọ̀ọ̀kan, ó sì ń ṣètò àyípadà náà lórí gbogbo ìpè.- Nígbà tí ẹni tó ni í bá so àkọọ́lẹ̀ kan pọ̀, Nebo ń ṣiṣẹ́ àṣẹ
loginrẹ pẹ̀lú àwọn iye tí ẹni tó ni í tẹ̀ àti fódà àkọọ́lẹ̀ tí a ti ṣètò. Plugin rẹ ń fi ohun tí ó nílò pamọ́ sínú fódà náà. Nebo kì í tọ́jú àwọn iye náà. - Àṣẹ
statusrẹ máa ń tẹ JSON jáde bíi{"authenticated": true}. Nígbà tí tókìnì kan bá parí, Nebo máa ń ṣiṣẹ́refreshbí o bá kéde rẹ̀.
Fún ìwọlé nínú aṣàwákiri, ṣètò type sí oauth_cli kí login sì tẹ URL ìwọlé olùpèsè náà jáde tàbí ṣí i. Àwọn òṣìṣẹ́ kì í wọlé fúnra wọn láé: nígbà tí ìpè kan bá nílò ìwọlé, ẹni tó ni í ń rí káàdì ìsopọ̀. Òṣìṣẹ́ tí ó ní àkọọ́lẹ̀ púpọ̀ ń yan ọ̀kan nípa fífi --account <label> kún àṣẹ kan. Nebo ń yọ flag náà kúrò kí binary rẹ tó rí i.
Dárúkọ iṣẹ́ náà, kì í ṣe bí ó ṣe rí. Orúkọ plugin kan ń sọ ohun tí ó ń so pọ̀ mọ́, bí "Example Notes". Má ṣe fi "CLI" sínú orúkọ plugin láé; lójú àwọn òṣìṣẹ́ àti àwọn tó ni wọ́n, ìsopọ̀ ni, kì í ṣe ìlà-àṣẹ.
Ohun tí ó kàn
- Ìtọ́kasí plugin.json: gbogbo àyè, pẹ̀lú àwọn ìṣẹ̀lẹ̀, hooks àti àwọn iṣẹ́ onírú.
- Fífi plugin ránṣẹ́: àwọn pèpéle, àwọn binary, ìbuwọ́lù àti ìmúdójúìwọ̀n.
- Ìtẹ̀jáde: ọ̀nà ọjà fún gbogbo ohun tí a ṣẹ̀dá.