Skip to main content
Initialize a new Helix project with a helix.toml configuration file.

​
Usage

helix init [OPTIONS] [SUBCOMMAND]

​
Available sub-commands

Sub-commandDescription
cloudInitialize a Helix Cloud instance
ecrInitialize an AWS ECR instance
flyInitialize a Fly.io instance
localInitialize a local instance

​
Available flags

FlagTypeDescriptionDefault
-p, --pathStringThe path to the projectCurrent directory
-t, --templateStringThe template to use for the projectempty
-q, --queries-pathStringThe path to the query files./db/

​
helix init cloud

FlagTypeDescriptionDefault
--regionStringThe region the instance is deployed tous-east-1
-n, --nameStringThe name of the instance

​
helix init ecr

FlagTypeDescription
-n, --nameStringThe name of the AWS ECR repository. Creates the repository if needed

​
helix init fly

FlagTypeDescriptionDefault
-n, --nameStringThe name of the Fly.io app
--authStringAuthentication typecli
--volume-sizeNumberThe volume size in GB20
--vm-sizeStringThe VM size (see options below)shared-cpu-4x
--privateBooleanMake instance privatefalse
Available --vm-size options:
  • 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

​
helix init local

FlagTypeDescription
-n, --nameStringThe name of the local instance

​
Examples

# Initialize a new local project (defaults to instance named 'dev')
helix init

# Initialize with a specific path
helix init --path ./my-project

# Initialize a Helix Cloud instance
helix init cloud --name my-instance --region us-east-1

# Initialize a Fly.io instance
helix init fly --name my-app --vm-size shared-cpu-2x

# Initialize an AWS ECR instance
helix init ecr --name my-repo

# Initialize a local instance with a custom name
helix init local --name staging