பிளகின்கள் எப்படி வேலை செய்கின்றன
ஒரு பிளகின் என்பது இயக்கக்கூடிய கோப்பும் ஒரு மேனிஃபெஸ்ட்டும். அழைப்புகளுக்கு இடையே Nebo எந்தப் பிளகின் செயல்முறையையும் இயக்கத்தில் வைத்திருப்பதில்லை. ஒவ்வொரு முறை பணியாளர் பிளகினைப் பயன்படுத்தும்போதும், Nebo ஒரு கட்டளை மற்றும் ஆர்குமென்ட்களுடன் பைனரியைத் தொடங்கி, அது வெளியேறும் வரை காத்திருந்து, வெளியீட்டைப் பணியாளரிடம் திருப்பித் தருகிறது.
- கட்டளைகள் என்பவை ஆர்குமென்ட்கள். பணியாளர்
notes searchபோன்ற ஒரு கட்டளையையும் பெயரிடப்பட்ட ஆர்குமென்ட்களையும் தேர்ந்தெடுக்கிறார். Nebo ஒவ்வொரு ஆர்குமென்ட்டையும்--name valueஆக அனுப்புகிறது. ஷெல் இல்லை, எனவே பைப்புகளும் திசைதிருப்பல்களும் ஒருபோதும் பொருந்தாது. - வெளியீடு என்பது stdout. முடிவுகளை stdout-இல் எழுதுங்கள். JSON நன்றாக வேலை செய்யும்.
- சாதாரண அழைப்புகளுக்கு நிலையான உள்ளீடு மூடப்பட்டிருக்கும். ஹூக்குகள், வழிகள் மற்றும் அரட்டை வழங்குநர்கள் stdin-ஐப் பயன்படுத்துகின்றன; plugin.json குறிப்பைப் பார்க்கவும்.
நிறுவப்பட்டு இயக்கப்பட்ட ஒவ்வொரு பிளகினும் பணியாளர்களுக்கு 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 | சரம், தேவை | பிளகின் கட்டளையும் நிலைச் சொற்களும். |
args | சரங்களின் ஆப்ஜெக்ட் | பெயரிடப்பட்ட ஆர்குமென்ட்கள். ஒவ்வொன்றும் --key value ஆகிறது. |
timeout | integer | காத்திருக்க வேண்டிய வினாடிகள். இயல்புநிலை 120; மேனிஃபெஸ்ட்டின் permissions.maxTimeoutSeconds இதன் உச்ச வரம்பு. |
display | string | அழைப்புக்கு ஒப்புதல் தேவைப்படும்போது உரிமையாளர் பார்க்கும் வாக்கியம். |
உங்கள் முதல் பிளகினை உருவாக்குங்கள்
ஆர்குமென்ட்களிலிருந்து தன் கட்டளையைப் படித்து ஒரு முடிவை அச்சிடும் பைனரியை எந்த மொழியிலும் எழுதுங்கள். பிறகு அதை ஒரு பாட்டின் பயனர் பிளகின்கள் கோப்பகத்தில் 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 ஆகியவை தேவை. பயனர் பிளகின்கள் கோப்பகத்தில் platforms வரைபடம் காலியாக இருக்கலாம்: Nebo, slug பெயருடைய பைனரியை plugin.json-க்கு அருகிலும், பிறகு target/release/ மற்றும் target/debug/-இலும் தேடுகிறது. நீங்கள் வெளியிடும்போது, நீங்கள் பதிவேற்றும் ஒவ்வொரு பைனரிக்கும் சந்தை platforms-ஐ நிரப்புகிறது.
<data> என்பது macOS-இல் ~/Library/Application Support/Nebo, Windows-இல் %APPDATA%\Nebo, Linux-இல் ~/.local/share/nebo, அல்லது NEBO_HOME-இன் மதிப்பு. பயனர் கோப்பகத்தில் உள்ள பிளகின், அதே slug கொண்ட சந்தைப் பிளகினை மேலெழுதுகிறது; அதனால் புதிய உருவாக்கத்தைச் சோதிக்க அதுவே சரியான இடம்.
அதைப் பயன்படுத்தப் பணியாளர்களுக்குக் கற்பியுங்கள்
plugin.json-க்கு அருகில் ஒரு skills/ கோப்புறையை வையுங்கள். பிளகின் நிறுவப்பட்டிருக்கும் வரை அதிலுள்ள ஒவ்வொரு திறனும் ஒவ்வொரு பணியாளருக்கும் கிடைக்கும், அது தானாகவே பிளகினைச் சார்புநிலையாகப் பட்டியலிடும். எந்தக் கட்டளைகள் உள்ளன, அவை என்ன திருப்பித் தருகின்றன, ஒவ்வொன்றையும் எப்போது பயன்படுத்த வேண்டும் என்பதைச் சொல்ல திறனைப் பயன்படுத்துங்கள். பிளகினின் கருவி விளக்கம் முதலில் அவற்றைச் சுட்டிக்காட்ட, மிகவும் பயனுள்ள திறன்களை entrySkills-இல் குறிப்பிடுங்கள்.
சந்தைப் பட்டியல் PLUGIN.md என்ற தனிக் கோப்பு. இயக்க நேரத்தில் Nebo அதைப் படிப்பதில்லை; மக்கள் நிறுவும் முன் பார்க்கும் பக்கம் அது. பிளகினை வெளியிடுதல் பக்கத்தைப் பார்க்கவும்.
சூழல்
ஒவ்வொரு அழைப்பும், லோடர் மற்றும் ஷெல்-உட்செலுத்தல் மாறிகள் அகற்றப்பட்ட பாட்டின் சூழலை மரபுரிமையாகப் பெற்று, பிறகு இந்த மதிப்புகளைச் சேர்க்கிறது. பின்னர் வருபவை முன்னுரிமை பெறும்.
| மாறி | மதிப்பு |
|---|---|
auth.env விசைகள் | மேனிஃபெஸ்ட்டிலிருந்து இயல்புநிலைகள். |
<SLUG>_BIN | இந்தப் பிளகினின் பைனரி மற்றும் அது சார்ந்திருக்கும் ஒவ்வொரு பிளகினின் பைனரியின் பாதை. slug பெரிய எழுத்துகளாகவும், ஹைஃபன்கள் அடிக்கோடுகளாகவும் மாற்றப்படும். |
NEBO_DATA_DIR | பிளகினின் சொந்தத் தரவுக் கோப்புறை, <data>/appdata/plugins/<slug>/. இதுவே பணிக் கோப்பகமும் கூட; நிறுவல் நீக்கத்துக்குப் பிறகும் நிலைத்திருக்கும். |
PATH | முதலில் பிளகின் கோப்புறைகள், பிறகு மரபுரிமையான பாதை. |
| அமைப்புகள் | configSchema புலங்களுக்காக உரிமையாளர் சேமித்த மதிப்புகள். |
NEBO_AGENT_ID | அழைப்பைச் செய்யும் பணியாளர். |
profileDirEnv | பிளகின் கணக்குகளை ஆதரிக்கும்போது, இந்தப் பணியாளருக்கும் கணக்குக்குமான கணக்குக் கோப்புறை. |
permissions.envAllow மற்றும் permissions.envDeny ஆகியவை பிளகின் பாட்டிலிருந்து மரபுரிமையாகப் பெறுவதைக் குறைக்கின்றன. அவை பிளகினின் சொந்த அங்கீகார மாறிகளை ஒருபோதும் அகற்றுவதில்லை.
கணக்குகளும் சான்றுகளும்
ஒரு சேவையில் உள்நுழையும் பிளகின், ஒவ்வொரு பணியாளருக்கும் ஒரு கணக்கை வைத்திருக்க வேண்டும். கணக்காளர் நிதி உள்நுழைவுடனும், உதவியாளர் தன் சொந்த உள்நுழைவுடனும் உள்நுழைகிறார்கள்; ஒருவர் மற்றவரின் டோக்கன்களைப் பார்ப்பதில்லை. இதை நீங்கள் மேனிஃபெஸ்ட்டில் அறிவிக்கிறீர்கள்; மீதியை 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உங்கள் பிளகின் தன் சான்றுக் கோப்புறைக்காகப் படிக்கும் மாறிக்குப் பெயரிடுகிறது. Nebo ஒவ்வொரு பணியாளருக்கும் கணக்குக்கும் ஒரு கோப்புறையை உருவாக்கி, ஒவ்வொரு அழைப்பிலும் அந்த மாறியை அமைக்கிறது.- உரிமையாளர் ஒரு கணக்கை இணைக்கும்போது, உரிமையாளர் தட்டச்சு செய்த மதிப்புகளுடனும் கணக்குக் கோப்புறை அமைக்கப்பட்ட நிலையிலும் Nebo உங்கள்
loginகட்டளையை இயக்குகிறது. உங்கள் பிளகின் தனக்குத் தேவையானதை அந்தக் கோப்புறையில் சேமிக்கிறது. Nebo அந்த மதிப்புகளை வைத்துக்கொள்வதில்லை. - உங்கள்
statusகட்டளை{"authenticated": true}போன்ற JSON ஐ அச்சிடும். டோக்கன் காலாவதியாகும்போது, நீங்கள்refreshஐ அறிவித்திருந்தால் Nebo அதை இயக்கும்.
உலாவி உள்நுழைவுக்கு, type-ஐ oauth_cli என அமைத்து, login வழங்குநரின் உள்நுழைவு URL-ஐ அச்சிடவோ திறக்கவோ செய்யுங்கள். பணியாளர்கள் தாங்களாகவே ஒருபோதும் உள்நுழைவதில்லை: ஓர் அழைப்புக்கு உள்நுழைவு தேவைப்படும்போது, உரிமையாளர் ஓர் இணைப்புக் கார்டைப் பார்க்கிறார். பல கணக்குகள் உள்ள பணியாளர், ஒரு கட்டளையில் --account <label> சேர்ப்பதன் மூலம் ஒன்றைத் தேர்ந்தெடுக்கிறார். உங்கள் பைனரி பார்க்கும் முன் Nebo அந்தக் கொடியை அகற்றிவிடுகிறது.
வடிவத்தை அல்ல, சேவையைப் பெயரிடுங்கள். ஒரு பிளகினின் பெயர் அது எதனுடன் இணைகிறது என்பதைச் சொல்ல வேண்டும், எடுத்துக்காட்டாக "Example Notes". பிளகின் பெயரில் ஒருபோதும் "CLI" என்று வைக்காதீர்கள்; பணியாளர்களுக்கும் உரிமையாளர்களுக்கும் அது ஓர் இணைப்பு, கட்டளை வரி அல்ல.
அடுத்து
- plugin.json குறிப்பு: நிகழ்வுகள், ஹூக்குகள் மற்றும் வகைப்படுத்தப்பட்ட செயல்பாடுகள் உட்பட ஒவ்வொரு புலமும்.
- பிளகினை வெளியிடுதல்: தளங்கள், பைனரிகள், கையொப்பமிடுதல் மற்றும் புதுப்பிப்புகள்.
- வெளியிடுதல்: ஒவ்வொரு படைப்புக்குமான சந்தை நடைமுறை.