HelixDB Docs

Reference

For the complete documentation index optimized for AI agents, see llms.txt.

Manage the active Helix Cloud workspace selection stored in ~/.helix/config.

Usage

helix workspace <SUBCOMMAND>

If you run helix workspace with no subcommand in a TTY, the CLI prompts you to choose a workspace.

Available sub-commands

Sub-command	Description
`list`	List workspaces you can access.
`show`	Show the currently selected workspace.
`switch <WORKSPACE>`	Select a workspace by slug or ID.

`helix workspace list`

Flag	Type	Description	Default
`--format`	`human` \| `json`	Output format.	`human`

`helix workspace show`

Flag	Type	Description	Default
`--format`	`human` \| `json`	Output format.	`human`

`helix workspace switch`

Argument	Description
`WORKSPACE`	Workspace slug or ID.

Flag	Type	Description
`--id`	Boolean	Treat `WORKSPACE` as an ID rather than a slug.

Examples

# List accessible workspaces
helix workspace list

# Show the active workspace
helix workspace show

# Switch by slug
helix workspace switch my-team

# Switch by ID
helix workspace switch ws_01HX... --id

helix workspace requires Helix Cloud authentication. Run helix auth login first.

helix project — link the local project to a workspace project
helix cluster — list Helix Cloud clusters
helix auth — authenticate with Helix Cloud

Using the helix CLI

CLI Command Reference

helix workspace

Usage

Available sub-commands

`helix workspace list`

`helix workspace show`

`helix workspace switch`

Examples

​Usage

​Available sub-commands

​helix workspace list

​helix workspace show

​helix workspace switch

​Examples

​Related

Usage

Available sub-commands

`helix workspace list`

`helix workspace show`

`helix workspace switch`

Examples

Related