Skip to Content

hiveloom health

Hits the instance’s /healthz endpoint and prints a one-line summary. This is the same check Caddy and uptime monitors should use.

Synopsis

hiveloom health [OPTIONS]

Options

FlagDescription
--endpoint <URL>API endpoint. Defaults to the local socket Hiveloom is bound to.
--token <TOKEN>Bearer token for remote API access. Not required for /healthz.
--jsonEmit a JSON object instead of a human line.

Examples

Local instance:

hiveloom health

Remote instance over HTTPS:

hiveloom health --endpoint https://hiveloom.example.com

Machine-readable, for cron or CI:

hiveloom health --json

What “healthy” means

/healthz returns 200 when the service is up and the platform DB is reachable. If you see 503, the platform DB or master key is unavailable; check journalctl -u hiveloom. If you see a connection error, the service isn’t running — start it with sudo systemctl start hiveloom.

For a deeper check that exercises the agent runtime and provider keys, run hiveloom doctor instead.