HelixDB Docs

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

Project Management

`helix init`

Initialize a new Helix project with configuration and structure.

Show options

String

The path to the project.

String

The template to use for the project.

String

The path to the query files.

Show subcommands

[Options]

Show options

String

The region the instance is deployed to.

String

The name of the instance.

[Options]

Show options

String

The name of the AWS ECR repository. Note this will create the repository if needed.

[Options]

Show options

String

The name of the Fly.io app.

The volume size in GB.

String

shared-cpu-1x - 1 shared vCPU, 256MB RAM
shared-cpu-2x - 2 shared vCPUs, 512MB RAM
shared-cpu-4x - 4 shared vCPUs, 1GB RAM
performance-4x - 4 dedicated vCPUs, 8GB RAM
performance-8x - 8 dedicated vCPUs, 16GB RAM

Make instance public.

[Options]

Show options

String

The name of the local instance.

Note that helix init with no arguments defaults to making a local instance called dev.

`helix add`

Add a new instance to an existing Helix project.

Show subcommands

[Options]

Show options

String

The region the instance is deployed to.

String

The name of the instance.

[Options]

Show options

String

The name of the AWS ECR repository. Note this will create the repository if needed.

[Options]

Show options

String

The name of the Fly.io app.

The volume size in GB.

String

shared-cpu-1x - 1 shared vCPU, 256MB RAM
shared-cpu-2x - 2 shared vCPUs, 512MB RAM
shared-cpu-4x - 4 shared vCPUs, 1GB RAM
performance-4x - 4 dedicated vCPUs, 8GB RAM
performance-8x - 8 dedicated vCPUs, 16GB RAM

Make instance public.

[Options]

Show options

String

The name of the local instance.

`helix migrate`

Migrate a v1 Helix project to v2 format.

Show options

String

The path to the project to migrate.

Default: current directory

String

The directory to move .hx files to.

Default: ”./db/”

String

The name for the default local instance.

Default: “dev”

String

The port for the local instance.

Default: 6969

Show what would be migrated without making changes.

Skip creating backup of v1 files.

Validation & Compilation

`helix check`

Validate project configuration and query syntax.

Name of the instance to check (defaults to all instances)

`helix compile`

Compile project queries into executable format.

Show options

String

The path to the project.

String

The output path for compiled queries.

`helix build`

Build and prepare an instance for deployment.

What it does:

Validates configuration and queries
Compiles queries
Generates Docker configuration files
Prepares the instance workspace

The instance to build.

Deployment & Instance Management

`helix push`

Deploy or update a running instance.

What it does:

Builds the instance if needed
Creates/updates Docker container for local instances
Pushes to cloud provider for remote instances
Starts the instance

The instance to deploy.

`helix pull`

🚧 COMING SOON 🚧

`helix start`

Start a stopped instance without rebuilding.

The instance to start.

`helix stop`

Stop a running instance.

The instance to stop.

`helix status`

Show the status of all instances in the project.

Cleanup & Maintenance

`helix prune`

Remove unused containers, images, and workspace files.

What it removes:

Stopped containers
Unused Docker images
Workspace files
Note: Preserves data volumes

The instance to prune.

Show options

Boolean

Prune all instances in the project.

`helix delete`

Permanently delete an instance and all its data.

What it removes:

Container and images
All data volumes
Workspace files
Configuration entries

The instance to delete.

Authentication & Cloud

`helix auth`

Manage authentication for Helix Cloud.

The subcommand to run.

Show subcommands

Initiates browser-based authentication flow.

Clears authentication tokens from ~/.helix/credentials.

Generates a new API key for programmatic access.

Configuration & Settings

`helix metrics`

Configure telemetry and usage metrics collection.

The subcommand to run.

Show subcommands

Enable full metrics collection (requires email).

Enable minimal anonymous metrics.

Disable all metrics collection.

Show current metrics configuration.

`helix update`

Update the Helix CLI to the latest version.

The options to run.

Show options

Boolean

Force update even if already on latest version.

For issues or questions:

GitHub Issues: https://github.com/HelixDB/helix-db/issues
Discord: https://discord.gg/2stgMPr5BD
Email: founders@helix-db.com

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

Getting Started

CLI

SDKs

HelixQL

Command Reference

Global Options

Project Management

`helix init`

`helix add`

`helix migrate`

Validation & Compilation

`helix check`

`helix compile`

`helix build`

Deployment & Instance Management

`helix push`

`helix pull`

`helix start`

`helix stop`

`helix status`

Cleanup & Maintenance

`helix prune`

`helix delete`

Authentication & Cloud

`helix auth`

Configuration & Settings

`helix metrics`

`helix update`

Next Steps

Local Development

Helix Cloud

Fly.io

AWS ECR

​Global Options

​Project Management

​helix init

​helix add

​helix migrate

​Validation & Compilation

​helix check

​helix compile

​helix build

​Deployment & Instance Management

​helix push

​helix pull

​helix start

​helix stop

​helix status

​Cleanup & Maintenance

​helix prune

​helix delete

​Authentication & Cloud

​helix auth

​Configuration & Settings

​helix metrics

​helix update

​Next Steps

Local Development

Helix Cloud

Fly.io

AWS ECR

Global Options

Project Management

`helix init`

`helix add`

`helix migrate`

Validation & Compilation

`helix check`

`helix compile`

`helix build`

Deployment & Instance Management

`helix push`

`helix pull`

`helix start`

`helix stop`

`helix status`

Cleanup & Maintenance

`helix prune`

`helix delete`

Authentication & Cloud

`helix auth`

Configuration & Settings

`helix metrics`

`helix update`

Next Steps