Skip to main content
The Helix CLI noq uses a unified configuration system centered around the helix.toml file. This guide covers all configuration options and best practices.

Configuration File Structure

The helix.toml file is the central configuration for your Helix project, defining project metadata, instance configurations, and deployment settings.

Basic Structure

Project Configuration

The [project] section defines global project settings:

Local Instance Configuration

Local instances use Docker for containerized development environments.

Basic Local Configuration

Advanced Local Settings

Multiple Local Instances

You can define multiple local instances for different purposes:

Cloud Instance Configuration

Helix Cloud

AWS ECR Configuration

Fly.io Configuration

Build Modes

Build modes control optimization and debugging capabilities:

Mode Characteristics

Troubleshooting Configuration

Common Issues

  1. Port conflicts: Ensure unique ports for each local instance
  2. Missing credentials: Run helix auth login for cloud features
  3. Invalid paths: Use relative paths from project root
  4. Memory limits: Adjust db_max_size_gb based on available RAM

Next Steps

Common Workflows

Learn typical development patterns

Troubleshooting

Solve common configuration issues