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.
This page lists every command in Helix CLI v2. 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

CommandSubcommandsFlagsScopeDescription
helix initlocal, enterprise-p/--pathLocal, V2 CloudInitialize a v2 Helix project
helix chef-a/--autoLocalBootstrap a first Helix app with skills, docs MCP, starter queries, seed data, and dashboard launch
helix addlocal, enterpriseLocal, V2 CloudAdd an instance to an existing project
helix run--foreground, --port, --diskLocalRun a local instance (background by default)
helix stopLocalStop a background local instance
helix restartLocalRestart a background local instance
helix statusLocal, V2 CloudShow instance status
helix logs-f/--follow, -r/--range, --start, --endLocal, V2 CloudView instance logs
helix query-f/--file, --json, --warm, --host, --port, --compactLocal, V2 CloudSend a dynamic query to POST /v1/query
helix authlogin, logout, create-keyV2 CloudManage V2 Cloud authentication
helix workspacelist, show, switch--format, --idV2 CloudManage active workspace selection
helix projectlist, show, switch--format, --id, --workspace-idV2 CloudManage linked project selection
helix clusterlist--format, --workspace-id, --project-idV2 CloudList V2 Cloud clusters
helix syncV2 CloudRefresh V2 Cloud instance metadata in helix.toml
helix prune-a/--all, -y/--yesLocalRemove Helix-owned local containers, volumes, and workspaces
helix delete-y/--yesLocal, V2 CloudDelete an instance from helix.toml and local state
helix metricsfull, basic, off, statusLocal, V2 CloudConfigure CLI telemetry
helix dashboardstart, stop, status-p/--port, --host, --helix-port, --attach, --restartLocal, V2 CloudLaunch the Helix Dashboard
helix update--force, --v1—Update the CLI 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

V2 Cloud

Authenticate, link a project, and query an V2 Cloud cluster