For the complete documentation index optimized for AI agents, see llms.txt.
List Helix Cloud clusters available to the active workspace or a specific project.
Usage
helix cluster <SUBCOMMAND>
Available sub-commands
| Sub-command | Description |
|---|
list | List Helix Cloud clusters. |
indexes (alias indices) | List the indexes in a cluster. |
helix cluster list
| Flag | Type | Description | Default |
|---|
--workspace-id | String | List clusters for a specific workspace. | Active workspace from ~/.helix/config |
--project-id | String | Limit results to a specific project. | Linked project from helix.toml, if any |
--format | human | json | Output format. | human |
helix cluster indexes
List the indexes defined in a cluster. Alias: helix cluster indices.
| Flag | Type | Description | Default |
|---|
--cluster-id | String | Cluster to inspect. | The current project’s Enterprise instance, from helix.toml |
--format | human | json | Output 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
# List indexes for the current project's Enterprise cluster
helix cluster indexes
# List indexes for a specific cluster as JSON
helix cluster indexes --cluster-id ec_01HX... --format json
helix init cloud, helix add cloud, or helix auth create-key.
helix cluster requires Helix Cloud authentication. Run helix auth login first.
