NeboAI
NeboAI
Mulakan

Plugin

Plugin memberi pekerja sesuatu untuk diusahakan: perkhidmatan dalam talian, sistem perniagaan atau program pada komputer. Anda membinanya sebagai binari baris arahan dan menerangkannya dengan manifes plugin.json. Pekerja memanggil arahannya, dan Nebo menguruskan pemasangan, akaun bagi setiap pekerja dan kemas kini.

Cara plugin berfungsi

Plugin ialah fail boleh laku serta manifes. Nebo tidak membiarkan sebarang proses plugin berjalan antara panggilan. Setiap kali pekerja menggunakan plugin, Nebo memulakan binari dengan arahan dan argumen, menunggu ia keluar, dan menyerahkan output kembali kepada pekerja.

  • Arahan ialah argumen. Pekerja memilih arahan, seperti notes search, dan argumen bernama. Nebo menghantar setiap argumen sebagai --name value. Tiada shell, jadi paip dan ubah hala tidak pernah berkenaan.
  • Output ialah stdout. Tulis hasil ke stdout. JSON berfungsi dengan baik.
  • Input standard ditutup untuk panggilan biasa. Cangkuk, laluan dan penyedia sembang menggunakan stdin; lihat rujukan plugin.json.

Setiap plugin yang dipasang dan didayakan muncul kepada pekerja sebagai satu alat bernama plugin__<slug>. Pekerja memanggilnya seperti ini:

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

Nebo menjalankan:

notes-sync notes search --query "quarterly plan" --limit 5
ParameterJenisMaksud
commandrentetan, wajibArahan plugin dan sebarang perkataan kedudukan.
argsobjek rentetanArgumen bernama. Setiap satu menjadi --key value.
timeoutintegerSaat untuk menunggu. Lalai 120, dihadkan oleh permissions.maxTimeoutSeconds dalam manifes.
displaystringAyat yang dilihat oleh pemilik apabila panggilan memerlukan kelulusan.

Bina plugin pertama anda

Tulis binari dalam mana-mana bahasa yang membaca arahannya daripada argumen dan mencetak hasil. Kemudian letakkannya bersebelahan plugin.json dalam direktori plugin pengguna sesebuah 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": {}
}

id, slug, name, version dan platforms adalah wajib. Dalam direktori plugin pengguna, peta platforms boleh kosong: Nebo mencari binari yang dinamakan sempena slug bersebelahan plugin.json, kemudian dalam target/release/ dan target/debug/. Apabila anda menerbitkan, pasaran mengisi platforms untuk setiap binari yang anda muat naik.

<data> ialah ~/Library/Application Support/Nebo pada macOS, %APPDATA%\Nebo pada Windows, dan ~/.local/share/nebo pada Linux, atau nilai NEBO_HOME. Plugin dalam direktori pengguna mengatasi plugin pasaran dengan slug yang sama, menjadikannya tempat untuk menguji binaan baharu.

Ajar pekerja menggunakannya

Letakkan folder skills/ bersebelahan plugin.json. Setiap kemahiran di dalamnya tersedia kepada setiap pekerja selagi plugin dipasang, dan menyenaraikan plugin sebagai kebergantungan secara automatik. Gunakan kemahiran untuk menyatakan arahan yang wujud, apa yang dikembalikannya, dan bila menggunakan setiap satu. Namakan kemahiran yang paling berguna dalam entrySkills supaya perihalan alat plugin menunjuk kepadanya dahulu.

Senarai pasaran ialah fail berasingan, PLUGIN.md. Nebo tidak membacanya semasa masa jalan; ia ialah halaman yang dilihat orang sebelum memasang. Lihat Menghantar plugin.

Persekitaran

Setiap panggilan mewarisi persekitaran bot dengan pemboleh ubah pemuat dan suntikan shell dibuang, kemudian menambah nilai-nilai ini. Entri yang kemudian diutamakan.

Pemboleh ubahNilai
Kunci auth.envNilai lalai daripada manifes.
<SLUG>_BINLaluan binari plugin ini, dan setiap plugin yang menjadi kebergantungannya. Slug ditukar kepada huruf besar dengan tanda sempang sebagai garis bawah.
NEBO_DATA_DIRFolder data plugin itu sendiri, <data>/appdata/plugins/<slug>/. Ia juga direktori kerja, dan ia kekal selepas penyahpasangan.
PATHFolder plugin dahulu, kemudian laluan warisan.
TetapanNilai yang disimpan oleh pemilik untuk medan configSchema.
NEBO_AGENT_IDPekerja yang membuat panggilan.
profileDirEnvFolder akaun untuk pekerja dan akaun ini, apabila plugin menyokong akaun.

permissions.envAllow dan permissions.envDeny menyempitkan apa yang diwarisi plugin daripada bot. Ia tidak pernah membuang pemboleh ubah pengesahan plugin itu sendiri.

Akaun dan kelayakan

Plugin yang log masuk ke sesuatu perkhidmatan harus memegang satu akaun bagi setiap pekerja. Penyimpan kira-kira log masuk dengan log masuk kewangan dan pembantu dengan log masuknya sendiri, dan kedua-duanya tidak melihat token satu sama lain. Anda mengisytiharkan ini dalam manifes; Nebo melakukan selebihnya.

"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. auth.env menamakan kelayakan. capabilities.configSchema melabelkannya dan menetapkan susunannya dalam borang sambungan.
  2. auth.profileDirEnv menamakan pemboleh ubah yang dibaca oleh plugin anda untuk folder kelayakannya. Nebo mencipta satu folder bagi setiap pekerja dan akaun dan menetapkan pemboleh ubah itu pada setiap panggilan.
  3. Apabila pemilik menyambungkan akaun, Nebo menjalankan arahan login anda dengan nilai yang ditaip oleh pemilik dan folder akaun ditetapkan. Plugin anda menyimpan apa yang diperlukannya dalam folder itu. Nebo tidak menyimpan nilai tersebut.
  4. Arahan status anda mencetak JSON seperti {"authenticated": true}. Apabila token luput, Nebo menjalankan refresh jika anda mengisytiharkannya.

Untuk log masuk pelayar, tetapkan type kepada oauth_cli dan biarkan login mencetak atau membuka URL log masuk penyedia. Pekerja tidak pernah log masuk sendiri: apabila panggilan memerlukan log masuk, pemilik melihat kad sambungan. Pekerja yang mempunyai beberapa akaun memilih satu dengan menambah --account <label> pada arahan. Nebo membuang bendera itu sebelum binari anda melihatnya.

Namakan perkhidmatan, bukan bentuknya. Nama plugin menyatakan apa yang disambungkannya, seperti "Example Notes". Jangan sekali-kali letakkan "CLI" dalam nama plugin; bagi pekerja dan pemilik, ia ialah sambungan, bukan baris arahan.

Seterusnya