Üst düzey alanlar
| Alan | Tür | Zorunlu | Anlamı |
|---|---|---|---|
id | string | evet | Eklentinin pazar yeri tanımlayıcısı. Geliştirme sırasında slug’ı kullanın. |
slug | string | evet | Kararlı tanımlayıcı. [a-z0-9-], en fazla 64 karakter; başta, sonda veya art arda iki kısa çizgi olamaz. plugin__<slug> aracına ve <SLUG>_BIN değişkenine ad verir. |
name | string | evet | Görünen ad. Bağlandığı hizmetin adını verin. |
version | string | evet | 0.1.0 gibi anlamsal sürüm. |
platforms | map | evet | Platform anahtarından ikili dosyaya eşleme. Bkz. Platformlar. |
description | string | hayır | İnsanlar ve çalışanlar için tek bir cümle. |
author | string | hayır | Yayıncı adı. |
category | string | hayır | Çalışanların eklentiyi bulmasına yardımcı olur. |
triggers | dize listesi | hayır | Eklentinin ne zaman uygulanacağını anlatan sözcükler. Arama ipuçlarında kullanılır. |
entrySkills | dize listesi | hayır | Eklentinin araç açıklamasında ilk olarak adı geçecek paketlenmiş beceriler. |
dependencies | {name, version, optional} listesi | hayır | Bu eklentinin çalıştırdığı diğer eklentiler. version varsayılan olarak "*", optional ise false olur. Onların <SLUG>_BIN yolları her çağrıda ayarlanır. |
auth | object | hayır | Oturum açma ve hesaplar. Bkz. Kimlik doğrulama. |
capabilities | object | hayır | configSchema, hooks, commands, routes, providers. |
permissions | object | hayır | Ortam filtreleme ve zaman aşımı üst sınırı. |
events | list | hayır | Çalışan iş akışlarını besleyen izleyiciler. |
interfaceBindings | map | hayır | Eklentinin sağladığı türlendirilmiş işlemler. |
channel | object | hayır | Bir mesajlaşma hizmetine kalıcı bir köprü. |
setup | object | hayır | Adım adım bir kurulum sihirbazı. |
Nebo, pazar yerinden yapılan kurulumları doğrular: slug kuralları, anlamsal bir sürüm, en az bir platform, yol ayırıcısı veya .. içermeyen bir binaryName, auth.type env değilse bir login komutu, boş olmayan olay adları ve komutlar ve ayrıştırılabilen bağlama şablonları. Kullanıcı eklentileri dizinindeki eklentiler doğrulamayı atlar.
Platformlar
Anahtarlar darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 ve windows-amd64’tür. Her girdide aşağıdaki beş alanın tamamı bulunur. Yayımladığınızda pazar yeri gerçek karma değerini, boyutu, imzayı ve indirme URL’sini yazar; bu yüzden yüklediğiniz dosyada bunları boş bırakın.
"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": "" }
} | Alan | Anlamı |
|---|---|
binaryName | Çalıştırılabilir dosyanın adı. Windows’ta .exe ekleyin. |
sha256 | İkili dosyanın karma değeri. Kurulumda denetlenir. |
signature | İkili dosyanın imzası. Bir imzalama anahtarı mevcutsa kurulumda denetlenir. |
size | Bayt cinsinden boyut. |
downloadUrl | Nebo’nun paketi indirdiği yer. |
Kimlik doğrulama
| Alan | Anlamı |
|---|---|
type | Eklentinin yürüttüğü tarayıcı ile oturum açma için oauth_cli; değer olarak girilen kimlik bilgileri için env; sahibin NeboAI belirtecini _TOKEN ile biten her auth.env anahtarında almak için neboai. |
env | Değişken adından varsayılan değere eşleme. Nebo’nun login komutuna geçirdiği tek kimlik bilgisi adları da bunlardır. |
commands.login | Oturum açar. type env değilse zorunludur. Hesap klasörü ayarlanmış olarak çalışır. |
commands.status | Hesabın oturum açıp açmadığını söyleyen JSON yazdırır. |
commands.refresh | Etkileşim olmadan bir belirteci yeniler. |
commands.logout | Oturumu kapatır. Yalnızca sahip çalıştırabilir. |
profileDirEnv | Her çalışan ve hesap için ayrı bir kimlik bilgisi klasörü alan değişken. Bu olmadan eklenti tek bir ortak hesap tutar. |
label, description | Bağlantı kartındaki metin. |
help | Bağlanırken gösterilen {url, urlLabel, text}. |
publicRedirect | Sağlayıcı http://localhost yönlendirmelerini reddediyorsa true yapın; oturum açma bu durumda NeboAI’nin herkese açık yönlendirmesi üzerinden geçer. |
Nebo, durum çıktısında authenticated, isAuthenticated, logged_in, loggedIn veya token_valid alanlarından ilkini okur. Boş olmayan bir token_error ya da credential_source, auth_method, storage veya status içindeki none değeri, oturumun kapalı olduğu anlamına gelir. Durum komutunun 45 saniyesi vardır.
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema, sahibin eklenti için belirlediği değerleri tanımlar. Her değer, ikili dosyaya key ile adlandırılan bir ortam değişkeni olarak ulaşır. auth.env içinde de listelenen kimlik bilgisi anahtarları için şema, çalışan başına bağlantı formunun alanlarını etiketler.
| Alan | Tür | Varsayılan | Anlamı |
|---|---|---|---|
key | string | zorunlu | Ortam değişkeni adı. |
label | string | zorunlu | Alan etiketi. |
description | string | "" | Yardım metni. |
fieldType | string | "string" | string, number, boolean, select veya password gibi giriş türü. |
default | string | yok | Önceden doldurulmuş değer. |
required | boolean | false | Değer ayarlanana kadar eklenti hazır olmaz. |
secret | boolean | false | Değer geri okunurken maskelenir. |
options | dize listesi | yok | select için seçenekler. |
permissions
| Alan | Varsayılan | Anlamı |
|---|---|---|
envAllow | [] | Eklentinin görebileceği devralınmış değişkenler. Boş bırakılırsa hepsine izin verilir. |
envDeny | [] | Her zaman kaldırılan devralınmış değişkenler. |
maxTimeoutSeconds | 300 | Herhangi bir çağrının zaman aşımı için üst sınır. |
network | false | Ağ kullanımını bildirir. Bilgi amaçlıdır; zorunlu kılınmaz. |
events
Olay, uzun süre çalışan bir izleyicidir. Nebo onu bir çalışanın iş akışı izlediğinde başlatır ve çıkış yaparsa yeniden başlatır. İzleyicinin stdout’a yazdığı her satır bir olaydır. Olay adının başına çalışma anında slug eklenir; böylece note.created, notes-sync.note.created olur.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Alan | Anlamı |
|---|---|
name | Slug olmadan olay adı. Zorunlu. |
command | İzleyiciyi başlatan argümanlar. Zorunlu. {{key}}, çalışanın giriş değerleriyle değiştirilir. |
description | Olaya neyin yol açtığı. |
multiplexed | true olduğunda tek bir izleyici birden fazla olay türü yayar ve her satır bir "event" alanı taşır. |
İş akışları olaylara bir watch tetikleyicisiyle abone olur. Bkz. Tetikleyiciler.
interfaceBindings
Bağlama, bir arayüz işlemini komutlarınızdan birine eşler. Her bağlama, çalışanlar için türlendirilmiş bir araca dönüşür ve işlemin küçük harfli adını, noktalar ve kısa çizgiler alt çizgiye çevrilmiş olarak alır: notes.search, notes_search olur. Bağlamalar, bir eklentinin bir çalışanın gerektirdiği yetenekleri nasıl karşıladığıdır; bkz. Yetenekler.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Yer tutucu | Şuna genişler |
|---|---|
{field} | Alanın değeri tek bir sözcük olarak. Alan ayrıca bayrak olarak geçirilmez. |
{field[]:--flag} | Bir liste alanındaki her öğe için bir --flag <item> çifti. |
{field?:--flag} | Alan varsa --flag <value>; yoksa hiçbir şey. |
{field:cents->dollars} | Sent cinsinden, dolar olarak yazılmış bir tam sayı tutar. |
Bir şablonun adını vermediği giriş alanları --field value olarak sona eklenir. Liste ve isteğe bağlı yer tutucular tam sözcük olmalıdır. Onay gerektiren bir işleme, aynı komut plugin__<slug> üzerinden çağrılarak ulaşılamaz.
Kancalar, eğik çizgi komutları ve rotalar
"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
Kanca, bir çalışanın sırasının belirli bir noktasında komutunuzu çalıştırır. Nebo, stdin’e bir JSON yükü yazar. Bir action kancasının çıktısı yok sayılır. Bir filter kancası {"payload": ..., "handled": false} döndürür; "handled": true sonraki kancaları durdurur. Hatalar ve zaman aşımları önceki yükü korur ve sırayı asla engellemez. Üst üste üç başarısızlıktan sonra kanca beş dakikalığına duraklatılır.
| Alan | Varsayılan | Anlamı |
|---|---|---|
hook | zorunlu | tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue değerlerinden biri. |
hookType | "action" | action veya filter. |
command | zorunlu | İkili dosyanız için argümanlar. |
priority | 100 | Düşük olan önce çalışır. |
timeoutMs | 500 | Milisaniye cinsinden süre sınırı. |
commands
"slash": true ile sohbete /name args yazmak, çalışan olmadan doğrudan command args komutunu çalıştırır. Çıktı yanıttır. Süre sınırı 30 saniyedir.
routes
Rota, bottaki /api/v1/plugins/<slug>/api/<path> adresine gelen HTTP isteklerini path ve method ile eşleştirerek yanıtlar. İstek gövdesi stdin’e gider ve stdout’unuz yanıt olur. Süre sınırı 30 saniyedir.
providers
Sağlayıcı, bir sohbet modeli kaynağı ekler. id, displayName, providerType, modelsCommand ve chatCommand bildirin. Nebo, bir sohbet isteğini stdin üzerinden JSON olarak chatCommand’a gönderir ve akışla gelen olayları stdout’tan satırla ayrılmış JSON olarak en fazla 300 saniye boyunca okur. Bugün yalnızca sohbet akışı kullanılır.
channel
Kanal, bir mesajlaşma hizmetine köprü kurar. Nebo command’ı çalışır durumda tutar, gelen iletileri stdout’undan okur ve yanıtları stdin’ine yazar; her ikisi de satırla ayrılmış JSON olarak.
| Alan | Varsayılan | Anlamı |
|---|---|---|
command | zorunlu | Köprüyü başlatan argümanlar. |
name, description | "" | Ayarlarda gösterilir. |
restartDelaySecs | 5 | Çökmeden sonra yeniden başlatmadan önce bekleme süresi. |
shared | false | Tüm çalışanlar için tek köprü; iletiler çalışan adına göre yönlendirilir ve yanıtlar her çalışanın kimliğini taşır. |
needsLocalApi | false | Köprüye botun yerel API adresini, bir belirteci ve çalışan kimliğini verin. Gerekmedikçe kapalıdır. |
setup
Kurulum sihirbazı, sahibi tek bir formun karşılayamayacağı adımlarda yönlendirir. form adımlarından gelen değerler, sonraki generate bağımsız değişkenlerindeki {{key}} alanlarını doldurur. credentials adımlarından gelen değerler eklentinin ortam değişkenleri olarak kaydedilir.
"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" }
]
} | Adım türü | Alanlar |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Kopyalanmak üzere komutun çıktısını gösterir. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Adım, verifyCommand başarılı olduğunda tamamlanır. |
Alanların key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) ve required özellikleri vardır.