NeboAI
NeboAI
Başlayın

plugin.json referansı

plugin.json, Nebo’nun bir eklentiyi kurmak ve çalıştırmak için okuduğu bildirim dosyasıdır. Anahtarlar camelCase yazılır. Bu sayfa, Nebo’nun bugün okuduğu her alanı ve her birinin ne yaptığını listeler.

Üst düzey alanlar

AlanTürZorunluAnlamı
idstringevetEklentinin pazar yeri tanımlayıcısı. Geliştirme sırasında slug’ı kullanın.
slugstringevetKararlı 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.
namestringevetGörünen ad. Bağlandığı hizmetin adını verin.
versionstringevet0.1.0 gibi anlamsal sürüm.
platformsmapevetPlatform anahtarından ikili dosyaya eşleme. Bkz. Platformlar.
descriptionstringhayırİnsanlar ve çalışanlar için tek bir cümle.
authorstringhayırYayıncı adı.
categorystringhayırÇalışanların eklentiyi bulmasına yardımcı olur.
triggersdize listesihayırEklentinin ne zaman uygulanacağını anlatan sözcükler. Arama ipuçlarında kullanılır.
entrySkillsdize listesihayırEklentinin araç açıklamasında ilk olarak adı geçecek paketlenmiş beceriler.
dependencies{name, version, optional} listesihayırBu 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.
authobjecthayırOturum açma ve hesaplar. Bkz. Kimlik doğrulama.
capabilitiesobjecthayırconfigSchema, hooks, commands, routes, providers.
permissionsobjecthayırOrtam filtreleme ve zaman aşımı üst sınırı.
eventslisthayırÇalışan iş akışlarını besleyen izleyiciler.
interfaceBindingsmaphayırEklentinin sağladığı türlendirilmiş işlemler.
channelobjecthayırBir mesajlaşma hizmetine kalıcı bir köprü.
setupobjecthayırAdı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": "" }
}
AlanAnlamı
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.
sizeBayt cinsinden boyut.
downloadUrlNebo’nun paketi indirdiği yer.

Kimlik doğrulama

AlanAnlamı
typeEklentinin 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.
envDeğ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.loginOturum açar. type env değilse zorunludur. Hesap klasörü ayarlanmış olarak çalışır.
commands.statusHesabın oturum açıp açmadığını söyleyen JSON yazdırır.
commands.refreshEtkileşim olmadan bir belirteci yeniler.
commands.logoutOturumu kapatır. Yalnızca sahip çalıştırabilir.
profileDirEnvHer ç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, descriptionBağlantı kartındaki metin.
helpBağlanırken gösterilen {url, urlLabel, text}.
publicRedirectSağ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.

AlanTürVarsayılanAnlamı
keystringzorunluOrtam değişkeni adı.
labelstringzorunluAlan etiketi.
descriptionstring""Yardım metni.
fieldTypestring"string"string, number, boolean, select veya password gibi giriş türü.
defaultstringyokÖnceden doldurulmuş değer.
requiredbooleanfalseDeğer ayarlanana kadar eklenti hazır olmaz.
secretbooleanfalseDeğer geri okunurken maskelenir.
optionsdize listesiyokselect için seçenekler.

permissions

AlanVarsayılanAnlamı
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.
maxTimeoutSeconds300Herhangi bir çağrının zaman aşımı için üst sınır.
networkfalseAğ 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"
  }
]
AlanAnlamı
nameSlug olmadan olay adı. Zorunlu.
commandİzleyiciyi başlatan argümanlar. Zorunlu. {{key}}, çalışanın giriş değerleriyle değiştirilir.
descriptionOlaya neyin yol açtığı.
multiplexedtrue 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.

AlanVarsayılanAnlamı
hookzorunlutool.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.
commandzorunluİkili dosyanız için argümanlar.
priority100Düşük olan önce çalışır.
timeoutMs500Milisaniye 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.

AlanVarsayılanAnlamı
commandzorunluKöprüyü başlatan argümanlar.
name, description""Ayarlarda gösterilir.
restartDelaySecs5Çökmeden sonra yeniden başlatmadan önce bekleme süresi.
sharedfalseTü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.
needsLocalApifalseKö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
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Kopyalanmak üzere komutun çıktısını gösterir.
externaltitle, description, url, urlLabel, instructions
credentialstitle, 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.