HelixDB Docs

Reference

List and inspect the Helix Cloud workspaces your login can access. Cloud only; these commands are read-only.

Usage

helix workspace [list]
helix workspace get [WORKSPACE]

Subcommand	Description
`list`	List every workspace you are a member of. The default when no subcommand is given.
`get`	Show one workspace.

Argument	Description
`WORKSPACE`	`get`: workspace ID, slug, or name. Defaults to the linked workspace, then the only workspace.

Flag	Description	Default
`--json`	Print the result as JSON on stdout and never prompt.	Off

The WorkOS session hydrates all current memberships. list marks the workspace linked in helix.toml.
There is no workspace switch command and no persisted active workspace.
Commands that need a workspace take --workspace <id|slug|name>, or resolve one as described in Cloud resource resolution.

# List your workspaces
helix workspace

# Show one workspace as JSON
helix workspace get <workspace> --json