איך תוספים עובדים
תוסף הוא קובץ הפעלה ועוד מניפסט. Nebo לא משאיר שום תהליך של תוסף פועל בין קריאות. בכל פעם שעובד משתמש בתוסף, Nebo מפעיל את הקובץ הבינארי עם פקודה וארגומנטים, מחכה שהוא יסיים, ומחזיר את הפלט לעובד.
- פקודות הן ארגומנטים. העובד בוחר פקודה, כמו
notes search, וארגומנטים בעלי שם. Nebo מעביר כל ארגומנט כ---name value. אין מעטפת, ולכן צינורות והפניות אף פעם לא חלים. - הפלט הוא stdout. כתוב את התוצאות ל-stdout. JSON עובד טוב.
- הקלט הסטנדרטי סגור בקריאות רגילות. Hooks, נתיבים וספקי צ׳אט משתמשים ב-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> הוא ~/Library/Application Support/Nebo ב-macOS, %APPDATA%\Nebo ב-Windows ו-~/.local/share/nebo ב-Linux, או הערך של NEBO_HOME. תוסף בתיקיית המשתמש גובר על תוסף מהחנות עם אותו slug, ולכן זה המקום לבדוק בו גרסה חדשה.
למד את העובדים להשתמש בו
שים תיקיית skills/ ליד plugin.json. כל כישור בתוכה זמין לכל עובד כל עוד התוסף מותקן, ומציין את התוסף כתלות באופן אוטומטי. השתמש בכישור כדי לומר אילו פקודות קיימות, מה הן מחזירות ומתי להשתמש בכל אחת. ציין את הכישורים השימושיים ביותר ב-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שלך מדפיסה JSON כמו{"authenticated": true}. כשאסימון פג, Nebo מריץ אתrefreshאם הגדרת כזו.
להתחברות בדפדפן, הגדר את type כ-oauth_cli, ותן ל-login להדפיס או לפתוח את כתובת ההתחברות של הספק. עובדים אף פעם לא מתחברים בעצמם: כשקריאה צריכה התחברות, הבעלים רואה כרטיס חיבור. עובד עם כמה חשבונות בוחר אחד מהם על ידי הוספת --account <label> לפקודה. Nebo מסיר את הדגל הזה לפני שהקובץ הבינארי שלך רואה אותו.
קרא לו על שם השירות, לא על שם הצורה. שם התוסף אומר למה הוא מתחבר, כמו "Example Notes". אף פעם אל תכניס "CLI" לשם של תוסף; בעיני העובדים והבעלים זה חיבור, לא שורת פקודה.
הבא
- מדריך העיון ל-plugin.json: כל שדה, כולל אירועים, hooks ופעולות מוגדרות טיפוס.
- הפצת תוסף: פלטפורמות, קבצים בינאריים, חתימה ועדכונים.
- פרסום: תהליך הפרסום בחנות לכל סוג של פריט.