HansaChat

Documentation

Izpis JSON in avtomatizacija

Ovoj izpisa, izhodne kode, formati in varni vzorci za skripte.

CLI je zasnovan tako, da ga berejo skripte in agenti. Privzet izpis je JSON; tabele in JSON, ločen po vrsticah, sta neobvezna.

Ovoj

Vsak uspešen ukaz na stdout izpiše en objekt JSON:

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

changed pove, ali je ukaz dejansko kaj spremenil — false pomeni, da je zaželeno stanje že obstajalo. data hrani rezultat: sezname kanalov ali sporočil, sporočilo z njegovo vsebino kot pravi ugnezdeni JSON, potrdila ukazov.

Napake gredo na stderr kot JSON in se stdout nikoli ne dotaknejo:

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

Izhodne kode

Koda Pomen
0 Uspeh, vključno z operacijo brez učinka (changed: false)
1 Notranja napaka
2 Napaka rabe ali nastavitve
3 Zahtevana ali spodletela avtentikacija
4 Dostop zavrnjen ali neizpolnjen pogoj
5 Ni najdeno ali spor
6 Zamuda, nedostopnost ali omejitev števila zahtev

Vzorec robustne skripte:

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

Izhodni formati

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

Uporabne globalne zastavice

--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

Okoljska spremenljivka HANSA_CONFIG preseli celotno datoteko s konteksti, kar vzporednim opravilom omogoča izolirane kontekste. Dobava žetonov brez ključavra in delovanje ključavra sta opisana pri avtentikaciji.

Varnostne opombe

  • Poverilnice živijo samo v ključavru operacijskega sistema ali v okolju procesa — nikoli v izpisu, dnevnikih ali datoteki s konteksti.
  • Diagnostika --verbose filtrira glave za pooblastila, vnos poverilnic in odgovore za osveževanje.
  • Vsi identifikatorji so izpisani kot nizi JSON, časovni žigi kot UTC RFC3339; vsebina sporočil se pojavi kot pravi ugnezdeni JSON, ne kot niz v navedku.