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 provides a comprehensive reference for all commands available in Helix CLI v2.

​
Global Options

These options are available for all commands: 
helix --help, -h      Show help information for the command
helix --version, -V   Display the CLI version
helix --quiet         Suppress output (errors and final result only)
helix -v, --verbose   Show detailed output with timing information

​
Commands

CommandSubcommandsFlagsProductDescription
helix addcloud, ecr, fly, local-nLite, EnterpriseAdd a new instance to an existing project
helix authlogin, logout, createkeyLite, EnterpriseManage authentication for Helix Cloud
helix backup-oLiteCreate a backup of a local instance’s database
helix build-i, --binLite, EnterpriseBuild and prepare an instance for deployment
helix checkLite, EnterpriseValidate project configuration and query syntax
helix compile-p, -oLite, EnterpriseCompile project queries
helix dashboardstart, stop, status-p, --host, --helix-port, --attach, --restartLite, EnterpriseLaunch the Helix Dashboard
helix deleteLitePermanently delete an instance and all its data
helix feedbackLite, EnterpriseSend feedback to the Helix team
helix initcloud, ecr, fly, local-p, -t, -q, -nLite, EnterpriseInitialize a new Helix project
helix logs-l, -r, --start, --endLiteView logs for a running instance
helix metricsfull, basic, off, statusLite, EnterpriseConfigure telemetry and metrics collection
helix migrate-p, -q, -i, --port, --dry-run, --no-backupLiteMigrate a v1 project to v2 format
helix prune-aLite, EnterpriseRemove unused containers, images, and workspace files
helix push--devLite, EnterpriseDeploy or update a running instance
helix restartLite, EnterpriseRestart a running instance
helix startLite, EnterpriseStart a stopped instance
helix statusLite, EnterpriseShow the status of all instances
helix stopLite, EnterpriseStop a running instance
helix sync-yLite, EnterpriseSync files from a deployed Helix Cloud instance
helix update--forceLite, EnterpriseUpdate the CLI to the latest version

​
Next Steps

Local Development

Learn how to develop locally

Helix Cloud

Learn how to deploy to Helix Cloud

Fly.io

Learn how to deploy to Fly.io

AWS ECR

Learn how to deploy to AWS ECR