ప్లగిన్లు ఎలా పనిచేస్తాయి
ప్లగిన్ అంటే ఒక ఎగ్జిక్యూటబుల్ మరియు ఒక మానిఫెస్ట్. కాల్ల మధ్య 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 ప్లగిన్ బాట్ నుండి వారసత్వంగా పొందే వాటిని పరిమితం చేస్తాయి. అవి ప్లగిన్ సొంత auth వేరియబుల్లను ఎప్పుడూ తీసివేయవు.
ఖాతాలు మరియు క్రెడెన్షియల్లు
సర్వీస్లోకి సైన్ ఇన్ అయ్యే ప్లగిన్ ప్రతి ఉద్యోగికి ఒక ఖాతాను ఉంచాలి. బుక్కీపర్ ఫైనాన్స్ లాగిన్తో, అసిస్టెంట్ తన సొంత లాగిన్తో సైన్ ఇన్ అవుతారు, ఒకరి టోకెన్లు మరొకరు చూడరు. మీరు దీన్ని మానిఫెస్ట్లో ప్రకటిస్తారు; మిగతాదంతా 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 రిఫరెన్స్: ఈవెంట్లు, హుక్లు మరియు టైప్డ్ ఆపరేషన్లతో సహా ప్రతి ఫీల్డ్.
- ప్లగిన్ను విడుదల చేయడం: ప్లాట్ఫారమ్లు, బైనరీలు, సైనింగ్ మరియు అప్డేట్లు.
- ప్రచురణ: ప్రతి ఆర్టిఫ్యాక్ట్ కోసం మార్కెట్ప్లేస్ ప్రక్రియ.