Otú plugin si arụ ọrụ
Plugin bụ ihe a na-agba gbakwunyere manifest. Nebo anaghị eme ka usoro plugin ọ bụla na-agba n'etiti oku. Oge ọ bụla onye ọrụ jiri plugin ahụ, Nebo na-amalite binary ahụ site n'iwu na arụmụka, chere ka ọ pụọ, ma nyeghachi onye ọrụ ahụ mwepụta ya.
- Iwu bụ arụmụka. Onye ọrụ na-ahọrọ iwu, dị ka
notes search, na arụmụka nwere aha. Nebo na-enyefe arụmụka ọ bụla dị ka--name value. Enweghị shell, ya mere pipe na redirect anaghị emetụta ma ọlị. - Mwepụta bụ stdout. Dee nsonaazụ na stdout. JSON na-arụ ọrụ nke ọma.
- Ntinye ọkọlọtọ mechiri emechi maka oku nkịtị. Hooks, ụzọ na ndị na-eweta nkata na-eji stdin; lee ntụaka plugin.json.
Plugin ọ bụla e wụnyere ma gbanye na-apụta n'ihu ndị ọrụ dị ka otu ngwaọrụ a na-akpọ plugin__<slug>. Onye ọrụ na-akpọ ya otú a:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo na-agba:
notes-sync notes search --query "quarterly plan" --limit 5
| Paramita | Ụdị | Ihe ọ pụtara |
|---|---|---|
command | eriri okwu, a chọrọ ya | Iwu plugin ahụ na okwu ọ bụla dabere n'ọnọdụ. |
args | ihe nwere eriri okwu | Arụmụka nwere aha. Nke ọ bụla na-aghọ --key value. |
timeout | integer | Sekọnd ichere. Ndabara bụ 120, nke permissions.maxTimeoutSeconds nke manifest na-ejedebe. |
display | string | Ahịrịokwu onye nwe ya na-ahụ mgbe oku ahụ chọrọ nkwado. |
Wuo plugin mbụ gị
Dee binary n'asụsụ ọ bụla nke na-agụ iwu ya site n'arụmụka ma bipụta nsonaazụ. Wee tinye ya n'akụkụ plugin.json na folda plugin onye ọrụ nke bọt.
<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": {}
} A chọrọ id, slug, name, version na platforms. Na folda plugin onye ọrụ, map platforms nwere ike ịtọgbọ chakoo: Nebo na-achọ binary a kpọrọ aha slug ahụ n'akụkụ plugin.json, wee na target/release/ na target/debug/. Mgbe ị bipụtara, ahịa na-ejupụta platforms maka binary ọ bụla ị bulitere.
<data> bụ ~/Library/Application Support/Nebo na macOS, %APPDATA%\Nebo na Windows, na ~/.local/share/nebo na Linux, ma ọ bụ uru nke NEBO_HOME. Plugin dị na folda onye ọrụ na-akagbu plugin ahịa nwere otu slug ahụ, nke na-eme ya ebe a na-anwale wuli ọhụrụ.
Kụziere ndị ọrụ otú e si eji ya
Tinye folda skills/ n'akụkụ plugin.json. Nka ọ bụla dị n'ime ya dịịrị onye ọrụ ọ bụla mgbe plugin ahụ dị n'ime, ọ na-edepụtakwa plugin ahụ dị ka ihe ọ dabere na ya n'onwe ya. Jiri nka ahụ kwuo iwu ndị dị, ihe ha na-eweghachi, na mgbe a ga-eji nke ọ bụla. Kpọọ aha nka kacha baa uru na entrySkills ka nkọwa ngwaọrụ plugin ahụ buru ụzọ gosi ha.
Ndepụta ahịa bụ faịlụ dị iche, PLUGIN.md. Nebo anaghị agụ ya mgbe ọ na-agba; ọ bụ ibe ndị mmadụ na-ahụ tupu ha awụnye. Lee Iziga plugin.
Gburugburu
Oku ọ bụla na-eketa gburugburu bọt ahụ, e wepụrụ mgbanwe loader na ntinye shell, wee gbakwunye uru ndị a. Ndenye ndị na-esote na-emeri.
| Mgbanwe | Uru |
|---|---|
Igodo auth.env | Ndabara site na manifest. |
<SLUG>_BIN | Ụzọ binary nke plugin a, na nke plugin ọ bụla ọ dabere na ya. A na-ede slug ahụ na mkpụrụedemede ukwu, ebe hyphen ghọrọ underscore. |
NEBO_DATA_DIR | Folda data nke plugin ahụ n'onwe ya, <data>/appdata/plugins/<slug>/. Ọ bụkwa folda ọrụ, ọ na-adịgidekwa n'agbanyeghị nwepụ. |
PATH | Folda plugin na mbụ, wee ụzọ e ketara. |
| Ntọala | Uru onye nwe ya chekwara maka mpaghara configSchema. |
NEBO_AGENT_ID | Onye ọrụ na-akpọ oku ahụ. |
profileDirEnv | Folda akaụntụ maka onye ọrụ a na akaụntụ a, mgbe plugin ahụ na-akwado akaụntụ. |
permissions.envAllow na permissions.envDeny na-ebelata ihe plugin ahụ na-eketa site na bọt ahụ. Ha anaghị ewepụ mgbanwe nkwenye nke plugin ahụ n'onwe ya.
Akaụntụ na nzere
Plugin na-abanye n'ọrụ kwesịrị ijide otu akaụntụ maka onye ọrụ ọ bụla. Onye na-edekọ akaụntụ na-abanye site na nbanye ego, onye inyeaka na-abanye site na nke ya, ọ dịghịkwa onye n'ime ha na-ahụ token nke ibe ya. Ị na-ekwupụta nke a na manifest; Nebo na-eme ndị fọdụrụ.
"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.envna-akpọ aha nzere ndị ahụ.capabilities.configSchemana-enye ha aha ma hazie usoro ha na fọm njikọ.auth.profileDirEnvna-akpọ aha mgbanwe plugin gị na-agụ maka folda nzere ya. Nebo na-emepụta otu folda maka onye ọrụ na akaụntụ ọ bụla ma tinye mgbanwe ahụ na oku ọ bụla.- Mgbe onye nwe ya jikọrọ akaụntụ, Nebo na-agba iwu
logingị site n'uru onye nwe ya tinyere na folda akaụntụ e debere. Plugin gị na-echekwa ihe ọ chọrọ na folda ahụ. Nebo anaghị edebe uru ndị ahụ. - Iwu
statusgị na-ebipụta JSON dịka{"authenticated": true}. Mgbe token gwụrụ, Nebo na-agbarefreshma ọ bụrụ na i kwupụtara otu.
Maka ịbanye site na ihe nchọgharị, tinye type ka ọ bụrụ oauth_cli ma mee ka login bipụta ma ọ bụ mepee URL ịbanye nke onye na-eweta ọrụ. Ndị ọrụ anaghị abanye n'onwe ha: mgbe oku chọrọ nbanye, onye nwe ya na-ahụ kaadị njikọ. Onye ọrụ nwere ọtụtụ akaụntụ na-ahọrọ otu site n'ịgbakwunye --account <label> n'iwu. Nebo na-ewepụ flag ahụ tupu binary gị ahụ ya.
Kpọọ aha ọrụ ahụ, ọ bụghị ọdịdị ya. Aha plugin na-ekwu ihe ọ na-ejikọ, dị ka "Example Notes". Etinyela "CLI" n'aha plugin; nye ndị ọrụ na ndị nwe ya, ọ bụ njikọ, ọ bụghị ahịrị iwu.
Ihe na-esote
- Ntụaka plugin.json: mpaghara ọ bụla, gụnyere ihe omume, hooks na ọrụ nwere ụdị.
- Iziga plugin: nyiwe, binary, mbinye aka na mmelite.
- Mbipụta: usoro ahịa maka ihe ọ bụla e mepụtara.