NeboAI
NeboAI
Mulai

Referensi plugin.json

plugin.json adalah manifes yang dibaca Nebo untuk menginstal dan menjalankan plugin. Kuncinya ditulis dalam camelCase. Halaman ini mencantumkan setiap kolom yang dibaca Nebo saat ini dan fungsi masing-masing.

Kolom tingkat atas

KolomTipeWajibArti
idstringyaPengenal marketplace plugin. Gunakan slug selama pengembangan.
slugstringyaPengenal 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.
namestringyaNama tampilan. Sebutkan layanan yang dihubungkannya.
versionstringyaVersi semantik, seperti 0.1.0.
platformsmapyaKunci platform ke biner. Lihat Platform.
descriptionstringtidakSatu kalimat untuk orang dan karyawan.
authorstringtidakNama penerbit.
categorystringtidakMembantu karyawan menemukan plugin.
triggersdaftar stringtidakKata-kata yang menggambarkan kapan plugin berlaku. Digunakan dalam petunjuk pencarian.
entrySkillsdaftar stringtidakSkill bawaan yang disebut pertama dalam deskripsi alat plugin.
dependenciesdaftar {name, version, optional}tidakPlugin lain yang dijalankan plugin ini. version bawaannya "*"; optional bawaannya false. Path <SLUG>_BIN mereka diatur pada setiap panggilan.
authobjecttidakProses masuk dan akun. Lihat Autentikasi.
capabilitiesobjecttidakconfigSchema, hooks, commands, routes, providers.
permissionsobjecttidakPenyaringan lingkungan dan batas atas waktu tunggu.
eventslisttidakPemantau yang mengisi alur kerja karyawan.
interfaceBindingsmaptidakOperasi bertipe yang disediakan plugin.
channelobjecttidakJembatan tetap ke layanan perpesanan.
setupobjecttidakWizard 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": "" }
}
KolomArti
binaryNameNama file executable. Tambahkan .exe di Windows.
sha256Hash biner. Diperiksa saat instalasi.
signatureTanda tangan biner. Diperiksa saat instalasi jika kunci penandatanganan tersedia.
sizeUkuran dalam byte.
downloadUrlTempat Nebo mengunduh paket.

Autentikasi

KolomArti
typeoauth_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.
envPeta nama variabel ke nilai bawaan. Juga satu-satunya nama kredensial yang diteruskan Nebo ke login.
commands.loginMasuk. Wajib kecuali type adalah env. Berjalan dengan folder akun yang sudah diatur.
commands.statusMencetak JSON yang menyatakan apakah akun sudah masuk.
commands.refreshMemperbarui token tanpa interaksi.
commands.logoutKeluar. Hanya pemilik yang dapat menjalankannya.
profileDirEnvVariabel yang menerima folder kredensial terpisah untuk setiap karyawan dan akun. Tanpanya, plugin menyimpan satu akun bersama.
label, descriptionTeks pada kartu hubungkan.
help{url, urlLabel, text} ditampilkan saat menghubungkan.
publicRedirectAtur 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.

KolomTipeBawaanArti
keystringwajibNama variabel lingkungan.
labelstringwajibLabel kolom.
descriptionstring""Teks bantuan.
fieldTypestring"string"Tipe input, seperti string, number, boolean, select, atau password.
defaultstringtidak adaNilai yang sudah terisi.
requiredbooleanfalsePlugin belum siap sampai nilainya diatur.
secretbooleanfalseNilainya disamarkan saat dibaca kembali.
optionsdaftar stringtidak adaPilihan untuk select.

permissions

KolomBawaanArti
envAllow[]Variabel warisan yang boleh dilihat plugin. Kosong berarti semua diizinkan.
envDeny[]Variabel warisan yang selalu dihapus.
maxTimeoutSeconds300Batas atas untuk waktu tunggu panggilan apa pun.
networkfalseMenyatakan 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"
  }
]
KolomArti
nameNama event, tanpa slug. Wajib.
commandArgumen yang memulai pemantau. Wajib. {{key}} diganti dengan nilai input karyawan.
descriptionPenyebab event.
multiplexedJika 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}"
}
PlaceholderDiperluas 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.

KolomBawaanArti
hookwajibSalah 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.
commandwajibArgumen untuk biner Anda.
priority100Yang lebih rendah berjalan lebih dulu.
timeoutMs500Batas 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.

KolomBawaanArti
commandwajibArgumen yang memulai jembatan.
name, description""Ditampilkan di pengaturan.
restartDelaySecs5Jeda sebelum memulai ulang setelah crash.
sharedfalseSatu jembatan untuk semua karyawan; pesan dirutekan berdasarkan nama karyawan dan balasan membawa identitas masing-masing karyawan.
needsLocalApifalseMemberikan 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 langkahKolom
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Menampilkan output perintah untuk disalin.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Langkah selesai saat verifyCommand berhasil.

Kolom memiliki key, label, default, placeholder, maxLength, help, inputType (text, textarea, password), dan required.