Skip to main content
Use runtime commands for day-to-day gateway operations.

​
Resolution order

Commands that accept --instance resolve the target in this order:
  1. --instance <name>
  2. HIRO_GATEWAY_INSTANCE environment variable
  3. default instance in gateway registry

​
Start

hirogateway start [--instance <name>]
Starts the target instance in background mode by default.

​
Options

OptionDescription
--instance, -ITarget instance name.
--foreground, -fRun in foreground with live logs.
--verbose, -vEnable debug-level logs.
--log-dirRuntime-only log directory override for this start.

​
Examples

# Start default instance
hirogateway start

# Start a specific instance in foreground
hirogateway start --instance home --foreground --verbose

​
Stop

hirogateway stop [--instance <name>]
Stops the target instance process using the instance PID file.

​
Status

hirogateway status [--instance <name>]
Shows runtime state:
  • process running state and PID
  • WebSocket URL (ws://host:port)
  • instance path
If --instance is omitted:
  • one instance configured: print that instance
  • multiple instances configured: print all instances

​
Teardown

hirogateway teardown [--instance <name>] [--purge]
Stops the instance and removes auto-start registration.

​
Options

OptionDescription
--instance, -ITarget instance name.
--purgeAlso remove instance from registry and delete files.
--elevated-taskOn Windows, request elevated task removal.
Set the workspace gateway URL to the running gateway endpoint: 
hirocli setup --workspace home --gateway-url ws://localhost:8765