NeboAI
NeboAI
Magsimula

Mga Plugin

Nagbibigay ang plugin sa mga empleyado ng mapagtatrabahuhan: isang online service, isang business system, o isang programa sa computer. Binubuo mo ito bilang command-line binary at inilalarawan gamit ang plugin.json manifest. Tinatawag ng mga empleyado ang mga command nito, at ang Nebo ang bahala sa pag-install, mga account bawat empleyado at mga update.

Paano gumagana ang mga plugin

Ang plugin ay isang executable kasama ang isang manifest. Walang plugin process na pinapanatiling tumatakbo ng Nebo sa pagitan ng mga tawag. Tuwing ginagamit ng empleyado ang plugin, sinisimulan ng Nebo ang binary gamit ang isang command at mga argument, hinihintay itong matapos, at ibinabalik ang output sa empleyado.

  • Mga argument ang mga command. Pumipili ang empleyado ng command, gaya ng notes search, at mga named argument. Ipinapasa ng Nebo ang bawat argument bilang --name value. Walang shell, kaya hindi kailanman gumagana ang mga pipe at redirect.
  • Ang output ay stdout. Isulat ang mga resulta sa stdout. Mahusay gumana ang JSON.
  • Sarado ang standard input sa mga karaniwang tawag. Gumagamit ng stdin ang hooks, routes at mga chat provider; tingnan ang plugin.json reference.

Lumalabas sa mga empleyado ang bawat naka-install at naka-enable na plugin bilang isang tool na pinangalanang plugin__<slug>. Ganito ito tinatawag ng isang empleyado:

{
  "command": "notes search",
  "args": { "query": "quarterly plan", "limit": "5" },
  "display": "Search notes for the quarterly plan"
}

Pinapatakbo ng Nebo:

notes-sync notes search --query "quarterly plan" --limit 5
ParameterUriKahulugan
commandstring, kailanganAng plugin command at anumang positional na salita.
argsobject ng mga stringMga named argument. Nagiging --key value ang bawat isa.
timeoutintegerIlang segundong maghihintay. Default ay 120, nililimitahan ng permissions.maxTimeoutSeconds ng manifest.
displaystringAng pangungusap na nakikita ng may-ari kapag kailangan ng approval ang tawag.

Bumuo ng una mong plugin

Sumulat ng binary sa kahit anong wika na binabasa ang command nito mula sa mga argument at nagpi-print ng resulta. Pagkatapos, ilagay ito katabi ng isang plugin.json sa user plugins directory ng isang bot.

<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": {}
}

Kailangan ang id, slug, name, version at platforms. Sa user plugins directory, puwedeng blangko ang platforms map: naghahanap ang Nebo ng binary na pinangalanan ayon sa slug katabi ng plugin.json, saka sa target/release/ at target/debug/. Kapag nag-publish ka, pinupunan ng marketplace ang platforms para sa bawat binary na in-upload mo.

Ang <data> ay ~/Library/Application Support/Nebo sa macOS, %APPDATA%\Nebo sa Windows, at ~/.local/share/nebo sa Linux, o ang value ng NEBO_HOME. Nangingibabaw ang plugin sa user directory sa marketplace plugin na may parehong slug, kaya ito ang lugar para subukan ang bagong build.

Turuan ang mga empleyado na gamitin ito

Maglagay ng folder na skills/ katabi ng plugin.json. Available sa bawat empleyado ang bawat skill dito habang naka-install ang plugin, at kusa nitong inililista ang plugin bilang dependency. Gamitin ang skill para sabihin kung anong mga command ang mayroon, ano ang ibinabalik ng mga ito, at kailan gagamitin ang bawat isa. Pangalanan ang pinakakapaki-pakinabang na mga skill sa entrySkills para sila muna ang ituro ng tool description ng plugin.

Hiwalay na file ang listing sa marketplace, ang PLUGIN.md. Hindi ito binabasa ng Nebo habang tumatakbo; ito ang page na nakikita ng mga tao bago sila mag-install. Tingnan ang Pag-ship ng plugin.

Environment

Minamana ng bawat tawag ang environment ng bot nang inalis ang mga loader at shell-injection variable, saka idinadagdag ang mga value na ito. Nananaig ang mga nasa huli.

VariableValue
Mga key ng auth.envMga default mula sa manifest.
<SLUG>_BINPath ng binary ng plugin na ito, at ng bawat plugin na inaasahan nito. Ginagawang uppercase ang slug at ginagawang underscore ang mga gitling.
NEBO_DATA_DIRAng sariling data folder ng plugin, <data>/appdata/plugins/<slug>/. Ito rin ang working directory, at nananatili ito kahit ma-uninstall.
PATHMga folder ng plugin muna, saka ang minanang path.
SettingsMga value na sine-save ng may-ari para sa mga field ng configSchema.
NEBO_AGENT_IDAng empleyadong tumatawag.
profileDirEnvAng account folder para sa empleyado at account na ito, kapag sinusuportahan ng plugin ang mga account.

Pinakikitid ng permissions.envAllow at permissions.envDeny ang minamana ng plugin mula sa bot. Hindi nila kailanman inaalis ang sariling auth variable ng plugin.

Mga account at credential

Ang plugin na nagsa-sign in sa isang service ay dapat may hawak na isang account bawat empleyado. Nagsa-sign in ang bookkeeper gamit ang login ng finance at ang assistant gamit ang sarili nito, at walang nakakakita sa token ng isa't isa. Idinedeklara mo ito sa manifest; ang Nebo na ang bahala sa iba.

"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 }
  ]
}
  1. Pinapangalanan ng auth.env ang mga credential. Nilalagyan ng label ng capabilities.configSchema ang mga ito at itinatakda ang ayos nila sa connect form.
  2. Pinapangalanan ng auth.profileDirEnv ang variable na binabasa ng plugin mo para sa credential folder nito. Gumagawa ang Nebo ng isang folder para sa bawat empleyado at account at itinatakda ang variable na iyon sa bawat tawag.
  3. Kapag nagkonekta ang may-ari ng account, pinapatakbo ng Nebo ang login command mo gamit ang mga value na tinype ng may-ari at nakatakda ang account folder. Sine-save ng plugin mo ang kailangan nito sa folder na iyon. Hindi itinatago ng Nebo ang mga value.
  4. Nagpi-print ang command mong status ng JSON gaya ng {"authenticated": true}. Kapag nag-expire ang token, pinapatakbo ng Nebo ang refresh kung nagdeklara ka nito.

Para sa browser sign-in, itakda ang type sa oauth_cli at ipa-print o ipabukas sa login ang sign-in URL ng provider. Hindi kailanman nagsa-sign in nang mag-isa ang mga empleyado: kapag kailangan ng login ang isang tawag, makakakita ang may-ari ng connect card. Ang empleyadong may ilang account ay pumipili ng isa sa pagdagdag ng --account <label> sa command. Inaalis ng Nebo ang flag na iyon bago ito makita ng binary mo.

Pangalanan ang service, hindi ang anyo. Sinasabi ng pangalan ng plugin kung saan ito kumokonekta, gaya ng "Example Notes". Huwag kailanman maglagay ng "CLI" sa pangalan ng plugin; para sa mga empleyado at may-ari, koneksyon ito, hindi command line.

Susunod