NeboAI
NeboAI
શરૂ કરો

પ્લગઇન

પ્લગઇન કર્મચારીઓને કામ કરવા માટે કંઈક આપે છે: ઓનલાઇન સર્વિસ, બિઝનેસ સિસ્ટમ અથવા કમ્પ્યુટર પરનો પ્રોગ્રામ. તમે તેને કમાન્ડ-લાઇન બાઇનરી તરીકે બનાવો છો અને plugin.json મેનિફેસ્ટ વડે તેનું વર્ણન કરો છો. કર્મચારીઓ તેના કમાન્ડ્સ કૉલ કરે છે, અને Nebo ઇન્સ્ટોલેશન, દરેક કર્મચારીના એકાઉન્ટ્સ અને અપડેટ્સ સંભાળે છે.

પ્લગઇન્સ કેવી રીતે કામ કરે છે

પ્લગઇન એટલે એક્ઝિક્યુટેબલ અને મેનિફેસ્ટ. Nebo કૉલ્સ વચ્ચે કોઈ પ્લગઇન પ્રોસેસ ચાલુ રાખતું નથી. દરેક વખતે કર્મચારી પ્લગઇન વાપરે ત્યારે, Nebo કમાન્ડ અને આર્ગ્યુમેન્ટ્સ સાથે બાઇનરી શરૂ કરે છે, તે બંધ થાય તેની રાહ જુએ છે, અને આઉટપુટ કર્મચારીને પાછું આપે છે.

  • કમાન્ડ્સ એ આર્ગ્યુમેન્ટ્સ છે. કર્મચારી notes search જેવો કમાન્ડ અને નામવાળા આર્ગ્યુમેન્ટ્સ પસંદ કરે છે. Nebo દરેક આર્ગ્યુમેન્ટ --name value તરીકે આપે છે. કોઈ શેલ નથી, તેથી પાઇપ્સ અને રીડાયરેક્ટ્સ ક્યારેય લાગુ પડતા નથી.
  • આઉટપુટ એ stdout છે. પરિણામો stdout પર લખો. JSON સારું કામ કરે છે.
  • સામાન્ય કૉલ્સ માટે સ્ટાન્ડર્ડ ઇનપુટ બંધ હોય છે. હૂક્સ, રૂટ્સ અને ચેટ પ્રોવાઇડર્સ 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 સુધી મર્યાદિત.
displaystringકૉલને મંજૂરીની જરૂર હોય ત્યારે માલિક જુએ છે તે વાક્ય.

તમારું પહેલું પ્લગઇન બનાવો

કોઈપણ ભાષામાં એવી બાઇનરી લખો જે આર્ગ્યુમેન્ટ્સમાંથી પોતાનો કમાન્ડ વાંચે અને પરિણામ છાપે. પછી તેને બૉટની યુઝર પ્લગઇન્સ ડિરેક્ટરીમાં plugin.jsonની બાજુમાં મૂકો.

<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 સ્લગના નામવાળી બાઇનરી plugin.jsonની બાજુમાં, પછી target/release/ અને target/debug/માં શોધે છે. તમે પ્રકાશિત કરો ત્યારે માર્કેટપ્લેસ તમે અપલોડ કરો તે દરેક બાઇનરી માટે platforms ભરે છે.

<data> macOS પર ~/Library/Application Support/Nebo, Windows પર %APPDATA%\Nebo અને Linux પર ~/.local/share/nebo છે, અથવા NEBO_HOMEની કિંમત. યુઝર ડિરેક્ટરીમાંનું પ્લગઇન એ જ સ્લગવાળા માર્કેટપ્લેસ પ્લગઇનને ઓવરરાઇડ કરે છે, જેથી નવા બિલ્ડનું ટેસ્ટિંગ કરવા માટે તે યોગ્ય જગ્યા છે.

કર્મચારીઓને તે વાપરતા શીખવો

plugin.jsonની બાજુમાં skills/ ફોલ્ડર મૂકો. તેમાંની દરેક સ્કિલ પ્લગઇન ઇન્સ્ટોલ હોય ત્યાં સુધી દરેક કર્મચારી માટે ઉપલબ્ધ રહે છે, અને પ્લગઇનને આપમેળે ડિપેન્ડન્સી તરીકે સૂચિબદ્ધ કરે છે. કયા કમાન્ડ્સ છે, તે શું પાછું આપે છે અને દરેક ક્યારે વાપરવો તે જણાવવા માટે સ્કિલ વાપરો. સૌથી ઉપયોગી સ્કિલ્સના નામ entrySkillsમાં આપો જેથી પ્લગઇનનું ટૂલ વર્ણન પહેલાં તેમના તરફ દોરે.

