HelixDB Docs

Reference

Discover the Helix Cloud clusters you can access and inspect the active indexes of a dedicated cluster. Cloud only; these commands are read-only.

Usage

helix cluster [list] [--workspace <workspace>] [--project <project>]
helix cluster get [CLUSTER] [--workspace <workspace>] [--project <project>]
helix cluster indexes [CLUSTER] [--workspace <workspace>] [--project <project>]

Subcommands

Subcommand	Description
`list`	List clusters in a project or workspace. The default when no subcommand is given.
`get`	Show one cluster.
`indexes`	List the active indexes in a cluster. Alias: `indices`.

Arguments

Argument	Description
`CLUSTER`	`get`, `indexes`: cluster ID (or `cluster:<id>`), slug, or name. Defaults to the one linked `cluster:<id>` database, then the project’s only cluster.

Options

Flag	Description	Default
`--workspace <WORKSPACE>`	Workspace ID, slug, or name. `list` lists the whole workspace when it is given without `--project`.	Linked workspace, then the only workspace
`--project <PROJECT>`	Project ID, slug, or name to list or search in.	Project linked in `helix.toml`
`--json`	Print the result as JSON on stdout and never prompt.	Off

Behavior

Arguments and defaults resolve as described in Cloud resource resolution.
list shows the clusters of --project or the linked project. Without either, it lists the workspace’s clusters.
list prints NAME, ACCESS (shared or dedicated), STATUS, and ID.
Dedicated-cluster create/delete, networking, regions/SKUs, branches, and backups are outside the CLI.

Examples

# List clusters for the linked project
helix cluster

# List every cluster in a workspace
helix cluster list --workspace <workspace>

# Show one cluster by name as JSON
helix cluster get <cluster> --json

# List the active indexes of the linked dedicated cluster
helix cluster indexes

helix database — manage databases and application keys.
helix project — find and link the owning project.
Helix Cloud workflow — end-to-end Cloud usage.

Using the helix CLI

CLI Command Reference

helix cluster

Usage

Subcommands

Arguments

Options

Behavior

Examples

​Usage

​Subcommands

​Arguments

​Options

​Behavior

​Examples

​Related

Usage

Subcommands

Arguments

Options

Behavior

Examples

Related