Jinsi programu-jalizi zinavyofanya kazi
Programu-jalizi ni faili tekelezi pamoja na manifesti. Nebo haiachi mchakato wowote wa programu-jalizi ukiendeshwa kati ya miito. Kila mara mfanyakazi anapotumia programu-jalizi, Nebo huanzisha faili tekelezi kwa amri na hoja, husubiri imalize, na humrudishia mfanyakazi tokeo.
- Amri ni hoja. Mfanyakazi huchagua amri, kama
notes search, na hoja zenye majina. Nebo hupitisha kila hoja kama--name value. Hakuna shell, kwa hiyo mabomba na uelekezaji upya havitumiki kamwe. - Tokeo ni stdout. Andika matokeo kwenye stdout. JSON hufanya kazi vizuri.
- Ingizo la kawaida limefungwa kwa miito ya kawaida. Hooks, njia na watoa huduma wa gumzo hutumia stdin; tazama marejeo ya plugin.json.
Kila programu-jalizi iliyosakinishwa na kuwashwa huonekana kwa wafanyakazi kama zana moja inayoitwa plugin__<slug>. Mfanyakazi huiita hivi:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo huendesha:
notes-sync notes search --query "quarterly plan" --limit 5
| Paramita | Aina | Maana |
|---|---|---|
command | maandishi, inahitajika | Amri ya programu-jalizi na maneno yoyote ya nafasi. |
args | kitu cha maandishi | Hoja zenye majina. Kila moja huwa --key value. |
timeout | integer | Sekunde za kusubiri. Chaguo-msingi ni 120, kikomo kikiwa permissions.maxTimeoutSeconds ya manifesti. |
display | string | Sentensi ambayo mmiliki huona mwito unapohitaji idhini. |
Unda programu-jalizi yako ya kwanza
Andika faili tekelezi kwa lugha yoyote inayosoma amri yake kutoka kwenye hoja na kuchapisha tokeo. Kisha iweke kando ya plugin.json katika saraka ya programu-jalizi za mtumiaji ya boti.
<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 na platforms zinahitajika. Katika saraka ya programu-jalizi za mtumiaji ramani ya platforms inaweza kuwa tupu: Nebo hutafuta faili tekelezi yenye jina la slug kando ya plugin.json, kisha katika target/release/ na target/debug/. Unapochapisha, soko hujaza platforms kwa kila faili tekelezi unayopakia.
<data> ni ~/Library/Application Support/Nebo kwenye macOS, %APPDATA%\Nebo kwenye Windows, na ~/.local/share/nebo kwenye Linux, au thamani ya NEBO_HOME. Programu-jalizi iliyo katika saraka ya mtumiaji hupita programu-jalizi ya sokoni yenye slug ileile, jambo linaloifanya kuwa mahali pa kujaribu toleo jipya ulilounda.
Wafundishe wafanyakazi kuitumia
Weka folda ya skills/ kando ya plugin.json. Kila ujuzi ndani yake unapatikana kwa kila mfanyakazi wakati programu-jalizi imesakinishwa, na huorodhesha programu-jalizi kama tegemeo kiotomatiki. Tumia ujuzi kueleza amri zilizopo, zinachorudisha, na wakati wa kutumia kila moja. Taja ujuzi muhimu zaidi katika entrySkills ili maelezo ya zana ya programu-jalizi yaelekeze kwao kwanza.
Tangazo la sokoni ni faili tofauti, PLUGIN.md. Nebo haiisomi wakati wa kuendesha; ni ukurasa ambao watu huona kabla ya kusakinisha. Tazama Kusafirisha programu-jalizi.
Mazingira
Kila mwito hurithi mazingira ya boti huku vigezo vya kipakiaji na vya kuchomeka shell vikiondolewa, kisha huongeza thamani hizi. Vipengee vya baadaye hushinda.
| Kigezo | Thamani |
|---|---|
Funguo za auth.env | Chaguo-msingi kutoka kwenye manifesti. |
<SLUG>_BIN | Njia ya faili tekelezi ya programu-jalizi hii, na ya kila programu-jalizi inayoitegemea. Slug huandikwa kwa herufi kubwa na vistari vikiwa mistari ya chini. |
NEBO_DATA_DIR | Folda ya data ya programu-jalizi yenyewe, <data>/appdata/plugins/<slug>/. Pia ndiyo saraka ya kazi, na hudumu baada ya kuondolewa. |
PATH | Folda za programu-jalizi kwanza, kisha njia iliyorithiwa. |
| Mipangilio | Thamani ambazo mmiliki alihifadhi kwa sehemu za configSchema. |
NEBO_AGENT_ID | Mfanyakazi anayefanya mwito. |
profileDirEnv | Folda ya akaunti kwa mfanyakazi na akaunti hii, programu-jalizi inapounga mkono akaunti. |
permissions.envAllow na permissions.envDeny hupunguza kile ambacho programu-jalizi hurithi kutoka kwa boti. Kamwe haviondoi vigezo vya uthibitishaji vya programu-jalizi yenyewe.
Akaunti na vitambulisho
Programu-jalizi inayoingia kwenye huduma inapaswa kushikilia akaunti moja kwa kila mfanyakazi. Mtunza hesabu huingia kwa akaunti ya fedha na msaidizi kwa akaunti yake mwenyewe, na hakuna anayeona tokeni za mwenzake. Unatangaza hili kwenye manifesti; Nebo hufanya yaliyobaki.
"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.envhutaja vitambulisho.capabilities.configSchemahuviwekea lebo na kupanga mpangilio wake kwenye fomu ya kuunganisha.auth.profileDirEnvhutaja kigezo ambacho programu-jalizi yako husoma kupata folda yake ya vitambulisho. Nebo huunda folda moja kwa kila mfanyakazi na akaunti na huweka kigezo hicho kwenye kila mwito.- Mmiliki anapounganisha akaunti, Nebo huendesha amri yako ya
loginkwa thamani alizoandika mmiliki na folda ya akaunti ikiwa imewekwa. Programu-jalizi yako huhifadhi inachohitaji katika folda hiyo. Nebo haihifadhi thamani hizo. - Amri yako ya
statushuchapisha JSON kama{"authenticated": true}. Tokeni inapoisha muda, Nebo huendesharefreshikiwa umeitangaza.
Kwa kuingia kupitia kivinjari, weka type kuwa oauth_cli na uifanye login ichapishe au ifungue URL ya kuingia ya mtoa huduma. Wafanyakazi hawaingii kamwe wenyewe: mwito unapohitaji kuingia, mmiliki huona kadi ya kuunganisha. Mfanyakazi mwenye akaunti kadhaa huchagua moja kwa kuongeza --account <label> kwenye amri. Nebo huondoa bendera hiyo kabla faili tekelezi yako haijaiona.
Taja huduma, si umbo. Jina la programu-jalizi husema inaunganishwa na nini, kama "Example Notes". Kamwe usiweke "CLI" kwenye jina la programu-jalizi; kwa wafanyakazi na wamiliki ni muunganisho, si mstari wa amri.
Inayofuata
- Marejeo ya plugin.json: kila sehemu, ikiwemo matukio, hooks na shughuli zenye aina.
- Kusafirisha programu-jalizi: majukwaa, faili tekelezi, utiaji sahihi na masasisho.
- Kuchapisha: mtiririko wa soko kwa kila kazi unayochapisha.