HelixDB Docs

Reference

Show the project and the state of its instances: container state for local instances and database state for Helix Cloud links. Local and Cloud.

Usage

helix status [INSTANCE]

Argument	Description
`INSTANCE`	Instance to show. If omitted, every instance is shown. The command never prompts.

Flag	Description	Default
`--json`	Print the report as JSON on stdout.	Off

Prints a Project / Root header, then a table with INSTANCE, KIND, STATUS, and ENDPOINT columns.
Local status comes from the configured Docker/Podman runtime: URL, container state (not created if there is no container), and storage mode.
Cloud status uses the WorkOS session and fetches the linked tenant or dedicated cluster; cluster status also includes current topology.
A Cloud database that cannot be reached shows as unreachable (or unknown when you are not logged in) with a warning on stderr. The command still reports every other instance.
--json prints an object with project, root, and an instances array. Local entries have kind: "local", name, state, url, and storage. Cloud entries have kind: "cloud", name, state, database, and, when present, label and error.

# Show every instance in the project
helix status

# Show one instance
helix status dev

# Machine-readable status
helix status --json