Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helix-db.com/llms.txt

Use this file to discover all available pages before exploring further.

For the complete documentation index optimized for AI agents, see llms.txt.
Launch the Helix Dashboard in a container to visualize and interact with a local or V2 Cloud instance. Docker or Podman must be installed and running.

​
Usage

helix dashboard <SUBCOMMAND>

​
Available sub-commands

Sub-commandDescription
startStart the dashboard container.
stopStop and remove the dashboard container.
statusShow whether the dashboard container is running.

​
helix dashboard start

helix dashboard start [INSTANCE] [OPTIONS]
ArgumentDescription
INSTANCEInstance to connect to. Defaults to dev. Ignored when --host is set.
FlagTypeDescriptionDefault
-p, --portNumberHost port to publish the dashboard on.3000
--hostStringHelix host to connect to. Bypasses helix.toml instance lookup.localhost (resolved from [local.<instance>] port)
--helix-portNumberHelix port the dashboard talks to. Only used with --host.8080
--attachBooleanRun the dashboard in the foreground with logs.false
--restartBooleanRemove and recreate the dashboard container if one already exists.false
Background runs print Dashboard started at http://localhost:<port> when the container is up.

​
helix dashboard stop

helix dashboard stop
  • Prints Dashboard stopped when an existing container is removed.
  • Prints Dashboard was not running if no dashboard container exists.

​
helix dashboard status

helix dashboard status
  • Prints Dashboard not running when no container is found.
  • Otherwise prints the container name, status, and port mapping.
Image pulls are quiet by default. Pass the global --verbose flag to stream pull progress: helix --verbose dashboard start.

​
Examples

# Start the dashboard against the default 'dev' instance on port 3000
helix dashboard start

# Use a non-default port and a named instance
helix dashboard start staging --port 4000

# Point at an arbitrary host (e.g. a tunneled remote)
helix dashboard start --host tunnel.example.com --helix-port 8080

# Recreate the dashboard container if one is already running
helix dashboard start --restart

# Stop and check status
helix dashboard stop
helix dashboard status