Skip to main content
Use these commands during day-to-day runtime operations.

​
Start

hirocli start --workspace <name>
Starts the workspace server in background mode by default.

​
Options

OptionDescription
--workspace, -WTarget workspace name.
--foreground, -fRun in foreground with live logs. Use Ctrl+C to stop.
--adminAlso start the admin UI on its dedicated port (localhost only).

​
Examples

# Start in background
hirocli start --workspace home

# Start in foreground for troubleshooting
hirocli start --workspace home --foreground

# Start with the admin UI
hirocli start --workspace home --admin

# Start in foreground with the admin UI
hirocli start --workspace home --foreground --admin

​
Stop

hirocli stop --workspace <name>
Stops the workspace server gracefully. The server receives a shutdown signal via its HTTP endpoint, waits for channel plugins to disconnect cleanly, then exits. Falls back to a force kill if the server is unreachable.

​
Options

OptionDescription
--workspace, -WTarget workspace name.

​
Restart

hirocli restart --workspace <name>
Gracefully stops the running server and starts a new one. Accepts the same options as start, so you can change the admin UI or foreground flag on restart.

​
Options

OptionDescription
--workspace, -WTarget workspace name.
--foreground, -fRun the restarted server in foreground with live logs.
--adminAlso start the admin UI on its dedicated port (localhost only).

​
Examples

# Restart in background
hirocli restart --workspace home

# Restart and bring up the admin UI
hirocli restart --workspace home --admin
The restart tool is also available via the HTTP API (POST /invoke with "tool": "restart"), which is how the admin UI triggers it. When called from inside the running server process the shutdown is self-initiated — the server sets a restart flag, shuts down gracefully, then spawns a fresh detached process before exiting. See Server lifecycle architecture for details.

​
Status

hirocli status [--workspace <name>]
Shows runtime state for a workspace:
  • server running state and PID
  • gateway connection state
  • last connected timestamp
  • gateway URL
  • device ID
  • HTTP status URL
If you do not pass --workspace, status uses default behavior:
  • if only one workspace exists, it shows that workspace
  • if multiple workspaces exist, it prints a summary for all

​
Options

OptionDescription
--workspace, -WOptional workspace name.

​
Examples

# Show status for default/all behavior
hirocli status

# Show one specific workspace
hirocli status --workspace home