NeboAI
NeboAI
ప్రారంభించండి

plugin.json రిఫరెన్స్

plugin.json అనేది ప్లగిన్‌ను ఇన్‌స్టాల్ చేసి నడపడానికి Nebo చదివే మానిఫెస్ట్. కీలు camelCaseలో ఉంటాయి. ఈ పేజీ ఈరోజు Nebo చదివే ప్రతి ఫీల్డ్‌ను, ఒక్కొక్కటి ఏమి చేస్తుందో జాబితా చేస్తుంది.

టాప్-లెవల్ ఫీల్డ్‌లు

ఫీల్డ్రకంతప్పనిసరిఅర్థం
idstringఅవునుప్లగిన్ మార్కెట్‌ప్లేస్ ఐడెంటిఫైయర్. డెవలప్ చేసేటప్పుడు slugను ఉపయోగించండి.
slugstringఅవునుస్థిరమైన ఐడెంటిఫైయర్. [a-z0-9-], గరిష్ఠంగా 64 అక్షరాలు, ముందు, చివర లేదా వరుసగా రెండు హైఫన్‌లు ఉండకూడదు. plugin__<slug> టూల్‌కు, <SLUG>_BIN వేరియబుల్‌కు పేరు ఇస్తుంది.
namestringఅవునుప్రదర్శన పేరు. ఇది కనెక్ట్ అయ్యే సర్వీస్ పేరు పెట్టండి.
versionstringఅవును0.1.0 వంటి సెమాంటిక్ వెర్షన్.
platformsmapఅవునుప్లాట్‌ఫారమ్ కీ నుండి బైనరీకి. ప్లాట్‌ఫారమ్‌లు చూడండి.
descriptionstringకాదువ్యక్తులు మరియు ఉద్యోగుల కోసం ఒక వాక్యం.
authorstringకాదుపబ్లిషర్ పేరు.
categorystringకాదుఉద్యోగులు ప్లగిన్‌ను కనుగొనడంలో సహాయపడుతుంది.
triggersస్ట్రింగ్‌ల జాబితాకాదుప్లగిన్ ఎప్పుడు వర్తిస్తుందో వివరించే పదాలు. సెర్చ్ సూచనల్లో ఉపయోగిస్తారు.
entrySkillsస్ట్రింగ్‌ల జాబితాకాదుప్లగిన్ టూల్ వివరణలో ముందుగా పేర్కొనాల్సిన బండిల్ చేసిన నైపుణ్యాలు.
dependencies{name, version, optional} జాబితాకాదుఈ ప్లగిన్ నడిపే ఇతర ప్లగిన్‌లు. version డిఫాల్ట్‌గా "*"; optional డిఫాల్ట్‌గా false. వాటి <SLUG>_BIN పాత్‌లు ప్రతి కాల్‌లో సెట్ చేయబడతాయి.
authobjectకాదుసైన్-ఇన్ మరియు ఖాతాలు. Auth చూడండి.
capabilitiesobjectకాదుconfigSchema, hooks, commands, routes, providers.
permissionsobjectకాదుఎన్విరాన్‌మెంట్ ఫిల్టరింగ్ మరియు టైమ్‌అవుట్ గరిష్ఠ పరిమితి.
eventslistకాదుఉద్యోగుల వర్క్‌ఫ్లోలకు సమాచారం అందించే వాచర్‌లు.
interfaceBindingsmapకాదుప్లగిన్ అందించే టైప్డ్ ఆపరేషన్‌లు.
channelobjectకాదుమెసేజింగ్ సర్వీస్‌కు శాశ్వత బ్రిడ్జ్.
setupobjectకాదుదశలవారీ సెటప్ విజార్డ్.

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బైట్‌లలో పరిమాణం.
downloadUrlNebo ప్యాకేజీని ఎక్కడ నుండి డౌన్‌లోడ్ చేస్తుందో.

Auth

ఫీల్డ్అర్థం
typeప్లగిన్ నడిపే బ్రౌజర్ సైన్-ఇన్ కోసం oauth_cli; విలువలుగా నమోదు చేసే క్రెడెన్షియల్‌ల కోసం env; _TOKENతో ముగిసే ప్రతి auth.env కీలో యజమాని NeboAI టోకెన్‌ను పొందడానికి neboai.
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లో కూడా ఉన్న క్రెడెన్షియల్ కీల కోసం, స్కీమా ఉద్యోగి వారీ కనెక్ట్ ఫారమ్ ఫీల్డ్‌లకు లేబుల్‌లు ఇస్తుంది.

ఫీల్డ్రకండిఫాల్ట్అర్థం
keystringతప్పనిసరిఎన్విరాన్‌మెంట్ వేరియబుల్ పేరు.
labelstringతప్పనిసరిఫీల్డ్ లేబుల్.
descriptionstring""సహాయ టెక్స్ట్.
fieldTypestring"string"string, number, boolean, select లేదా password వంటి ఇన్‌పుట్ రకం.
defaultstringఏదీ లేదుముందే నింపిన విలువ.
requiredbooleanfalseవిలువ సెట్ చేసే వరకు ప్లగిన్ సిద్ధంగా ఉండదు.
secretbooleanfalseతిరిగి చదివినప్పుడు విలువ కనిపించకుండా మాస్క్ చేయబడుతుంది.
optionsస్ట్రింగ్‌ల జాబితాఏదీ లేదుselect కోసం ఎంపికలు.

