Skip to content

helix status

Show whether the background daemon is running, plus a quick health snapshot pulled live from the local health and management endpoints.

Usage

helix status

Flags

This subcommand takes no flags and no arguments.

Behavior notes

  • Requires $HELIX_LICENSE. Verified at process start.
  • Reads /tmp/helix.pid. If the file is missing or the PID is no longer running, prints Helix is not running and exits 0.
  • When the daemon is alive, attempts two HTTP probes against the standard ports (best-effort — failures are silently ignored):
  • http://localhost:8181/health — health summary (status field is surfaced as Health: ...).
  • http://localhost:9999/api/info — management API info (routes, components, uptime are surfaced).
  • Always prints the log file path (/tmp/helix.log) so you can tail it immediately.

Exit codes

status always returns 0. To script "is helix up?" use the PID file or parse the output, or hit /health directly.

Examples

Check on a running daemon:

$ helix status
Helix is running (PID 12345)
  Health: up
  Routes: 8
  Components: 14
  Uptime: 2h15m
  Logs: /tmp/helix.log

Status of a non-running daemon:

$ helix status
Helix is not running

Combine with tail to watch logs from the same shell:

helix status && tail -f /tmp/helix.log

Source

cmd/helix/main.go lines 1358-1386 (cmdStatus)

See also