HelixDB Docs

Reference

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

This page lists every command in Helix CLI v3. Click any command for full flag and example details.

Global Options

These options are available for every command:

helix --help, -h        Show help for the command
helix --version, -V     Print the CLI version
helix --quiet           Suppress output (errors and final result only)
helix -v, --verbose     Show detailed output with timing information

Commands

Command	Subcommands	Flags	Scope	Description
`helix init`	`local`, `enterprise`	`-p`/`--path`	Local, Helix Cloud	Initialize a Helix project
`helix chef`			Local	Bootstrap a first Helix app with skills, docs MCP, starter queries, seed data, and a launched coding agent
`helix add`	`local`, `enterprise`		Local, Helix Cloud	Add an instance to an existing project
`helix start`		`--foreground`, `--port`, `--disk`, `--persist`	Local	Start a local instance (background by default)
`helix stop`			Local	Stop a background local instance
`helix restart`			Local	Restart a background local instance
`helix status`			Local, Helix Cloud	Show instance status
`helix logs`		`-f`/`--follow`, `-r`/`--range`, `--start`, `--end`	Local, Helix Cloud	View instance logs
`helix query`		`-f`/`--file`, `--json`, `-e`/`--ts`, `--ts-file`, `--warm`, `--host`, `--port`, `--compact`	Local, Helix Cloud	Send a dynamic query (JSON or TypeScript DSL) to `POST /v2/query`
`helix auth`	`login`, `logout`, `create-key`		Helix Cloud	Manage Helix Cloud authentication
`helix workspace`	`list`, `show`, `switch`	`--format`, `--id`	Helix Cloud	Manage active workspace selection
`helix project`	`list`, `show`, `switch`	`--format`, `--id`, `--workspace-id`	Helix Cloud	Manage linked project selection
`helix cluster`	`list`, `indexes`	`--format`, `--workspace-id`, `--project-id`, `--cluster-id`	Helix Cloud	List Helix Cloud clusters and their indexes
`helix push`			Helix Cloud	Deploy a Helix Cloud instance to Helix Cloud
`helix sync`		`--dry-run`, `-y`/`--yes`	Helix Cloud	Refresh Helix Cloud instance metadata in `helix.toml`
`helix prune`		`-a`/`--all`, `-y`/`--yes`	Local	Remove Helix-owned local containers, volumes, and workspaces
`helix delete`		`-y`/`--yes`	Local, Helix Cloud	Delete an instance from `helix.toml` and local state
`helix skills`	`install`, `update`, `list`	`--project`	—	Install, update, and list the Helix agent skills
`helix metrics`	`full`, `basic`, `off`, `status`		Local, Helix Cloud	Configure CLI telemetry
`helix update`		`--force`, `--v1`	—	Update the CLI (and refresh installed skills) to the latest version
`helix feedback`			—	Send feedback to the Helix team

helix config is retained as a hidden compatibility alias. Use helix workspace, helix project, and helix cluster directly — they’re the canonical commands.

Next Steps

Local Development

The local init/run/query loop

Helix Cloud

Authenticate, link a project, and query a Helix Cloud cluster

⌘I