NeboAI
NeboAI
Başlayın

Eklentiler

Bir eklenti, çalışanlara üzerinde işlem yapacakları bir şey verir: çevrimiçi bir hizmet, bir iş sistemi veya bilgisayardaki bir program. Onu bir komut satırı ikili dosyası olarak derler ve bir plugin.json bildirim dosyasıyla tanımlarsınız. Çalışanlar komutlarını çağırır; kurulumu, çalışan başına hesapları ve güncellemeleri Nebo üstlenir.

Eklentiler nasıl çalışır

Eklenti, bir çalıştırılabilir dosya ile bir bildirim dosyasından oluşur. Nebo çağrılar arasında hiçbir eklenti sürecini çalışır durumda tutmaz. Bir çalışan eklentiyi her kullandığında Nebo ikili dosyayı bir komut ve argümanlarla başlatır, çıkmasını bekler ve çıktıyı çalışana geri verir.

  • Komutlar argümandır. Çalışan notes search gibi bir komut ve adlandırılmış argümanlar seçer. Nebo her argümanı --name value olarak geçirir. Kabuk yoktur; bu yüzden boru ve yönlendirmeler hiçbir zaman geçerli olmaz.
  • Çıktı stdout’tur. Sonuçları stdout’a yazın. JSON iyi çalışır.
  • Sıradan çağrılarda standart giriş kapalıdır. Kancalar, rotalar ve sohbet sağlayıcıları stdin kullanır; bkz. plugin.json başvurusu.

Kurulu ve etkin her eklenti, çalışanlara plugin__<slug> adlı tek bir araç olarak görünür. Bir çalışan onu şöyle çağırır:

{
  "command": "notes search",
  "args": { "query": "quarterly plan", "limit": "5" },
  "display": "Search notes for the quarterly plan"
}

Nebo şunu çalıştırır:

notes-sync notes search --query "quarterly plan" --limit 5
ParametreTürAnlamı
commanddize, zorunluEklenti komutu ve varsa konumsal sözcükler.
argsdizelerden oluşan nesneAdlandırılmış argümanlar. Her biri --key value olur.
timeoutintegerBeklenecek saniye. Varsayılan 120’dir ve bildirim dosyasındaki permissions.maxTimeoutSeconds ile sınırlanır.
displaystringÇağrı onay gerektirdiğinde sahibin gördüğü cümle.

İlk eklentinizi derleyin

Herhangi bir dilde, komutunu argümanlardan okuyan ve bir sonuç yazdıran bir ikili dosya yazın. Ardından onu bir botun kullanıcı eklentileri dizininde bir plugin.json dosyasının yanına koyun.

<data>/user/plugins/notes-sync/
├── plugin.json      # runtime manifest
├── notes-sync       # your binary, named after the slug
└── skills/          # optional: skills that teach employees to use it
    └── notes-sync/
        └── SKILL.md
{
  "id": "notes-sync",
  "slug": "notes-sync",
  "name": "Notes Sync",
  "version": "0.1.0",
  "description": "Search, read and create notes in Example Notes.",
  "platforms": {}
}

id, slug, name, version ve platforms zorunludur. Kullanıcı eklentileri dizininde platforms eşlemesi boş olabilir: Nebo, slug ile adlandırılmış bir ikili dosyayı önce plugin.json’ın yanında, ardından target/release/ ve target/debug/ içinde arar. Yayımladığınızda pazar yeri, yüklediğiniz her ikili dosya için platforms alanını doldurur.

<data>, macOS’ta ~/Library/Application Support/Nebo, Windows’ta %APPDATA%\Nebo, Linux’ta ~/.local/share/nebo ya da NEBO_HOME değeridir. Kullanıcı dizinindeki bir eklenti, aynı slug’a sahip pazar yeri eklentisini geçersiz kılar; bu da onu yeni bir derlemeyi test etmenin yeri yapar.

Çalışanlara kullanmayı öğretin

plugin.json’ın yanına bir skills/ klasörü koyun. İçindeki her beceri, eklenti kurulu olduğu sürece her çalışanın kullanımına açıktır ve eklentiyi otomatik olarak bağımlılık olarak listeler. Beceride hangi komutların bulunduğunu, ne döndürdüklerini ve her birinin ne zaman kullanılacağını anlatın. Eklentinin araç açıklamasının önce onları göstermesi için en yararlı becerileri entrySkills içinde adlandırın.

