Medan peringkat atas
| Medan | Jenis | Wajib | Maksud |
|---|---|---|---|
id | string | ya | Pengecam pasaran plugin. Gunakan slug semasa pembangunan. |
slug | string | ya | Pengecam yang stabil. [a-z0-9-], paling banyak 64 aksara, tiada tanda sempang di awal, di akhir atau berganda. Menamakan alat plugin__<slug> dan pemboleh ubah <SLUG>_BIN. |
name | string | ya | Nama paparan. Namakan perkhidmatan yang disambungkannya. |
version | string | ya | Versi semantik, seperti 0.1.0. |
platforms | map | ya | Kunci platform kepada binari. Lihat Platform. |
description | string | tidak | Satu ayat untuk orang dan pekerja. |
author | string | tidak | Nama penerbit. |
category | string | tidak | Membantu pekerja mencari plugin. |
triggers | senarai rentetan | tidak | Perkataan yang menerangkan bila plugin itu berkenaan. Digunakan dalam petunjuk carian. |
entrySkills | senarai rentetan | tidak | Kemahiran terbungkus untuk dinamakan dahulu dalam perihalan alat plugin. |
dependencies | senarai {name, version, optional} | tidak | Plugin lain yang dijalankan oleh plugin ini. version lalai kepada "*"; optional kepada false. Laluan <SLUG>_BIN mereka ditetapkan pada setiap panggilan. |
auth | object | tidak | Log masuk dan akaun. Lihat Auth. |
capabilities | object | tidak | configSchema, hooks, commands, routes, providers. |
permissions | object | tidak | Penapisan persekitaran dan had masa tamat maksimum. |
events | list | tidak | Pemerhati yang menyuap aliran kerja pekerja. |
interfaceBindings | map | tidak | Operasi bertaip yang disediakan oleh plugin. |
channel | object | tidak | Jambatan berterusan ke perkhidmatan pemesejan. |
setup | object | tidak | Wizard persediaan langkah demi langkah. |
Nebo mengesahkan pemasangan dari pasaran: peraturan slug, versi semantik, sekurang-kurangnya satu platform, binaryName tanpa pemisah laluan atau .., arahan login kecuali auth.type ialah env, nama peristiwa dan arahan yang tidak kosong, dan templat pengikatan yang boleh dihuraikan. Plugin dalam direktori plugin pengguna melangkau pengesahan.
Platform
Kuncinya ialah darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 dan windows-amd64. Setiap entri mempunyai kesemua lima medan di bawah. Apabila anda menerbitkan, pasaran menulis cincangan, saiz, tandatangan dan URL muat turun yang sebenar, jadi biarkan medan itu kosong dalam fail yang anda muat naik.
"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": "" }
} | Medan | Maksud |
|---|---|
binaryName | Nama fail boleh laku. Tambah .exe pada Windows. |
sha256 | Cincangan binari. Disemak semasa pemasangan. |
signature | Tandatangan binari. Disemak semasa pemasangan apabila kunci tandatangan tersedia. |
size | Saiz dalam bait. |
downloadUrl | Tempat Nebo memuat turun pakej. |
Auth
| Medan | Maksud |
|---|---|
type | oauth_cli untuk log masuk pelayar yang dijalankan oleh plugin; env untuk kelayakan yang dimasukkan sebagai nilai; neboai untuk menerima token NeboAI pemilik dalam setiap kunci auth.env yang berakhir dengan _TOKEN. |
env | Peta nama pemboleh ubah kepada nilai lalai. Juga satu-satunya nama kelayakan yang dihantar oleh Nebo kepada login. |
commands.login | Log masuk. Wajib kecuali type ialah env. Berjalan dengan folder akaun ditetapkan. |
commands.status | Mencetak JSON yang menyatakan sama ada akaun telah log masuk. |
commands.refresh | Memperbaharui token tanpa interaksi. |
commands.logout | Log keluar. Hanya pemilik boleh menjalankannya. |
profileDirEnv | Pemboleh ubah yang menerima folder kelayakan berasingan bagi setiap pekerja dan akaun. Tanpanya, plugin memegang satu akaun yang dikongsi. |
label, description | Teks pada kad sambungan. |
help | {url, urlLabel, text} dipaparkan semasa menyambung. |
publicRedirect | Tetapkan true apabila penyedia menolak ubah hala http://localhost; log masuk kemudiannya melalui ubah hala awam NeboAI. |
Nebo membaca yang pertama antara authenticated, isAuthenticated, logged_in, loggedIn atau token_valid dalam output status. token_error yang tidak kosong, atau nilai none dalam credential_source, auth_method, storage atau status, bermaksud telah log keluar. Arahan status diberi 45 saat.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema menerangkan nilai yang ditetapkan oleh pemilik untuk plugin. Setiap nilai sampai kepada binari sebagai pemboleh ubah persekitaran yang dinamakan oleh key. Bagi kunci kelayakan yang turut disenaraikan dalam auth.env, skema melabelkan medan borang sambungan bagi setiap pekerja.
| Medan | Jenis | Lalai | Maksud |
|---|---|---|---|
key | string | wajib | Nama pemboleh ubah persekitaran. |
label | string | wajib | Label medan. |
description | string | "" | Teks bantuan. |
fieldType | string | "string" | Jenis input, seperti string, number, boolean, select atau password. |
default | string | tiada | Nilai yang telah diisi terlebih dahulu. |
required | boolean | false | Plugin tidak sedia sehingga nilai ditetapkan. |
secret | boolean | false | Nilai disembunyikan apabila dibaca semula. |
options | senarai rentetan | tiada | Pilihan untuk select. |
permissions
| Medan | Lalai | Maksud |
|---|---|---|
envAllow | [] | Pemboleh ubah warisan yang boleh dilihat oleh plugin. Kosong membenarkan semua. |
envDeny | [] | Pemboleh ubah warisan yang sentiasa dibuang. |
maxTimeoutSeconds | 300 | Had atas bagi masa tamat mana-mana panggilan. |
network | false | Mengisytiharkan penggunaan rangkaian. Untuk makluman sahaja; tidak dikuatkuasakan. |
events
Peristiwa ialah pemerhati yang berjalan lama. Nebo memulakannya apabila aliran kerja pekerja memerhatikannya, dan memulakannya semula jika ia keluar. Setiap baris yang ditulis oleh pemerhati ke stdout ialah satu peristiwa. Nama peristiwa diawali dengan slug semasa dijalankan, jadi 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"
}
] | Medan | Maksud |
|---|---|
name | Nama peristiwa, tanpa slug. Wajib. |
command | Argumen yang memulakan pemerhati. Wajib. {{key}} digantikan daripada nilai input pekerja. |
description | Apa yang menyebabkan peristiwa. |
multiplexed | Apabila true, satu pemerhati memancarkan beberapa jenis peristiwa dan setiap baris membawa medan "event". |
Aliran kerja melanggan peristiwa dengan pencetus watch. Lihat Pencetus.
interfaceBindings
Pengikatan memetakan operasi antara muka kepada salah satu arahan anda. Setiap pengikatan menjadi alat bertaip untuk pekerja, dinamakan sempena operasi itu dalam huruf kecil dengan titik dan tanda sempang ditukar kepada garis bawah: notes.search menjadi notes_search. Pengikatan ialah cara plugin memenuhi keupayaan yang diperlukan oleh pekerja; lihat Keupayaan.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Pemegang tempat | Dikembangkan kepada |
|---|---|
{field} | Nilai medan sebagai satu perkataan. Medan itu tidak turut dihantar sebagai bendera. |
{field[]:--flag} | Satu pasangan --flag <item> bagi setiap item dalam medan senarai. |
{field?:--flag} | --flag <value> apabila medan wujud; tiada apa-apa apabila ia tiada. |
{field:cents->dollars} | Jumlah integer dalam sen, ditulis sebagai dolar. |
Medan input yang tidak dinamakan oleh templat ditambah pada hujung sebagai --field value. Pemegang tempat senarai dan pilihan mestilah perkataan penuh. Operasi yang memerlukan kelulusan tidak boleh dicapai dengan memanggil arahan yang sama melalui plugin__<slug>.
Cangkuk, arahan garis miring dan laluan
"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
Cangkuk menjalankan arahan anda pada satu titik dalam giliran pekerja. Nebo menulis muatan JSON ke stdin. Output cangkuk action diabaikan. Cangkuk filter mengembalikan {"payload": ..., "handled": false}; "handled": true menghentikan cangkuk seterusnya. Ralat dan tamat masa mengekalkan muatan sebelumnya dan tidak sekali-kali menyekat giliran. Selepas tiga kegagalan berturut-turut, cangkuk dijeda selama lima minit.
| Medan | Lalai | Maksud |
|---|---|---|
hook | wajib | Salah satu daripada 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 binari anda. |
priority | 100 | Yang lebih rendah berjalan dahulu. |
timeoutMs | 500 | Had masa dalam milisaat. |
commands
Dengan "slash": true, menaip /name args dalam sembang menjalankan command args secara terus, tanpa pekerja. Output ialah balasannya. Had masanya ialah 30 saat.
routes
Laluan menjawab permintaan HTTP di /api/v1/plugins/<slug>/api/<path> pada bot, dipadankan mengikut path dan method. Badan permintaan dihantar ke stdin dan stdout anda ialah responsnya. Had masanya ialah 30 saat.
providers
Penyedia menambah sumber model sembang. Isytiharkan id, displayName, providerType, modelsCommand dan chatCommand. Nebo menghantar permintaan sembang sebagai JSON pada stdin kepada chatCommand dan membaca peristiwa yang distrim sebagai JSON yang dipisahkan baris baharu pada stdout, sehingga 300 saat. Hanya penstriman sembang digunakan hari ini.
channel
Saluran menjambatani perkhidmatan pemesejan. Nebo memastikan command terus berjalan, membaca mesej masuk daripada stdout-nya dan menulis balasan ke stdin-nya, kedua-duanya sebagai JSON yang dipisahkan baris baharu.
| Medan | Lalai | Maksud |
|---|---|---|
command | wajib | Argumen yang memulakan jambatan. |
name, description | "" | Dipaparkan dalam tetapan. |
restartDelaySecs | 5 | Tunggu sebelum dimulakan semula selepas ranap. |
shared | false | Satu jambatan untuk semua pekerja; mesej dihalakan mengikut nama pekerja dan balasan membawa identiti setiap pekerja. |
needsLocalApi | false | Berikan jambatan alamat API tempatan bot, token dan id pekerja. Dimatikan kecuali anda memerlukannya. |
setup
Wizard persediaan membimbing pemilik melalui langkah yang tidak dapat diliputi oleh satu borang. Nilai daripada langkah form mengisi {{key}} dalam argumen generate seterusnya. Nilai daripada langkah credentials disimpan sebagai pemboleh ubah persekitaran 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 | Medan |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Memaparkan output arahan untuk disalin. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Langkah selesai apabila verifyCommand berjaya. |
Medan mempunyai key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) dan required.