የላይኛው ደረጃ መስኮች
| መስክ | ዓይነት | ግዴታ | ትርጉም |
|---|---|---|---|
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ን፣ auth.type env ካልሆነ በስተቀር የlogin ትዕዛዝን፣ ባዶ ያልሆኑ የክስተት ስሞችን እና ትዕዛዞችን፣ እንዲሁም በትክክል የሚተነተኑ የማሰሪያ አብነቶችን። በተጠቃሚ ተሰኪዎች አቃፊ ውስጥ ያሉ ተሰኪዎች ይህን ማረጋገጫ አያልፉም፤ ይዘለላሉ።
መድረኮች
ቁልፎቹ darwin-arm64፣ darwin-amd64፣ linux-arm64፣ linux-amd64፣ windows-arm64 እና windows-amd64 ናቸው። እያንዳንዱ ግቤት ከታች ያሉትን አምስቱንም መስኮች ይይዛል። ሲያትሙ የገበያ ቦታው ትክክለኛውን ሃሽ፣ መጠን፣ ፊርማ እና የማውረጃ 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 | የሚተገበረው ፋይል ስም። በWindows ላይ .exe ያክሉ። |
sha256 | የባይነሪው ሃሽ። በጭነት ጊዜ ይረጋገጣል። |
signature | የባይነሪው ፊርማ። የመፈረሚያ ቁልፍ ሲገኝ በጭነት ጊዜ ይረጋገጣል። |
size | መጠን በባይት። |
downloadUrl | Nebo ጥቅሉን የሚያወርድበት ቦታ። |
ማረጋገጫ
| መስክ | ትርጉም |
|---|---|
type | oauth_cli በተሰኪው ለሚካሄድ የአሳሽ መግቢያ፤ env እንደ እሴቶች ለሚገቡ የመግቢያ መረጃዎች፤ neboai የባለቤቱን የNeboAI ቶከን በ_TOKEN በሚያልቅ በእያንዳንዱ የauth.env ቁልፍ ውስጥ ለመቀበል። |
env | ከተለዋዋጭ ስም ወደ ነባሪ እሴት የሚያገናኝ ካርታ። Nebo ለlogin የሚያስተላልፋቸው የመግቢያ መረጃ ስሞችም እነዚህ ብቻ ናቸው። |
commands.login | ያስገባል። type env ካልሆነ በስተቀር ግዴታ ነው። የመለያው አቃፊ ተዘጋጅቶ ይሄዳል። |
commands.status | መለያው መግባቱን የሚገልጽ JSON ያትማል። |
commands.refresh | ያለ ተጠቃሚ መስተጋብር ቶከንን ያድሳል። |
commands.logout | ከመለያው ያስወጣል። ሊያሄደው የሚችለው ባለቤቱ ብቻ ነው። |
profileDirEnv | ለእያንዳንዱ ሰራተኛ እና መለያ የተለየ የመግቢያ መረጃ አቃፊ የሚቀበል ተለዋዋጭ። ያለሱ ተሰኪው አንድ የጋራ መለያ ይይዛል። |
label, description | በማገናኛ ካርዱ ላይ ያለ ጽሑፍ። |
help | በማገናኘት ላይ ሳለ የሚታይ {url, urlLabel, text}። |
publicRedirect | አቅራቢው የhttp://localhost ማዘዋወሪያዎችን ሲከለክል true ያድርጉት፤ ከዚያ መግቢያው በNeboAI ይፋዊ ማዘዋወሪያ በኩል ያልፋል። |
Nebo በሁኔታ ውፅዓቱ ውስጥ ከauthenticated፣ isAuthenticated፣ logged_in፣ loggedIn ወይም token_valid መጀመሪያ የሚገኘውን ያነባል። ባዶ ያልሆነ token_error፣ ወይም በcredential_source፣ auth_method፣ storage ወይም status ውስጥ ያለ የnone እሴት ከመለያው ወጥቷል ማለት ነው። የሁኔታ ትዕዛዙ 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> በኩል በመጥራት ሊደረስበት አይችልም።
መንጠቆዎች፣ የስላሽ ትዕዛዞች እና መስመሮች
"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 ይጽፋል። የaction hook ውጤት ችላ ይባላል። የfilter hook {"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
መስመር በቦቱ ላይ በ/api/v1/plugins/<slug>/api/<path> ለሚመጡ የHTTP ጥያቄዎች ምላሽ ይሰጣል፤ በ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 አድራሻ፣ ቶከን እና የሰራተኛውን መለያ ቁጥር ይስጡት። ካላስፈለገዎት ጠፍቶ ይቆያል። |
setup
የማዋቀሪያ አዋቂ ባለቤቱን አንድ ቅጽ ሊሸፍናቸው በማይችላቸው ደረጃዎች ውስጥ ይመራዋል። ከform ደረጃዎች የሚገኙ እሴቶች በኋለኞቹ የgenerate ነጋሪ እሴቶች ውስጥ {{key}}ን ይሞላሉ። ከ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 አሏቸው።