NeboAI
NeboAI
Ξεκινήστε

Πρόσθετα

Ένα πρόσθετο δίνει στους υπαλλήλους κάτι πάνω στο οποίο να ενεργούν: μια διαδικτυακή υπηρεσία, ένα επιχειρησιακό σύστημα ή ένα πρόγραμμα στον υπολογιστή. Το δημιουργείτε ως εκτελέσιμο γραμμής εντολών και το περιγράφετε με ένα manifest plugin.json. Οι υπάλληλοι καλούν τις εντολές του και το Nebo αναλαμβάνει την εγκατάσταση, τους λογαριασμούς ανά υπάλληλο και τις ενημερώσεις.

Πώς λειτουργούν τα πρόσθετα

Ένα πρόσθετο είναι ένα εκτελέσιμο μαζί με ένα manifest. Το Nebo δεν κρατά καμία διεργασία πρόσθετου σε λειτουργία μεταξύ των κλήσεων. Κάθε φορά που ένας υπάλληλος χρησιμοποιεί το πρόσθετο, το Nebo εκκινεί το εκτελέσιμο με μια εντολή και ορίσματα, περιμένει να τερματιστεί και επιστρέφει την έξοδο στον υπάλληλο.

  • Οι εντολές είναι ορίσματα. Ο υπάλληλος επιλέγει μια εντολή, όπως notes search, και ονομαστικά ορίσματα. Το Nebo περνά κάθε όρισμα ως --name value. Δεν υπάρχει shell, οπότε τα pipes και οι ανακατευθύνσεις δεν εφαρμόζονται ποτέ.
  • Η έξοδος είναι το stdout. Γράψτε τα αποτελέσματα στο stdout. Το JSON λειτουργεί καλά.
  • Η τυπική είσοδος είναι κλειστή στις συνηθισμένες κλήσεις. Τα hooks, οι διαδρομές και οι πάροχοι συνομιλίας χρησιμοποιούν το stdin· δείτε την αναφορά plugin.json.

Κάθε εγκατεστημένο και ενεργοποιημένο πρόσθετο εμφανίζεται στους υπαλλήλους ως ένα εργαλείο με όνομα plugin__<slug>. Ένας υπάλληλος το καλεί έτσι:

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

Το Nebo εκτελεί:

notes-sync notes search --query "quarterly plan" --limit 5
ΠαράμετροςΤύποςΣημασία
commandσυμβολοσειρά, υποχρεωτικόΗ εντολή του πρόσθετου και τυχόν λέξεις θέσης.
argsαντικείμενο συμβολοσειρώνΟνομαστικά ορίσματα. Το καθένα γίνεται --key value.
timeoutintegerΔευτερόλεπτα αναμονής. Προεπιλογή 120, με ανώτατο όριο το permissions.maxTimeoutSeconds του manifest.
displaystringΗ πρόταση που βλέπει ο κάτοχος όταν η κλήση χρειάζεται έγκριση.

Δημιουργήστε το πρώτο σας πρόσθετο

Γράψτε ένα εκτελέσιμο σε οποιαδήποτε γλώσσα που διαβάζει την εντολή του από τα ορίσματα και εμφανίζει ένα αποτέλεσμα. Στη συνέχεια τοποθετήστε το δίπλα σε ένα plugin.json στον κατάλογο πρόσθετων χρήστη ενός bot.

<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 και platforms είναι υποχρεωτικά. Στον κατάλογο πρόσθετων χρήστη η αντιστοίχιση platforms μπορεί να είναι κενή: το Nebo αναζητά ένα εκτελέσιμο με το όνομα του slug δίπλα στο plugin.json, μετά στο target/release/ και στο target/debug/. Όταν δημοσιεύετε, η αγορά συμπληρώνει το platforms για κάθε εκτελέσιμο που ανεβάζετε.

Το <data> είναι ~/Library/Application Support/Nebo στο macOS, %APPDATA%\Nebo στα Windows και ~/.local/share/nebo στο Linux, ή η τιμή του NEBO_HOME. Ένα πρόσθετο στον κατάλογο χρήστη υπερισχύει ενός πρόσθετου της αγοράς με το ίδιο slug, γι’ αυτό είναι το σημείο για να δοκιμάσετε μια νέα έκδοση.

Μάθετε στους υπαλλήλους να το χρησιμοποιούν

Βάλτε έναν φάκελο skills/ δίπλα στο plugin.json. Κάθε δεξιότητα σε αυτόν είναι διαθέσιμη σε κάθε υπάλληλο όσο το πρόσθετο είναι εγκατεστημένο και δηλώνει αυτόματα το πρόσθετο ως εξάρτηση. Χρησιμοποιήστε τη δεξιότητα για να πείτε ποιες εντολές υπάρχουν, τι επιστρέφουν και πότε χρησιμοποιείται η καθεμία. Αναφέρετε τις πιο χρήσιμες δεξιότητες στο entrySkills ώστε η περιγραφή του εργαλείου του πρόσθετου να παραπέμπει πρώτα σε αυτές.

