Kolom tingkat atas
| Kolom | Tipe | Wajib | Arti |
|---|---|---|---|
id | string | ya | Pengenal marketplace plugin. Gunakan slug selama pengembangan. |
slug | string | ya | Pengenal tetap. [a-z0-9-], paling banyak 64 karakter, tanpa tanda hubung di awal, di akhir, atau ganda. Menamai alat plugin__<slug> dan variabel <SLUG>_BIN. |
name | string | ya | Nama tampilan. Sebutkan layanan yang dihubungkannya. |
version | string | ya | Versi semantik, seperti 0.1.0. |
platforms | map | ya | Kunci platform ke biner. Lihat Platform. |
description | string | tidak | Satu kalimat untuk orang dan karyawan. |
author | string | tidak | Nama penerbit. |
category | string | tidak | Membantu karyawan menemukan plugin. |
triggers | daftar string | tidak | Kata-kata yang menggambarkan kapan plugin berlaku. Digunakan dalam petunjuk pencarian. |
entrySkills | daftar string | tidak | Skill bawaan yang disebut pertama dalam deskripsi alat plugin. |
dependencies | daftar {name, version, optional} | tidak | Plugin lain yang dijalankan plugin ini. version bawaannya "*"; optional bawaannya false. Path <SLUG>_BIN mereka diatur pada setiap panggilan. |
auth | object | tidak | Proses masuk dan akun. Lihat Autentikasi. |
capabilities | object | tidak | configSchema, hooks, commands, routes, providers. |
permissions | object | tidak | Penyaringan lingkungan dan batas atas waktu tunggu. |
events | list | tidak | Pemantau yang mengisi alur kerja karyawan. |
interfaceBindings | map | tidak | Operasi bertipe yang disediakan plugin. |
channel | object | tidak | Jembatan tetap ke layanan perpesanan. |
setup | object | tidak | Wizard penyiapan langkah demi langkah. |
Nebo memvalidasi instalasi dari marketplace: aturan slug, versi semantik, setidaknya satu platform, binaryName tanpa pemisah path atau .., perintah login kecuali auth.type adalah env, nama event dan perintah yang tidak kosong, serta templat binding yang dapat diurai. Plugin di direktori plugin pengguna tidak divalidasi.
Platform
Kuncinya adalah darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64, dan windows-amd64. Setiap entri memiliki kelima kolom di bawah. Saat Anda menerbitkan, marketplace menulis hash, ukuran, tanda tangan, dan URL unduhan yang sebenarnya, jadi biarkan kosong di file yang Anda unggah.
"platforms": {
"darwin-arm64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"linux-amd64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
} | Kolom | Arti |
|---|---|
binaryName | Nama file executable. Tambahkan .exe di Windows. |
sha256 | Hash biner. Diperiksa saat instalasi. |
signature | Tanda tangan biner. Diperiksa saat instalasi jika kunci penandatanganan tersedia. |
size | Ukuran dalam byte. |
downloadUrl | Tempat Nebo mengunduh paket. |
Autentikasi
| Kolom | Arti |
|---|---|
type | oauth_cli untuk proses masuk lewat browser yang dijalankan plugin; env untuk kredensial yang dimasukkan sebagai nilai; neboai untuk menerima token NeboAI pemilik di setiap kunci auth.env yang berakhiran _TOKEN. |
env | Peta nama variabel ke nilai bawaan. Juga satu-satunya nama kredensial yang diteruskan Nebo ke login. |
commands.login | Masuk. Wajib kecuali type adalah env. Berjalan dengan folder akun yang sudah diatur. |
commands.status | Mencetak JSON yang menyatakan apakah akun sudah masuk. |
commands.refresh | Memperbarui token tanpa interaksi. |
commands.logout | Keluar. Hanya pemilik yang dapat menjalankannya. |
profileDirEnv | Variabel yang menerima folder kredensial terpisah untuk setiap karyawan dan akun. Tanpanya, plugin menyimpan satu akun bersama. |
label, description | Teks pada kartu hubungkan. |
help | {url, urlLabel, text} ditampilkan saat menghubungkan. |
publicRedirect | Atur true jika penyedia menolak pengalihan http://localhost; proses masuk lalu melewati pengalihan publik NeboAI. |
Nebo membaca yang pertama dari authenticated, isAuthenticated, logged_in, loggedIn, atau token_valid di output status. token_error yang tidak kosong, atau nilai none di credential_source, auth_method, storage, atau status, berarti sudah keluar. Perintah status diberi waktu 45 detik.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema menjelaskan nilai yang diatur pemilik untuk plugin. Setiap nilai sampai ke biner sebagai variabel lingkungan yang dinamai sesuai key. Untuk kunci kredensial yang juga tercantum di auth.env, skema ini memberi label pada kolom formulir hubungkan per karyawan.
| Kolom | Tipe | Bawaan | Arti |
|---|---|---|---|
key | string | wajib | Nama variabel lingkungan. |
label | string | wajib | Label kolom. |
description | string | "" | Teks bantuan. |
fieldType | string | "string" | Tipe input, seperti string, number, boolean, select, atau password. |
default | string | tidak ada | Nilai yang sudah terisi. |
required | boolean | false | Plugin belum siap sampai nilainya diatur. |
secret | boolean | false | Nilainya disamarkan saat dibaca kembali. |
options | daftar string | tidak ada | Pilihan untuk select. |
permissions
| Kolom | Bawaan | Arti |
|---|---|---|
envAllow | [] | Variabel warisan yang boleh dilihat plugin. Kosong berarti semua diizinkan. |
envDeny | [] | Variabel warisan yang selalu dihapus. |
maxTimeoutSeconds | 300 | Batas atas untuk waktu tunggu panggilan apa pun. |
network | false | Menyatakan penggunaan jaringan. Hanya informasi; tidak diberlakukan. |
events
Event adalah pemantau yang berjalan lama. Nebo memulainya saat alur kerja karyawan memantaunya, dan memulainya ulang jika berhenti. Setiap baris yang ditulis pemantau ke stdout adalah satu event. Nama event diberi awalan slug saat berjalan, sehingga note.created menjadi notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Kolom | Arti |
|---|---|
name | Nama event, tanpa slug. Wajib. |
command | Argumen yang memulai pemantau. Wajib. {{key}} diganti dengan nilai input karyawan. |
description | Penyebab event. |
multiplexed | Jika true, satu pemantau memancarkan beberapa tipe event dan setiap baris membawa kolom "event". |
Alur kerja berlangganan event dengan pemicu watch. Lihat Pemicu.
interfaceBindings
Binding memetakan operasi antarmuka ke salah satu perintah Anda. Setiap binding menjadi alat bertipe untuk karyawan, dinamai sesuai operasinya dalam huruf kecil dengan titik dan tanda hubung diganti garis bawah: notes.search menjadi notes_search. Binding adalah cara plugin memenuhi kemampuan yang dibutuhkan karyawan; lihat Kemampuan.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Placeholder | Diperluas menjadi |
|---|---|
{field} | Nilai kolom sebagai satu kata. Kolom tersebut tidak juga diteruskan sebagai flag. |
{field[]:--flag} | Satu pasangan --flag <item> untuk setiap item dalam kolom daftar. |
{field?:--flag} | --flag <value> jika kolom ada; tidak ada apa pun jika kolom tidak ada. |
{field:cents->dollars} | Jumlah bilangan bulat dalam sen, ditulis sebagai dolar. |
Kolom input yang tidak disebut templat ditambahkan sebagai --field value. Placeholder daftar dan opsional harus berupa kata utuh. Operasi yang memerlukan persetujuan tidak dapat dijangkau dengan memanggil perintah yang sama melalui plugin__<slug>.
Hook, perintah garis miring, dan rute
"capabilities": {
"hooks": [
{ "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
],
"commands": [
{ "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
],
"routes": [
{ "path": "/callback", "method": "GET", "command": "http callback" }
]
} hooks
Hook menjalankan perintah Anda pada titik tertentu dalam giliran karyawan. Nebo menulis payload JSON ke stdin. Output hook action diabaikan. Hook filter mengembalikan {"payload": ..., "handled": false}; "handled": true menghentikan hook berikutnya. Error dan timeout mempertahankan payload sebelumnya dan tidak pernah memblokir giliran. Setelah tiga kali gagal berturut-turut, hook dijeda selama lima menit.
| Kolom | Bawaan | Arti |
|---|---|---|
hook | wajib | Salah satu dari tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action atau filter. |
command | wajib | Argumen untuk biner Anda. |
priority | 100 | Yang lebih rendah berjalan lebih dulu. |
timeoutMs | 500 | Batas waktu dalam milidetik. |
commands
Dengan "slash": true, mengetik /name args di chat langsung menjalankan command args, tanpa karyawan. Outputnya menjadi balasan. Batas waktunya 30 detik.
routes
Rute menjawab permintaan HTTP di /api/v1/plugins/<slug>/api/<path> pada bot, dicocokkan berdasarkan path dan method. Isi permintaan masuk ke stdin dan stdout Anda menjadi responsnya. Batas waktunya 30 detik.
providers
Penyedia menambahkan sumber model chat. Deklarasikan id, displayName, providerType, modelsCommand, dan chatCommand. Nebo mengirim permintaan chat sebagai JSON di stdin ke chatCommand dan membaca event yang dialirkan sebagai JSON yang dipisahkan baris baru di stdout, hingga 300 detik. Saat ini hanya streaming chat yang digunakan.
channel
Kanal menjembatani layanan perpesanan. Nebo menjaga command tetap berjalan, membaca pesan masuk dari stdout-nya, dan menulis balasan ke stdin-nya, keduanya sebagai JSON yang dipisahkan baris baru.
| Kolom | Bawaan | Arti |
|---|---|---|
command | wajib | Argumen yang memulai jembatan. |
name, description | "" | Ditampilkan di pengaturan. |
restartDelaySecs | 5 | Jeda sebelum memulai ulang setelah crash. |
shared | false | Satu jembatan untuk semua karyawan; pesan dirutekan berdasarkan nama karyawan dan balasan membawa identitas masing-masing karyawan. |
needsLocalApi | false | Memberikan alamat API lokal bot, token, dan id karyawan ke jembatan. Nonaktif kecuali Anda membutuhkannya. |
setup
Wizard penyiapan memandu pemilik melalui langkah-langkah yang tidak dapat dicakup oleh satu formulir. Nilai dari langkah form mengisi {{key}} di argumen generate berikutnya. Nilai dari langkah credentials disimpan sebagai variabel lingkungan plugin.
"setup": {
"title": "Connect Example Chat",
"steps": [
{ "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
{ "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
{ "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
{ "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
]
} | Jenis langkah | Kolom |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Menampilkan output perintah untuk disalin. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Langkah selesai saat verifyCommand berhasil. |
Kolom memiliki key, label, default, placeholder, maxLength, help, inputType (text, textarea, password), dan required.