របៀបដែល Plugin ដំណើរការ
Plugin គឺជាកម្មវិធីដំណើរការមួយ បូកនឹង manifest មួយ។ Nebo មិនរក្សាដំណើរការ Plugin ណាមួយឱ្យដំណើរការរវាងការហៅទេ។ រាល់ពេលដែលបុគ្គលិកប្រើ Plugin Nebo ចាប់ផ្ដើម binary ជាមួយពាក្យបញ្ជា និងអាគុយម៉ង់ រង់ចាំវាចេញ ហើយប្រគល់លទ្ធផលត្រឡប់ទៅបុគ្គលិកវិញ។
- ពាក្យបញ្ជាគឺជាអាគុយម៉ង់។ បុគ្គលិកជ្រើសរើសពាក្យបញ្ជា ដូចជា
notes searchនិងអាគុយម៉ង់ដែលមានឈ្មោះ។ Nebo បញ្ជូនអាគុយម៉ង់នីមួយៗជា--name value។ គ្មាន shell ទេ ដូច្នេះ pipe និង redirect មិនដែលអនុវត្តឡើយ។ - លទ្ធផលគឺ stdout។ សរសេរលទ្ធផលទៅ stdout។ JSON ដំណើរការបានល្អ។
- ការបញ្ចូលស្ដង់ដារត្រូវបានបិទ សម្រាប់ការហៅធម្មតា។ Hook ផ្លូវ និងអ្នកផ្ដល់សេវាជជែក ប្រើ stdin; សូមមើល ឯកសារយោង plugin.json។
រាល់ Plugin ដែលបានដំឡើង និងបើក បង្ហាញដល់បុគ្គលិកជាឧបករណ៍មួយដែលមានឈ្មោះ plugin__<slug>។ បុគ្គលិកហៅវាដូចនេះ៖
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo ដំណើរការ៖
notes-sync notes search --query "quarterly plan" --limit 5
| ប៉ារ៉ាម៉ែត្រ | ប្រភេទ | អត្ថន័យ |
|---|---|---|
command | ខ្សែអក្សរ ចាំបាច់ | ពាក្យបញ្ជា Plugin និងពាក្យតាមទីតាំងណាមួយ។ |
args | object នៃខ្សែអក្សរ | អាគុយម៉ង់ដែលមានឈ្មោះ។ នីមួយៗក្លាយជា --key value។ |
timeout | integer | ចំនួនវិនាទីដែលត្រូវរង់ចាំ។ លំនាំដើម 120 កំណត់ខ្ពស់បំផុតដោយ permissions.maxTimeoutSeconds របស់ manifest។ |
display | string | ប្រយោគដែលម្ចាស់មើលឃើញ នៅពេលការហៅត្រូវការការយល់ព្រម។ |
បង្កើត Plugin ដំបូងរបស់អ្នក
សរសេរ binary ជាភាសាណាក៏បាន ដែលអានពាក្យបញ្ជារបស់វាពីអាគុយម៉ង់ ហើយបង្ហាញលទ្ធផល។ បន្ទាប់មកដាក់វានៅក្បែរ plugin.json នៅក្នុងថត Plugin របស់អ្នកប្រើនៃបូតមួយ។
<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 អាចទុកទទេបាន៖ Nebo រកមើល binary ដែលមានឈ្មោះតាម slug នៅក្បែរ plugin.json បន្ទាប់មកនៅក្នុង target/release/ និង target/debug/។ ពេលអ្នកបោះផ្សាយ ទីផ្សារបំពេញ platforms សម្រាប់រាល់ binary ដែលអ្នកផ្ទុកឡើង។
<data> គឺ ~/Library/Application Support/Nebo នៅលើ macOS, %APPDATA%\Nebo នៅលើ Windows និង ~/.local/share/nebo នៅលើ Linux ឬតម្លៃរបស់ NEBO_HOME។ Plugin នៅក្នុងថតអ្នកប្រើបដិសេធ Plugin ទីផ្សារដែលមាន slug ដូចគ្នា ដែលធ្វើឱ្យវាក្លាយជាកន្លែងសម្រាប់សាកល្បងការបង្កើតថ្មី។
បង្រៀនបុគ្គលិកឱ្យប្រើវា
ដាក់ថត skills/ នៅក្បែរ plugin.json។ ជំនាញនីមួយៗនៅក្នុងនោះមានសម្រាប់បុគ្គលិកទាំងអស់ ខណៈពេល Plugin ត្រូវបានដំឡើង ហើយរាយ Plugin ជាភាពអាស្រ័យដោយស្វ័យប្រវត្តិ។ ប្រើជំនាញដើម្បីប្រាប់ថាមានពាក្យបញ្ជាអ្វីខ្លះ វាត្រឡប់អ្វីមកវិញ និងពេលណាត្រូវប្រើនីមួយៗ។ ដាក់ឈ្មោះជំនាញដែលមានប្រយោជន៍បំផុតនៅក្នុង entrySkills ដើម្បីឱ្យការពិពណ៌នាឧបករណ៍របស់ Plugin ចង្អុលទៅពួកវាមុនគេ។
បញ្ជីក្នុងទីផ្សារគឺជាឯកសារដាច់ដោយឡែក PLUGIN.md។ Nebo មិនអានវានៅពេលដំណើរការទេ; វាគឺជាទំព័រដែលមនុស្សមើលឃើញមុនពេលពួកគេដំឡើង។ សូមមើល ការចេញផ្សាយ Plugin។
បរិស្ថាន
ការហៅនីមួយៗទទួលមរតកបរិស្ថានរបស់បូត ដោយដកអថេរ loader និង shell-injection ចេញ បន្ទាប់មកបន្ថែមតម្លៃទាំងនេះ។ ធាតុក្រោយៗឈ្នះ។
| អថេរ | តម្លៃ |
|---|---|
Key auth.env | តម្លៃលំនាំដើមពី manifest។ |
<SLUG>_BIN | ផ្លូវរបស់ binary នៃ Plugin នេះ និងនៃ Plugin នីមួយៗដែលវាអាស្រ័យលើ។ Slug ត្រូវបានប្ដូរជាអក្សរធំ ដោយប្ដូរសញ្ញាដកទៅជាសញ្ញាគូសក្រោម។ |
NEBO_DATA_DIR | ថតទិន្នន័យផ្ទាល់ខ្លួនរបស់ Plugin គឺ <data>/appdata/plugins/<slug>/។ វាក៏ជាថតធ្វើការផងដែរ ហើយវានៅរស់រានក្រោយការលុបការដំឡើង។ |
PATH | ថត Plugin មុនគេ បន្ទាប់មកផ្លូវដែលទទួលមរតក។ |
| ការកំណត់ | តម្លៃដែលម្ចាស់បានរក្សាទុកសម្រាប់វាល configSchema។ |
NEBO_AGENT_ID | បុគ្គលិកដែលកំពុងធ្វើការហៅ។ |
profileDirEnv | ថតគណនីសម្រាប់បុគ្គលិក និងគណនីនេះ នៅពេល Plugin គាំទ្រគណនី។ |
permissions.envAllow និង permissions.envDeny បង្រួមអ្វីដែល Plugin ទទួលមរតកពីបូត។ ពួកវាមិនដែលដកអថេរ auth ផ្ទាល់ខ្លួនរបស់ Plugin ចេញទេ។
គណនី និងព័ត៌មានសម្ងាត់
Plugin ដែលចូលគណនីសេវាមួយ គួរកាន់គណនីមួយក្នុងមួយបុគ្គលិក។ អ្នកកាន់បញ្ជីចូលដោយប្រើការចូលគណនីហិរញ្ញវត្ថុ ហើយជំនួយការចូលដោយប្រើគណនីផ្ទាល់ខ្លួនរបស់ខ្លួន ហើយគ្មាននរណាម្នាក់មើលឃើញ 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ដាក់ស្លាកពួកវា និងកំណត់លំដាប់របស់ពួកវានៅក្នុងទម្រង់តភ្ជាប់។auth.profileDirEnvដាក់ឈ្មោះអថេរដែល Plugin របស់អ្នកអានសម្រាប់ថតព័ត៌មានសម្ងាត់របស់វា។ Nebo បង្កើតថតមួយសម្រាប់បុគ្គលិក និងគណនីនីមួយៗ ហើយកំណត់អថេរនោះនៅរាល់ការហៅ។- នៅពេលម្ចាស់តភ្ជាប់គណនីមួយ Nebo ដំណើរការពាក្យបញ្ជា
loginរបស់អ្នកជាមួយតម្លៃដែលម្ចាស់បានវាយ និងថតគណនីដែលបានកំណត់។ Plugin របស់អ្នករក្សាទុកអ្វីដែលវាត្រូវការនៅក្នុងថតនោះ។ Nebo មិនរក្សាតម្លៃទាំងនោះទេ។ - ពាក្យបញ្ជា
statusរបស់អ្នកបោះពុម្ព JSON ដូចជា{"authenticated": true}។ នៅពេល token ផុតកំណត់ Nebo ដំណើរការrefreshប្រសិនបើអ្នកប្រកាសវា។
សម្រាប់ការចូលគណនីតាមកម្មវិធីរុករក កំណត់ type ទៅ oauth_cli ហើយឱ្យ login បង្ហាញ ឬបើក URL ចូលគណនីរបស់អ្នកផ្ដល់សេវា។ បុគ្គលិកមិនដែលចូលគណនីដោយខ្លួនឯងទេ៖ នៅពេលការហៅមួយត្រូវការការចូលគណនី ម្ចាស់មើលឃើញកាតតភ្ជាប់។ បុគ្គលិកដែលមានគណនីច្រើន ជ្រើសរើសមួយដោយបន្ថែម --account <label> ទៅក្នុងពាក្យបញ្ជា។ Nebo ដក flag នោះចេញមុនពេល binary របស់អ្នកមើលឃើញវា។
ដាក់ឈ្មោះសេវា មិនមែនទម្រង់ទេ។ ឈ្មោះរបស់ Plugin ប្រាប់ពីអ្វីដែលវាភ្ជាប់ទៅ ដូចជា "Example Notes"។ កុំដាក់ "CLI" ក្នុងឈ្មោះ Plugin ឡើយ; ចំពោះបុគ្គលិក និងម្ចាស់ វាគឺជាការតភ្ជាប់ មិនមែនជាបន្ទាត់ពាក្យបញ្ជាទេ។
បន្ទាប់
- ឯកសារយោង plugin.json៖ រាល់វាល រួមទាំងព្រឹត្តិការណ៍ hook និងប្រតិបត្តិការមានប្រភេទ។
- ការចេញផ្សាយ Plugin៖ វេទិកា binary ការចុះហត្ថលេខា និងការធ្វើបច្ចុប្បន្នភាព។
- ការបោះផ្សាយ៖ លំហូរទីផ្សារសម្រាប់រាល់វត្ថុបោះផ្សាយ។