Skip to main content
Launch the Helix Dashboard in a container to visualize and interact with your database. Docker or Podman must be installed and running. build_mode must be set to dev in your helix.toml configuration.

​
Usage

helix dashboard <SUBCOMMAND>

​
Available sub-commands

Sub-commandDescription
startStart the dashboard
stopStop the running dashboard
statusShow dashboard status and connection info

​
helix dashboard start

helix dashboard start [INSTANCE] [OPTIONS]
FlagTypeDescriptionDefault
--port, -pNumberPort to run dashboard on3000
--hostStringHelix host to connect to (e.g. localhost). Bypasses project config
--helix-portNumberHelix port to connect to. Used with --host6969
--attachBooleanRun dashboard in foreground with logs
--restartBooleanRestart if dashboard is already running

​
Examples

# Start dashboard for default instance
helix dashboard start

# Start dashboard on a specific port
helix dashboard start --port 8080

# Start dashboard for a specific instance
helix dashboard start my-instance

# Connect to a specific host directly
helix dashboard start --host localhost --helix-port 6969

# Check dashboard status
helix dashboard status

# Stop the dashboard
helix dashboard stop