permissions

ఫీల్డ్డిఫాల్ట్అర్థం
envAllow[]ప్లగిన్ చూడగల వారసత్వ వేరియబుల్‌లు. ఖాళీగా ఉంటే అన్నింటినీ అనుమతిస్తుంది.
envDeny[]ఎప్పుడూ తీసివేయబడే వారసత్వ వేరియబుల్‌లు.
maxTimeoutSeconds300ఏ కాల్ టైమ్‌అవుట్‌కైనా గరిష్ఠ పరిమితి.
networkfalseనెట్‌వర్క్ వినియోగాన్ని ప్రకటిస్తుంది. సమాచారం కోసం మాత్రమే; అమలు చేయబడదు.

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"
  }
]
ఫీల్డ్అర్థం
nameslug లేకుండా ఈవెంట్ పేరు. తప్పనిసరి.
commandవాచర్‌ను ప్రారంభించే ఆర్గ్యుమెంట్‌లు. తప్పనిసరి. {{key}} ఉద్యోగి ఇన్‌పుట్ విలువలతో భర్తీ చేయబడుతుంది.
descriptionఈవెంట్‌కు కారణం ఏమిటి.
multiplexedtrue అయినప్పుడు, ఒకే వాచర్ అనేక ఈవెంట్ రకాలను విడుదల చేస్తుంది, ప్రతి లైన్‌లో "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

హుక్ అనేది ఉద్యోగి టర్న్‌లోని ఒక సమయంలో మీ కమాండ్‌ను రన్ చేస్తుంది. Nebo ఒక JSON పేలోడ్‌ను stdinకి రాస్తుంది. action హుక్ అవుట్‌పుట్ విస్మరించబడుతుంది. filter హుక్ {"payload": ..., "handled": false}ను తిరిగి ఇస్తుంది; "handled": true తర్వాతి హుక్‌లను ఆపుతుంది. లోపాలు మరియు టైమ్‌అవుట్‌లు మునుపటి పేలోడ్‌నే ఉంచుతాయి, టర్న్‌ను ఎప్పుడూ అడ్డుకోవు. వరుసగా మూడుసార్లు విఫలమైతే, హుక్ ఐదు నిమిషాల పాటు నిలిపివేయబడుతుంది.

ఫీల్డ్డిఫాల్ట్అర్థం
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తప్పనిసరిమీ బైనరీకి ఆర్గ్యుమెంట్‌లు.
priority100తక్కువది ముందు నడుస్తుంది.
timeoutMs500మిల్లీసెకన్లలో సమయ పరిమితి.

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 చాట్ అభ్యర్థనను stdinలో JSONగా chatCommandకు పంపుతుంది, స్ట్రీమ్ చేసిన ఈవెంట్‌లను stdoutలో newline-delimited JSONగా 300 సెకన్ల వరకు చదువుతుంది. ఈరోజు చాట్ స్ట్రీమింగ్ మాత్రమే ఉపయోగించబడుతుంది.

channel

ఛానెల్ ఒక మెసేజింగ్ సర్వీస్‌ను కలుపుతుంది. Nebo commandను నడుస్తూనే ఉంచుతుంది, దాని stdout నుండి వచ్చే సందేశాలను చదువుతుంది, జవాబులను దాని stdinకు రాస్తుంది, రెండూ newline-delimited JSONగా.

ఫీల్డ్డిఫాల్ట్అర్థం
commandతప్పనిసరిబ్రిడ్జ్‌ను ప్రారంభించే ఆర్గ్యుమెంట్‌లు.
name, description""సెట్టింగ్‌లలో చూపబడుతుంది.
restartDelaySecs5క్రాష్ తర్వాత మళ్లీ ప్రారంభించే ముందు వేచి ఉండే సమయం.
sharedfalseఉద్యోగులందరికీ ఒకే బ్రిడ్జ్; సందేశాలు ఉద్యోగి పేరు ఆధారంగా రూట్ అవుతాయి, జవాబుల్లో ప్రతి ఉద్యోగి గుర్తింపు ఉంటుంది.
needsLocalApifalseబ్రిడ్జ్‌కు బాట్ లోకల్ API చిరునామా, ఒక టోకెన్ మరియు ఉద్యోగి idని ఇవ్వండి. మీకు అవసరమైతే తప్ప ఆఫ్‌లో ఉంటుంది.

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" }
  ]
}
దశ రకంఫీల్డ్‌లు
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. కాపీ చేసుకోవడానికి కమాండ్ అవుట్‌పుట్‌ను చూపిస్తుంది.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. verifyCommand విజయవంతమైనప్పుడు దశ పూర్తవుతుంది.

ఫీల్డ్‌లలో key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) మరియు required ఉంటాయి.