പ്ലഗിനുകൾ എങ്ങനെ പ്രവർത്തിക്കുന്നു
ഒരു പ്ലഗിൻ എന്നത് ഒരു എക്സിക്യൂട്ടബിളും ഒരു മാനിഫെസ്റ്റുമാണ്. കോളുകൾക്കിടയിൽ 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 റഫറൻസ്: ഇവന്റുകൾ, ഹുക്കുകൾ, ടൈപ്പ് ചെയ്ത ഓപ്പറേഷനുകൾ ഉൾപ്പെടെ എല്ലാ ഫീൽഡുകളും.
- ഒരു പ്ലഗിൻ പുറത്തിറക്കൽ: പ്ലാറ്റ്ഫോമുകൾ, ബൈനറികൾ, സൈനിംഗ്, അപ്ഡേറ്റുകൾ.
- പ്രസിദ്ധീകരണം: ഓരോ ആർട്ടിഫാക്റ്റിനുമുള്ള മാർക്കറ്റ്പ്ലേസ് പ്രക്രിയ.