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.
Manage V2 Cloud authentication. Credentials are stored in ~/.helix/credentials.

​
Usage

helix auth <SUBCOMMAND>

​
Available sub-commands

Sub-commandDescription
loginAuthenticate with Helix Cloud via a browser-based GitHub device flow.
logoutRemove ~/.helix/credentials.
create-key <CLUSTER>Rotate the API key for a specific V2 Cloud cluster. The new key prints once.

​
helix auth create-key

ArgumentDescription
CLUSTERCluster ID to rotate. Find one with helix cluster list.
helix auth create-key requires you to already be logged in. The new key replaces any previous keys for that cluster — update HELIX_API_KEY (or whatever query_auth_env resolves to for the instance) before running helix query again.

​
Examples

# Login (opens a browser device flow)
helix auth login

# Logout (clears ~/.helix/credentials)
helix auth logout

# Rotate a cluster API key
helix auth create-key ec_01HX...