Η καταχώριση στην αγορά είναι ξεχωριστό αρχείο, το PLUGIN.md. Το Nebo δεν το διαβάζει κατά την εκτέλεση· είναι η σελίδα που βλέπουν οι άνθρωποι πριν από την εγκατάσταση. Δείτε Διάθεση πρόσθετου.

Περιβάλλον

Κάθε κλήση κληρονομεί το περιβάλλον του bot, χωρίς τις μεταβλητές φόρτωσης και έγχυσης shell, και στη συνέχεια προσθέτει αυτές τις τιμές. Οι μεταγενέστερες καταχωρίσεις υπερισχύουν.

ΜεταβλητήΤιμή
Κλειδιά auth.envΠροεπιλογές από το manifest.
<SLUG>_BINΔιαδρομή του εκτελέσιμου αυτού του πρόσθετου και κάθε πρόσθετου από το οποίο εξαρτάται. Το slug γράφεται με κεφαλαία και οι παύλες γίνονται κάτω παύλες.
NEBO_DATA_DIRΟ δικός φάκελος δεδομένων του πρόσθετου, <data>/appdata/plugins/<slug>/. Είναι επίσης ο κατάλογος εργασίας και διατηρείται μετά την απεγκατάσταση.
PATHΠρώτα οι φάκελοι των πρόσθετων, μετά η κληρονομημένη διαδρομή.
ΡυθμίσειςΤιμές που αποθήκευσε ο κάτοχος για τα πεδία του configSchema.
NEBO_AGENT_IDΟ υπάλληλος που κάνει την κλήση.
profileDirEnvΟ φάκελος λογαριασμού για αυτόν τον υπάλληλο και λογαριασμό, όταν το πρόσθετο υποστηρίζει λογαριασμούς.

Τα permissions.envAllow και permissions.envDeny περιορίζουν όσα κληρονομεί το πρόσθετο από το bot. Δεν αφαιρούν ποτέ τις δικές μεταβλητές πιστοποίησης του πρόσθετου.

Λογαριασμοί και διαπιστευτήρια

Ένα πρόσθετο που συνδέεται σε μια υπηρεσία πρέπει να διατηρεί έναν λογαριασμό ανά υπάλληλο. Ο λογιστής συνδέεται με τα στοιχεία του λογιστηρίου και ο βοηθός με τα δικά του, και κανείς δεν βλέπει τα tokens του άλλου. Το δηλώνετε στο manifest· το Nebo κάνει τα υπόλοιπα.

"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 ονομάζει τα διαπιστευτήρια. Το capabilities.configSchema τους δίνει ετικέτες και ορίζει τη σειρά τους στη φόρμα σύνδεσης.
  2. Το auth.profileDirEnv ονομάζει τη μεταβλητή που διαβάζει το πρόσθετό σας για τον φάκελο διαπιστευτηρίων του. Το Nebo δημιουργεί έναν φάκελο για κάθε υπάλληλο και λογαριασμό και ορίζει αυτή τη μεταβλητή σε κάθε κλήση.
  3. Όταν ο κάτοχος συνδέει έναν λογαριασμό, το Nebo εκτελεί την εντολή login σας με τις τιμές που πληκτρολόγησε ο κάτοχος και με ορισμένο τον φάκελο του λογαριασμού. Το πρόσθετό σας αποθηκεύει ό,τι χρειάζεται σε αυτόν τον φάκελο. Το Nebo δεν κρατά τις τιμές.
  4. Η εντολή σας status τυπώνει JSON όπως {"authenticated": true}. Όταν λήγει ένα διακριτικό, το Nebo εκτελεί το refresh αν έχετε δηλώσει ένα.

Για σύνδεση μέσω προγράμματος περιήγησης, ορίστε το type σε oauth_cli και κάντε το login να εμφανίζει ή να ανοίγει το URL σύνδεσης του παρόχου. Οι υπάλληλοι δεν συνδέονται ποτέ μόνοι τους: όταν μια κλήση χρειάζεται σύνδεση, ο κάτοχος βλέπει μια κάρτα σύνδεσης. Ένας υπάλληλος με πολλούς λογαριασμούς επιλέγει έναν προσθέτοντας --account <label> σε μια εντολή. Το Nebo αφαιρεί αυτή τη σημαία πριν τη δει το εκτελέσιμό σας.

Ονομάστε την υπηρεσία, όχι τη μορφή. Το όνομα ενός πρόσθετου λέει πού συνδέεται, όπως «Example Notes». Μη βάζετε ποτέ «CLI» στο όνομα ενός πρόσθετου· για τους υπαλλήλους και τους κατόχους είναι μια σύνδεση, όχι μια γραμμή εντολών.

Επόμενα