Pazar yeri ilanı ayrı bir dosyadır: PLUGIN.md. Nebo onu çalışma anında okumaz; insanların kurmadan önce gördüğü sayfadır. Bkz. Bir eklentiyi yayına almak.

Ortam

Her çağrı, yükleyici ve kabuk enjeksiyonu değişkenleri kaldırılmış olarak botun ortamını devralır, ardından bu değerleri ekler. Sonraki girdiler önceliklidir.

DeğişkenDeğer
auth.env anahtarlarıBildirim dosyasındaki varsayılanlar.
<SLUG>_BINBu eklentinin ve bağımlı olduğu her eklentinin ikili dosya yolu. Slug büyük harfe çevrilir ve kısa çizgiler alt çizgi olur.
NEBO_DATA_DIREklentinin kendi veri klasörü, <data>/appdata/plugins/<slug>/. Aynı zamanda çalışma dizinidir ve kaldırıldıktan sonra da korunur.
PATHÖnce eklenti klasörleri, ardından devralınan yol.
AyarlarSahibin configSchema alanları için kaydettiği değerler.
NEBO_AGENT_IDÇağrıyı yapan çalışan.
profileDirEnvEklenti hesapları destekliyorsa bu çalışan ve hesap için hesap klasörü.

permissions.envAllow ve permissions.envDeny, eklentinin bottan devraldıklarını daraltır. Eklentinin kendi kimlik doğrulama değişkenlerini asla kaldırmazlar.

Hesaplar ve kimlik bilgileri

Bir hizmette oturum açan bir eklenti, çalışan başına bir hesap tutmalıdır. Muhasebeci finans hesabıyla, asistan ise kendi hesabıyla oturum açar ve hiçbiri diğerinin belirteçlerini görmez. Bunu bildirim dosyasında bildirirsiniz; gerisini Nebo yapar.

"auth": {
  "type": "env",
  "label": "Example Notes account",
  "env": { "EXAMPLE_NOTES_TOKEN": "" },
  "commands": { "login": "auth login", "status": "auth status", "logout": "auth logout" },
  "profileDirEnv": "EXAMPLE_NOTES_CONFIG_DIR"
},
"capabilities": {
  "configSchema": [
    { "key": "EXAMPLE_NOTES_TOKEN", "label": "API token", "fieldType": "password", "secret": true, "required": true }
  ]
}
  1. auth.env kimlik bilgilerini adlandırır. capabilities.configSchema onları etiketler ve bağlantı formundaki sıralarını belirler.
  2. auth.profileDirEnv, eklentinizin kimlik bilgisi klasörü için okuduğu değişkeni adlandırır. Nebo her çalışan ve hesap için bir klasör oluşturur ve bu değişkeni her çağrıda ayarlar.
  3. Sahip bir hesap bağladığında Nebo, login komutunuzu sahibin girdiği değerlerle ve hesap klasörü ayarlanmış olarak çalıştırır. Eklentiniz ihtiyaç duyduklarını o klasöre kaydeder. Nebo bu değerleri saklamaz.
  4. status komutunuz {"authenticated": true} gibi bir JSON yazdırır. Bir belirtecin süresi dolduğunda, tanımladıysanız Nebo refresh komutunu çalıştırır.

Tarayıcıyla oturum açma için type değerini oauth_cli yapın ve login komutunun sağlayıcının oturum açma URL’sini yazdırmasını veya açmasını sağlayın. Çalışanlar asla kendi başlarına oturum açmaz: bir çağrı oturum açma gerektirdiğinde sahip bir bağlantı kartı görür. Birden fazla hesabı olan bir çalışan, bir komuta --account <label> ekleyerek birini seçer. Nebo bu bayrağı ikili dosyanız görmeden önce kaldırır.

Biçimi değil, hizmeti adlandırın. Bir eklentinin adı, neye bağlandığını söyler; örneğin "Example Notes". Bir eklentinin adına asla "CLI" koymayın; çalışanlar ve sahipler için o bir komut satırı değil, bir bağlantıdır.

Sonraki adımlar