Πεδία ανώτατου επιπέδου
| Πεδίο | Τύπος | Υποχρεωτικό | Σημασία |
|---|---|---|---|
id | string | ναι | Το αναγνωριστικό του πρόσθετου στην αγορά. Χρησιμοποιήστε το slug κατά την ανάπτυξη. |
slug | string | ναι | Σταθερό αναγνωριστικό. [a-z0-9-], έως 64 χαρακτήρες, χωρίς παύλα στην αρχή, στο τέλος ή διπλή. Δίνει το όνομα στο εργαλείο plugin__<slug> και στη μεταβλητή <SLUG>_BIN. |
name | string | ναι | Εμφανιζόμενο όνομα. Αναφέρετε την υπηρεσία στην οποία συνδέεται. |
version | string | ναι | Σημασιολογική έκδοση, όπως 0.1.0. |
platforms | map | ναι | Κλειδί πλατφόρμας προς εκτελέσιμο. Δείτε την ενότητα Πλατφόρμες. |
description | string | όχι | Μία πρόταση για ανθρώπους και υπαλλήλους. |
author | string | όχι | Όνομα εκδότη. |
category | string | όχι | Βοηθά τους υπαλλήλους να βρουν το πρόσθετο. |
triggers | λίστα συμβολοσειρών | όχι | Λέξεις που περιγράφουν πότε ισχύει το πρόσθετο. Χρησιμοποιούνται στις υποδείξεις αναζήτησης. |
entrySkills | λίστα συμβολοσειρών | όχι | Ενσωματωμένες δεξιότητες που αναφέρονται πρώτες στην περιγραφή του εργαλείου του πρόσθετου. |
dependencies | λίστα από {name, version, optional} | όχι | Άλλα πρόσθετα που εκτελεί αυτό. Το version έχει προεπιλογή "*" και το optional έχει false. Οι διαδρομές <SLUG>_BIN τους ορίζονται σε κάθε κλήση. |
auth | object | όχι | Σύνδεση και λογαριασμοί. Δείτε την ενότητα Πιστοποίηση. |
capabilities | object | όχι | configSchema, hooks, commands, routes, providers. |
permissions | object | όχι | Φιλτράρισμα περιβάλλοντος και ανώτατο όριο χρόνου λήξης. |
events | list | όχι | Παρατηρητές που τροφοδοτούν τις ροές εργασιών των υπαλλήλων. |
interfaceBindings | map | όχι | Τυποποιημένες λειτουργίες που παρέχει το πρόσθετο. |
channel | object | όχι | Μια μόνιμη γέφυρα προς μια υπηρεσία ανταλλαγής μηνυμάτων. |
setup | object | όχι | Ένας οδηγός ρύθμισης βήμα προς βήμα. |
Το Nebo επικυρώνει τις εγκαταστάσεις από την αγορά: τους κανόνες του slug, μια σημασιολογική έκδοση, τουλάχιστον μία πλατφόρμα, ένα binaryName χωρίς διαχωριστικά διαδρομής ή .., μια εντολή login εκτός αν το auth.type είναι env, μη κενά ονόματα συμβάντων και εντολές, και πρότυπα δεσμεύσεων που αναλύονται σωστά. Τα πρόσθετα στον κατάλογο πρόσθετων χρήστη παρακάμπτουν την επικύρωση.
Πλατφόρμες
Τα κλειδιά είναι darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 και windows-amd64. Κάθε καταχώριση έχει και τα πέντε πεδία παρακάτω. Όταν δημοσιεύετε, η αγορά γράφει το πραγματικό hash, το μέγεθος, την υπογραφή και το URL λήψης, οπότε αφήστε τα κενά στο αρχείο που ανεβάζετε.
"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": "" }
} | Πεδίο | Σημασία |
|---|---|
binaryName | Το όνομα αρχείου του εκτελέσιμου. Προσθέστε .exe στα Windows. |
sha256 | Hash του εκτελέσιμου. Ελέγχεται κατά την εγκατάσταση. |
signature | Υπογραφή του εκτελέσιμου. Ελέγχεται κατά την εγκατάσταση όταν υπάρχει διαθέσιμο κλειδί υπογραφής. |
size | Μέγεθος σε byte. |
downloadUrl | Από πού κατεβάζει το Nebo το πακέτο. |
Πιστοποίηση
| Πεδίο | Σημασία |
|---|---|
type | oauth_cli για σύνδεση μέσω προγράμματος περιήγησης που εκτελεί το πρόσθετο· env για διαπιστευτήρια που εισάγονται ως τιμές· neboai για λήψη του token NeboAI του κατόχου σε κάθε κλειδί auth.env που τελειώνει σε _TOKEN. |
env | Αντιστοίχιση ονόματος μεταβλητής σε προεπιλεγμένη τιμή. Επίσης τα μόνα ονόματα διαπιστευτηρίων που περνά το Nebo στο login. |
commands.login | Συνδέει. Υποχρεωτικό εκτός αν το type είναι env. Εκτελείται με ορισμένο τον φάκελο του λογαριασμού. |
commands.status | Εμφανίζει JSON που λέει αν ο λογαριασμός είναι συνδεδεμένος. |
commands.refresh | Ανανεώνει ένα token χωρίς αλληλεπίδραση. |
commands.logout | Αποσυνδέει. Μόνο ο κάτοχος μπορεί να την εκτελέσει. |
profileDirEnv | Μεταβλητή που λαμβάνει ξεχωριστό φάκελο διαπιστευτηρίων για κάθε υπάλληλο και λογαριασμό. Χωρίς αυτήν, το πρόσθετο διατηρεί έναν κοινόχρηστο λογαριασμό. |
label, description | Κείμενο στην κάρτα σύνδεσης. |
help | {url, urlLabel, text} που εμφανίζεται κατά τη σύνδεση. |
publicRedirect | Ορίστε true όταν ο πάροχος απορρίπτει ανακατευθύνσεις http://localhost· τότε η σύνδεση περνά από τη δημόσια ανακατεύθυνση του NeboAI. |
Το Nebo διαβάζει το πρώτο από τα authenticated, isAuthenticated, logged_in, loggedIn ή token_valid στην έξοδο κατάστασης. Ένα μη κενό token_error, ή η τιμή none στα credential_source, auth_method, storage ή status, σημαίνει αποσυνδεδεμένο. Η εντολή κατάστασης έχει στη διάθεσή της 45 δευτερόλεπτα.
{"authenticated": true, "account": "finance@example.com"} configSchema
Το capabilities.configSchema περιγράφει τις τιμές που ορίζει ένας κάτοχος για το πρόσθετο. Κάθε τιμή φτάνει στο εκτελέσιμο ως μεταβλητή περιβάλλοντος με το όνομα του key. Για κλειδιά διαπιστευτηρίων που αναφέρονται επίσης στο auth.env, το σχήμα δίνει ετικέτες στα πεδία της φόρμας σύνδεσης ανά υπάλληλο.
| Πεδίο | Τύπος | Προεπιλογή | Σημασία |
|---|---|---|---|
key | string | υποχρεωτικό | Όνομα μεταβλητής περιβάλλοντος. |
label | string | υποχρεωτικό | Ετικέτα πεδίου. |
description | string | "" | Κείμενο βοήθειας. |
fieldType | string | "string" | Τύπος εισόδου, όπως string, number, boolean, select ή password. |
default | string | καμία | Προσυμπληρωμένη τιμή. |
required | boolean | false | Το πρόσθετο δεν είναι έτοιμο μέχρι να οριστεί η τιμή. |
secret | boolean | false | Η τιμή αποκρύπτεται όταν διαβάζεται ξανά. |
options | λίστα συμβολοσειρών | καμία | Επιλογές για το select. |
permissions
| Πεδίο | Προεπιλογή | Σημασία |
|---|---|---|
envAllow | [] | Κληρονομημένες μεταβλητές που μπορεί να βλέπει το πρόσθετο. Αν είναι κενό, επιτρέπονται όλες. |
envDeny | [] | Κληρονομημένες μεταβλητές που αφαιρούνται πάντα. |
maxTimeoutSeconds | 300 | Ανώτατο όριο για τον χρόνο λήξης οποιασδήποτε κλήσης. |
network | false | Δηλώνει χρήση δικτύου. Ενημερωτικό· δεν επιβάλλεται. |
events
Ένα συμβάν είναι ένας παρατηρητής μακράς διάρκειας. Το Nebo τον εκκινεί όταν μια ροή εργασιών ενός υπαλλήλου τον παρακολουθεί και τον επανεκκινεί αν τερματιστεί. Κάθε γραμμή που γράφει ο παρατηρητής στο stdout είναι ένα συμβάν. Στο όνομα του συμβάντος προστίθεται το slug ως πρόθεμα κατά την εκτέλεση, οπότε το note.created γίνεται notes-sync.note.created.
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | Πεδίο | Σημασία |
|---|---|
name | Όνομα συμβάντος, χωρίς το slug. Υποχρεωτικό. |
command | Ορίσματα που εκκινούν τον παρατηρητή. Υποχρεωτικό. Το {{key}} αντικαθίσταται από τις τιμές εισόδου του υπαλλήλου. |
description | Τι προκαλεί το συμβάν. |
multiplexed | Όταν είναι true, ένας παρατηρητής εκπέμπει πολλούς τύπους συμβάντων και κάθε γραμμή φέρει ένα πεδίο "event". |
Οι ροές εργασιών εγγράφονται σε συμβάντα με έναν ενεργοποιητή watch. Δείτε Ενεργοποιητές.
interfaceBindings
Μια δέσμευση αντιστοιχίζει μια λειτουργία διεπαφής σε μία από τις εντολές σας. Κάθε δέσμευση γίνεται ένα τυποποιημένο εργαλείο για τους υπαλλήλους, με το όνομα της λειτουργίας σε πεζά και τις τελείες και τις παύλες ως κάτω παύλες: το notes.search γίνεται notes_search. Με τις δεσμεύσεις ένα πρόσθετο καλύπτει τις δυνατότητες που απαιτεί ένας υπάλληλος· δείτε Δυνατότητες.
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | Σύμβολο κράτησης θέσης | Επεκτείνεται σε |
|---|---|
{field} | Η τιμή του πεδίου ως μία λέξη. Το πεδίο δεν περνιέται επιπλέον ως σημαία. |
{field[]:--flag} | Ένα ζεύγος --flag <item> για κάθε στοιχείο ενός πεδίου λίστας. |
{field?:--flag} | --flag <value> όταν το πεδίο υπάρχει· τίποτα όταν λείπει. |
{field:cents->dollars} | Ένα ακέραιο ποσό σε σεντς, γραμμένο ως δολάρια. |
Τα πεδία εισόδου που δεν κατονομάζει ένα πρότυπο προστίθενται στο τέλος ως --field value. Τα σύμβολα κράτησης θέσης λίστας και τα προαιρετικά πρέπει να είναι ολόκληρες λέξεις. Μια λειτουργία που απαιτεί έγκριση δεν μπορεί να προσπελαστεί καλώντας την ίδια εντολή μέσω του plugin__<slug>.
Hooks, εντολές καθέτου και διαδρομές
"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 εκτελεί την εντολή σας σε ένα σημείο του γύρου ενός υπαλλήλου. Το Nebo γράφει ένα JSON payload στο stdin. Η έξοδος ενός hook action αγνοείται. Ένα hook filter επιστρέφει {"payload": ..., "handled": false}· το "handled": true σταματά τα επόμενα hooks. Τα σφάλματα και τα χρονικά όρια διατηρούν το προηγούμενο payload και δεν μπλοκάρουν ποτέ τον γύρο. Μετά από τρεις διαδοχικές αποτυχίες, ένα hook τίθεται σε παύση για πέντε λεπτά.
| Πεδίο | Προεπιλογή | Σημασία |
|---|---|---|
hook | υποχρεωτικό | Ένα από τα tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue. |
hookType | "action" | action ή filter. |
command | υποχρεωτικό | Ορίσματα για το εκτελέσιμό σας. |
priority | 100 | Το χαμηλότερο εκτελείται πρώτο. |
timeoutMs | 500 | Χρονικό όριο σε χιλιοστά του δευτερολέπτου. |
commands
Με "slash": true, αν πληκτρολογήσετε /name args στη συνομιλία εκτελείται απευθείας το command args, χωρίς τον υπάλληλο. Η έξοδος είναι η απάντηση. Το χρονικό όριο είναι 30 δευτερόλεπτα.
routes
Μια διαδρομή απαντά σε αιτήματα HTTP στο /api/v1/plugins/<slug>/api/<path> στο bot, με αντιστοίχιση βάσει path και method. Το σώμα του αιτήματος πηγαίνει στο stdin και το stdout σας είναι η απόκριση. Το χρονικό όριο είναι 30 δευτερόλεπτα.
providers
Ένας πάροχος προσθέτει μια πηγή μοντέλων συνομιλίας. Δηλώστε id, displayName, providerType, modelsCommand και chatCommand. Το Nebo στέλνει ένα αίτημα συνομιλίας ως JSON στο stdin του chatCommand και διαβάζει τα συμβάντα ροής ως JSON οριοθετημένο με αλλαγές γραμμής από το stdout, για έως 300 δευτερόλεπτα. Σήμερα χρησιμοποιείται μόνο η ροή συνομιλίας.
channel
Ένα κανάλι γεφυρώνει μια υπηρεσία ανταλλαγής μηνυμάτων. Το Nebo κρατά το command σε λειτουργία, διαβάζει τα εισερχόμενα μηνύματα από το stdout του και γράφει τις απαντήσεις στο stdin του, και τα δύο ως JSON οριοθετημένο με αλλαγές γραμμής.
| Πεδίο | Προεπιλογή | Σημασία |
|---|---|---|
command | υποχρεωτικό | Ορίσματα που εκκινούν τη γέφυρα. |
name, description | "" | Εμφανίζεται στις ρυθμίσεις. |
restartDelaySecs | 5 | Αναμονή πριν από την επανεκκίνηση μετά από κατάρρευση. |
shared | false | Μία γέφυρα για όλους τους υπαλλήλους· τα μηνύματα δρομολογούνται με βάση το όνομα του υπαλλήλου και οι απαντήσεις φέρουν την ταυτότητα κάθε υπαλλήλου. |
needsLocalApi | false | Δίνει στη γέφυρα τη διεύθυνση του τοπικού API του bot, ένα token και το id του υπαλλήλου. Απενεργοποιημένο, εκτός αν το χρειάζεστε. |
setup
Ένας οδηγός ρύθμισης καθοδηγεί τον κάτοχο σε βήματα που δεν μπορεί να καλύψει μία φόρμα. Οι τιμές από τα βήματα form συμπληρώνουν το {{key}} σε μεταγενέστερα ορίσματα generate. Οι τιμές από τα βήματα credentials αποθηκεύονται ως μεταβλητές περιβάλλοντος του πρόσθετου.
"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" }
]
} | Είδος βήματος | Πεδία |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Εμφανίζει την έξοδο της εντολής για αντιγραφή. |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand. Το βήμα ολοκληρώνεται όταν το verifyCommand πετύχει. |
Τα πεδία έχουν key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) και required.