Skip to content
  • reference
  • cli

CLI reference

cmx

Section titled “cmx”

No arguments — opens the terminal GUI and auto-starts the gateway if it is not running.

Daemon

Section titled “Daemon”
Terminal window
cmx start     # start gateway + dashboard in the background
cmx stop      # stop the daemon
cmx restart   # reload config, restart daemon
cmx status    # running? ports? totals

The daemon writes a pidfile to ~/.local/state/cmx/gateway.pid. On Windows, stopping uses taskkill; on Linux/macOS a clean SIGTERM.

Inspection

Section titled “Inspection”
Terminal window
cmx stats     # totals + per-provider breakdown, plain text

Setup & info

Section titled “Setup & info”
Terminal window
cmx setup     # print harness wiring instructions
cmx version   # version + platform

Foreground

Section titled “Foreground”
Terminal window
cmx serve     # run the gateway in the foreground (logs to stdout)

Useful under systemd / Task Scheduler / docker run. Env vars honored: CMX_DATA_DIR, CMX_STATE_DIR, CMX_CONFIG_DIR (override the XDG / platform defaults).

Exit codes

Section titled “Exit codes”
  • 0 — success
  • 1 — daemon not running (for stop), or operation failed
  • Health checks time out after 5 s during start