Plugin များ အလုပ်လုပ်ပုံ
Plugin တစ်ခုသည် executable တစ်ခုနှင့် manifest တစ်ခု ဖြစ်သည်။ Nebo သည် ခေါ်ဆိုမှုများကြားတွင် Plugin process ကို ဆက် run မထားပါ။ ဝန်ထမ်းတစ်ဦး Plugin ကို သုံးတိုင်း Nebo က binary ကို command နှင့် argument များဖြင့် စတင်ပြီး ၎င်းပြီးဆုံးသည်အထိ စောင့်ကာ output ကို ဝန်ထမ်းထံ ပြန်ပေးသည်။
- Command များသည် argument များ ဖြစ်သည်။ ဝန်ထမ်းက
notes searchကဲ့သို့ command တစ်ခုနှင့် အမည်ပါ argument များကို ရွေးသည်။ Nebo သည် argument တစ်ခုစီကို--name valueအဖြစ် ပေးပို့သည်။ Shell မရှိသောကြောင့် pipe နှင့် redirect များ ဘယ်တော့မှ မသက်ရောက်ပါ။ - Output သည် stdout ဖြစ်သည်။ ရလဒ်များကို stdout သို့ ရေးပါ။ JSON က ကောင်းစွာ အလုပ်လုပ်သည်။
- သာမန်ခေါ်ဆိုမှုများအတွက် Standard input ကို ပိတ်ထားသည်။ Hook များ၊ route များနှင့် chat provider များက stdin ကို သုံးသည်။ plugin.json ကိုးကားချက် ကို ကြည့်ပါ။
ထည့်သွင်းပြီး ဖွင့်ထားသော Plugin တိုင်းသည် ဝန်ထမ်းများအတွက် plugin__<slug> ဟု အမည်ပေးထားသော tool တစ်ခုအဖြစ် ပေါ်သည်။ ဝန်ထမ်းတစ်ဦးက ၎င်းကို ဤသို့ ခေါ်သည်-
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo က run သည်-
notes-sync notes search --query "quarterly plan" --limit 5
| Parameter | Type | အဓိပ္ပာယ် |
|---|---|---|
command | string၊ မဖြစ်မနေ | Plugin command နှင့် နေရာအလိုက် စကားလုံးများ။ |
args | string များ၏ object | အမည်ပါ argument များ။ တစ်ခုစီသည် --key value ဖြစ်လာသည်။ |
timeout | integer | စောင့်ရမည့် စက္ကန့်။ မူလတန်ဖိုး 120၊ manifest ၏ permissions.maxTimeoutSeconds ဖြင့် ကန့်သတ်ထားသည်။ |
display | string | ခေါ်ဆိုမှုက ခွင့်ပြုချက် လိုအပ်သောအခါ ပိုင်ရှင်မြင်ရသော ဝါကျ။ |
သင့်ပထမဆုံး Plugin ကို တည်ဆောက်ပါ
Argument များမှ ၎င်း၏ command ကို ဖတ်ပြီး ရလဒ်ကို ထုတ်ပြသော binary တစ်ခုကို မည်သည့်ဘာသာစကားဖြင့်မဆို ရေးပါ။ ထို့နောက် ၎င်းကို ဘော့တစ်ခု၏ အသုံးပြုသူ Plugin ဖိုင်တွဲထဲတွင် plugin.json ၏ဘေး၌ ထားပါ။
<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 နှင့် platforms တို့ မဖြစ်မနေ လိုအပ်သည်။ အသုံးပြုသူ Plugin ဖိုင်တွဲထဲတွင် platforms map ကို ဗလာထားနိုင်သည်- Nebo သည် slug အမည်ရှိ binary ကို plugin.json ၏ဘေးတွင်၊ ထို့နောက် target/release/ နှင့် target/debug/ တွင် ရှာသည်။ သင်ထုတ်ဝေသောအခါ စျေးကွက်က သင် upload လုပ်သော binary တိုင်းအတွက် platforms ကို ဖြည့်ပေးသည်။
<data> သည် macOS တွင် ~/Library/Application Support/Nebo၊ Windows တွင် %APPDATA%\Nebo၊ Linux တွင် ~/.local/share/nebo သို့မဟုတ် NEBO_HOME ၏ တန်ဖိုး ဖြစ်သည်။ အသုံးပြုသူဖိုင်တွဲထဲရှိ Plugin သည် slug တူသော စျေးကွက် Plugin ကို အစားထိုးသောကြောင့် build အသစ်ကို စမ်းသပ်ရန် နေရာ ဖြစ်သည်။
ဝန်ထမ်းများကို အသုံးပြုနည်း သင်ပေးပါ
plugin.json ၏ဘေးတွင် skills/ ဖိုင်တွဲတစ်ခု ထားပါ။ ၎င်းထဲရှိ ကျွမ်းကျင်မှုတစ်ခုစီကို Plugin ထည့်သွင်းထားစဉ် ဝန်ထမ်းတိုင်း သုံးနိုင်ပြီး Plugin ကို dependency အဖြစ် အလိုအလျောက် ဖော်ပြသည်။ မည်သည့် command များ ရှိသည်၊ ၎င်းတို့ ဘာပြန်ပေးသည်နှင့် တစ်ခုစီကို မည်သည့်အခါ သုံးရမည်ကို ပြောရန် ကျွမ်းကျင်မှုကို သုံးပါ။ Plugin ၏ tool ဖော်ပြချက်က ၎င်းတို့ကို ဦးစွာ ညွှန်ပြစေရန် အသုံးဝင်ဆုံး ကျွမ်းကျင်မှုများကို entrySkills တွင် အမည်ဖော်ပါ။
စျေးကွက် စာရင်းဖော်ပြချက်သည် သီးခြားဖိုင် PLUGIN.md ဖြစ်သည်။ Nebo သည် run ချိန်တွင် ၎င်းကို မဖတ်ပါ။ ၎င်းမှာ လူများ မထည့်သွင်းမီ မြင်ရသော စာမျက်နှာ ဖြစ်သည်။ Plugin ထုတ်ဝေခြင်း ကို ကြည့်ပါ။
Environment
ခေါ်ဆိုမှုတစ်ခုစီသည် loader နှင့် shell-injection variable များကို ဖယ်ရှားထားသော ဘော့၏ environment ကို အမွေဆက်ခံပြီး ထို့နောက် ဤတန်ဖိုးများကို ထည့်သည်။ နောက်ပိုင်း entry များက အနိုင်ရသည်။
| Variable | တန်ဖိုး |
|---|---|
auth.env key များ | Manifest မှ မူလတန်ဖိုးများ။ |
<SLUG>_BIN | ဤ Plugin ၏ binary နှင့် ၎င်းမှီခိုသော Plugin တစ်ခုစီ၏ path။ Slug ကို စာလုံးအကြီးပြောင်းပြီး hyphen များကို underscore အဖြစ် ပြောင်းသည်။ |
NEBO_DATA_DIR | Plugin ၏ ကိုယ်ပိုင် ဒေတာဖိုင်တွဲ <data>/appdata/plugins/<slug>/။ ၎င်းသည် working directory လည်း ဖြစ်ပြီး ဖယ်ရှားပြီးနောက်တွင်လည်း ကျန်ရှိသည်။ |
PATH | Plugin ဖိုင်တွဲများ အရင်၊ ထို့နောက် အမွေဆက်ခံ path။ |
| ဆက်တင်များ | configSchema field များအတွက် ပိုင်ရှင် သိမ်းထားသော တန်ဖိုးများ။ |
NEBO_AGENT_ID | ခေါ်ဆိုနေသော ဝန်ထမ်း။ |
profileDirEnv | Plugin က အကောင့်များကို ပံ့ပိုးသောအခါ ဤဝန်ထမ်းနှင့် အကောင့်အတွက် အကောင့်ဖိုင်တွဲ။ |
permissions.envAllow နှင့် permissions.envDeny တို့သည် Plugin က ဘော့ထံမှ အမွေဆက်ခံသည့်အရာကို ကျဉ်းစေသည်။ ၎င်းတို့သည် Plugin ၏ ကိုယ်ပိုင် auth variable များကို ဘယ်တော့မှ မဖယ်ရှားပါ။
အကောင့်များနှင့် အထောက်အထားများ
ဝန်ဆောင်မှုတစ်ခုသို့ အကောင့်ဝင်သော Plugin သည် ဝန်ထမ်းတစ်ဦးလျှင် အကောင့်တစ်ခု ကိုင်ထားသင့်သည်။ စာရင်းကိုင်က ဘဏ္ဍာရေး login ဖြင့် ဝင်ပြီး လက်ထောက်က ၎င်း၏ ကိုယ်ပိုင် login ဖြင့် ဝင်ကာ မည်သူမျှ တစ်ဦး၏ token များကို အခြားတစ်ဦး မမြင်ရပါ။ ၎င်းကို manifest တွင် ကြေညာပါ၊ ကျန်တာကို Nebo က လုပ်ပေးသည်။
"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သည် အထောက်အထားများကို အမည်ပေးသည်။capabilities.configSchemaသည် ၎င်းတို့ကို အမည်တပ်ပြီး connect form ထဲတွင် ၎င်းတို့၏ အစီအစဉ်ကို သတ်မှတ်သည်။auth.profileDirEnvသည် သင့် Plugin က ၎င်း၏ credential ဖိုင်တွဲအတွက် ဖတ်သော variable ကို အမည်ပေးသည်။ Nebo သည် ဝန်ထမ်းနှင့် အကောင့်တစ်ခုစီအတွက် ဖိုင်တွဲတစ်ခု ဖန်တီးပြီး ခေါ်ဆိုမှုတိုင်းတွင် ထို variable ကို သတ်မှတ်ပေးသည်။- ပိုင်ရှင်က အကောင့်တစ်ခုကို ချိတ်ဆက်သောအခါ Nebo သည် ပိုင်ရှင် ရိုက်ထည့်သော တန်ဖိုးများနှင့် အကောင့်ဖိုင်တွဲ သတ်မှတ်ပြီးဖြင့် သင့်
logincommand ကို run သည်။ သင့် Plugin သည် လိုအပ်သည်များကို ထိုဖိုင်တွဲထဲတွင် သိမ်းဆည်းသည်။ Nebo သည် တန်ဖိုးများကို မသိမ်းထားပါ။ - သင့်
statuscommand သည်{"authenticated": true}ကဲ့သို့ JSON ကို ထုတ်ပြသည်။ token သက်တမ်းကုန်သည့်အခါ သင်refreshကို ကြေညာထားလျှင် Nebo က ၎င်းကို လုပ်ဆောင်သည်။
Browser အကောင့်ဝင်ခြင်းအတွက် type ကို oauth_cli ဟု သတ်မှတ်ပြီး login က provider ၏ အကောင့်ဝင် URL ကို ထုတ်ပြ သို့မဟုတ် ဖွင့်ပေးစေပါ။ ဝန်ထမ်းများသည် ကိုယ်တိုင် ဘယ်တော့မှ အကောင့်မဝင်ပါ- ခေါ်ဆိုမှုတစ်ခုက login လိုအပ်သောအခါ ပိုင်ရှင်သည် connect ကတ်ကို မြင်ရသည်။ အကောင့်များစွာရှိသော ဝန်ထမ်းသည် command တစ်ခုတွင် --account <label> ထည့်ခြင်းဖြင့် တစ်ခုကို ရွေးသည်။ သင့် binary မမြင်မီ Nebo က ထို flag ကို ဖယ်ရှားသည်။
ပုံစံကို မဟုတ်ဘဲ ဝန်ဆောင်မှုကို အမည်ပေးပါ။ Plugin ၏အမည်သည် "Example Notes" ကဲ့သို့ ၎င်းချိတ်ဆက်သည့်အရာကို ပြောသည်။ Plugin အမည်တွင် "CLI" ကို ဘယ်တော့မှ မထည့်ပါနှင့်။ ဝန်ထမ်းများနှင့် ပိုင်ရှင်များအတွက် ၎င်းသည် command line မဟုတ်ဘဲ ချိတ်ဆက်မှုတစ်ခု ဖြစ်သည်။
နောက်တစ်ဆင့်
- plugin.json ကိုးကားချက်- event များ၊ hook များနှင့် type သတ်မှတ်ထားသော operation များ အပါအဝင် field တိုင်း။
- Plugin ထုတ်ဝေခြင်း- platform များ၊ binary များ၊ လက်မှတ်ထိုးခြင်းနှင့် အပ်ဒိတ်များ။
- ထုတ်ဝေခြင်း- artifact တိုင်းအတွက် စျေးကွက် လုပ်ငန်းစဉ်။