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.
List V2 Cloud clusters available to the active workspace or a specific project.

​
Usage

helix cluster <SUBCOMMAND>

​
Available sub-commands

Sub-commandDescription
listList V2 Cloud clusters.

​
helix cluster list

FlagTypeDescriptionDefault
--workspace-idStringList clusters for a specific workspace.Active workspace from ~/.helix/config
--project-idStringLimit results to a specific project.Linked project from helix.toml, if any
--formathuman | jsonOutput format.human

​
Examples

# List clusters in the active workspace
helix cluster list

# List clusters scoped to a specific project
helix cluster list --project-id prj_01HX...

# List clusters in a non-active workspace
helix cluster list --workspace-id ws_01HX...

# Emit machine-readable JSON
helix cluster list --format json
Use the resulting cluster ID with helix init enterprise, helix add enterprise, or helix auth create-key.
helix cluster requires V2 Cloud authentication. Run helix auth login first.