માર્કેટપ્લેસ લિસ્ટિંગ એક અલગ ફાઇલ છે, PLUGIN.md. Nebo તેને ચાલતી વખતે વાંચતું નથી; લોકો ઇન્સ્ટોલ કરતા પહેલાં જુએ છે તે પેજ છે. પ્લગઇન શિપ કરવું જુઓ.

એન્વાયર્નમેન્ટ

દરેક કૉલને લોડર અને શેલ-ઇન્જેક્શન વેરિએબલ્સ દૂર કરેલું બૉટનું એન્વાયર્નમેન્ટ વારસામાં મળે છે, પછી તેમાં આ કિંમતો ઉમેરાય છે. પછીની એન્ટ્રીઓ જીતે છે.

વેરિએબલકિંમત
auth.env કીઝમેનિફેસ્ટમાંથી ડિફૉલ્ટ્સ.
<SLUG>_BINઆ પ્લગઇનની બાઇનરીનો અને તે જેના પર આધાર રાખે છે તે દરેક પ્લગઇનનો પાથ. સ્લગ મોટા અક્ષરોમાં અને હાઇફનને અન્ડરસ્કોર બનાવીને લખાય છે.
NEBO_DATA_DIRપ્લગઇનનું પોતાનું ડેટા ફોલ્ડર, <data>/appdata/plugins/<slug>/. તે વર્કિંગ ડિરેક્ટરી પણ છે, અને અનઇન્સ્ટોલ પછી પણ ટકી રહે છે.
PATHપહેલાં પ્લગઇન ફોલ્ડર્સ, પછી વારસામાં મળેલો પાથ.
સેટિંગ્સમાલિકે configSchema ફીલ્ડ્સ માટે સાચવેલી કિંમતો.
NEBO_AGENT_IDકૉલ કરનાર કર્મચારી.
profileDirEnvપ્લગઇન એકાઉન્ટ્સ સપોર્ટ કરતું હોય ત્યારે, આ કર્મચારી અને એકાઉન્ટ માટેનું એકાઉન્ટ ફોલ્ડર.

permissions.envAllow અને permissions.envDeny પ્લગઇનને બૉટમાંથી વારસામાં શું મળે તે મર્યાદિત કરે છે. તેઓ પ્લગઇનના પોતાના ઑથ વેરિએબલ્સ ક્યારેય દૂર કરતા નથી.

એકાઉન્ટ્સ અને ક્રેડેન્શિયલ્સ

સર્વિસમાં સાઇન ઇન કરતા પ્લગઇને દરેક કર્મચારી માટે એક એકાઉન્ટ રાખવું જોઈએ. હિસાબનીશ ફાઇનાન્સ લૉગિનથી સાઇન ઇન કરે છે અને આસિસ્ટન્ટ પોતાના લૉગિનથી, અને કોઈ બીજાના ટોકન્સ જોતું નથી. તમે આ મેનિફેસ્ટમાં જાહેર કરો છો; બાકીનું 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 કમાન્ડ {"authenticated": true} જેવું JSON છાપે છે. ટોકન સમાપ્ત થાય ત્યારે, જો તમે refresh જાહેર કર્યો હોય તો Nebo તેને ચલાવે છે.

બ્રાઉઝર સાઇન-ઇન માટે, typeને oauth_cli પર સેટ કરો અને login પાસે પ્રોવાઇડરનું સાઇન-ઇન URL છપાવો અથવા ખોલાવો. કર્મચારીઓ ક્યારેય જાતે સાઇન ઇન કરતા નથી: કૉલને લૉગિનની જરૂર હોય ત્યારે માલિકને કનેક્ટ કાર્ડ દેખાય છે. ઘણા એકાઉન્ટ્સ ધરાવતો કર્મચારી કમાન્ડમાં --account <label> ઉમેરીને એક પસંદ કરે છે. તમારી બાઇનરી જુએ તે પહેલાં Nebo તે ફ્લેગ દૂર કરે છે.

સર્વિસનું નામ આપો, તેના સ્વરૂપનું નહીં. પ્લગઇનનું નામ જણાવે છે કે તે શાની સાથે જોડાય છે, જેમ કે "Example Notes". પ્લગઇનના નામમાં ક્યારેય "CLI" ન મૂકો; કર્મચારીઓ અને માલિકો માટે તે કનેક્શન છે, કમાન્ડ લાઇન નહીં.

આગળ

  • plugin.json સંદર્ભ: ઇવેન્ટ્સ, હૂક્સ અને ટાઇપ કરેલા ઑપરેશન્સ સહિત દરેક ફીલ્ડ.
  • પ્લગઇન શિપ કરવું: પ્લેટફોર્મ્સ, બાઇનરીઝ, સાઇનિંગ અને અપડેટ્સ.
  • પ્રકાશન: દરેક આર્ટિફેક્ટ માટે માર્કેટપ્લેસની પ્રક્રિયા.