Skip to content
Client OS
Menu

CLI command · scaffold

client health

Check that the API answers: calls /health and prints the JSON reply.

Fetches /health from the API and prints the response. Without --api-url it uses API_URL from the environment, and falls back to http://localhost:4026, the local API port.

A non-2xx answer or a connection error prints "Health check failed" and sets a non-zero exit code, so it works as a script check. Unlike the clientos commands, it goes through the API.

Usage

client health [options]

Arguments and options

--api-url <url>
API base URL (default: API_URL, then http://localhost:4026)