Use these commands when you are preparing a workspace for first use or removing it later.
Setup
hirocli setup --workspace <name>
setup initializes the workspace configuration, ensures required keys and channels exist, optionally registers auto-start, and then starts the server.
Options
| Option | Description |
|---|
--workspace, -W | Target workspace name. If no workspace exists yet, default is auto-created. |
--gateway-url, -g | Gateway WebSocket URL, for example ws://localhost:18082. |
--port, -p | HTTP API port for this workspace server. |
--skip-autostart | Skip auto-start registration during setup. |
--elevated-task | On Windows, request elevated Task Scheduler registration. |
Examples
# Basic setup
hirocli setup --workspace home
# Setup with explicit gateway and HTTP port
hirocli setup --workspace home --gateway-url ws://localhost:18082 --port 18080
# Setup without auto-start
hirocli setup --workspace home --skip-autostart
setup is safe to rerun when you need to change gateway URL or HTTP port for a workspace.
Teardown
hirocli teardown --workspace <name>
teardown stops the workspace server and removes auto-start registration.
Options
| Option | Description |
|---|
--workspace, -W | Target workspace name. |
--purge | Also delete the workspace folder and remove it from the workspace registry. |
--elevated-task | On Windows, request elevated auto-start task removal. |
Examples
# Stop and unregister auto-start
hirocli teardown --workspace home
# Also delete workspace files
hirocli teardown --workspace home --purge
--purge permanently removes workspace files, including keys, config, logs, channels, and paired-device data.
Uninstall
hirocli uninstall --workspace <name>
uninstall runs teardown first, then prints package-manager commands to remove hirocli itself.
Options
| Option | Description |
|---|
--workspace, -W | Target workspace name. |
--purge | Also delete the workspace folder. |
--elevated-task | On Windows, request elevated auto-start task removal. |
Examples
# Uninstall flow for one workspace
hirocli uninstall --workspace home
# Uninstall flow and delete workspace data
hirocli uninstall --workspace home --purge
