HansaChat

Documentation

JSON izvade un automatizācija

Izvades aploksne, iziešanas kodi, formāti un droši skriptu modeļi.

CLI ir veidots, lai to lasītu skripti un aģenti. JSON ir noklusējuma izvade; tabulas un JSON pa rindām ir izvēles iespēja.

Aploksne

Katra veiksmīga komanda izdod vienu JSON objektu uz stdout:

{
  "ok": true,
  "schema_version": "1",
  "workspace": "yourworkspace",
  "domain": "yourworkspace.hansa.chat",
  "changed": false,
  "data": { }
}

changed norāda, vai komanda patiesībā mainīja kaut ko — false nozīmē, ka vēlamais stāvoklis jau pastāvēja. data satur rezultātu: kanālu vai ziņojumu sarakstus, ziņojumu ar tā saturu kā īstu ligzdotu JSON, komandas apstiprinājumus.

Kļūdas nonāk stderr kā JSON un nekad neaizskar stdout:

{
  "ok": false,
  "schema_version": "1",
  "error": { "code": "unauthenticated", "message": "…", "retryable": false }
}

Iziešanas kodi

Kods Nozīme
0 Izpilde veiksmīga, tostarp darbība bez izmaiņām (changed: false)
1 Iekšēja kļūda
2 Lietošanas vai konfigurācijas kļūda
3 Nepieciešama autentifikācija vai tā neizdevās
4 Piekļuve liegta vai priekšnosacījums neizpildīts
5 Nav atrasts vai konflikts
6 Taimauts, nav pieejams vai pārsniegts pieprasījumu ierobežojums

Izturīgs skripta modelis:

if hansa chat channels ensure --name Deploy --type public >/dev/null 2>&1; then
  echo "channel ready"
fi

Izvades formāti

hansa chat channels list -o json    # default, one envelope
hansa chat channels list -o jsonl   # one JSON object per line
hansa chat channels list -o table   # aligned text columns for humans

Noderīgie globālie karodziņi

--workspace <alias-or-domain>   # override the workspace for one command
--timeout 30s                   # network timeout
--config /path/config.json      # custom context file (default: OS config dir)
--verbose                       # diagnostics to stderr, secrets filtered

Vides mainīgais HANSA_CONFIG pārvieto visu konteksta failu, kas ļauj paralēliem darbiem izmantot izolētus kontekstus. Tokenu nodrošināšanu bez atslēgu krātuves un atslēgu krātuves uzvedību apraksta raksts Autentifikācija un darbavietas.

Drošības piezīmes

  • Pieteikšanās dati atrodas tikai operētājsistēmas atslēgu krātuvē vai procesa vidē — nekad izvadē, žurnālos vai konteksta failā.
  • --verbose diagnostika filtrē autorizācijas galvenes, pieteikšanās datu ievadi un atjaunināšanas atbildes.
  • Visi identifikatori tiek izdoti kā JSON virknes, laika zīmogi kā UTC RFC3339; ziņojuma saturs parādās kā īsts ligzdots JSON, nevis kā virkne pēdiņās.