Skip to main content
Sync .hx source files and helix.toml configuration from a deployed Helix Cloud instance back to your local project. This command:
  1. Authenticates with Helix Cloud
  2. Resolves your workspace and cluster (interactive prompts if needed)
  3. Downloads .hx query files and helix.toml from the remote instance
  4. Prompts before overwriting any local files that differ
  5. Merges the remote helix.toml — updates [project] and the specific [cloud.<instance>] block while preserving [local.*] and other cloud entries
Only supported for Helix Cloud instances (standard and enterprise). Requires authentication via helix auth login.

​
Usage

helix sync [INSTANCE] [OPTIONS]

​
Arguments

ArgumentDescription
INSTANCEInstance name to sync from. If omitted, an interactive selection prompt will appear

​
Available flags

FlagTypeDescription
--yes, -yBooleanOverwrite local files without confirmation prompts

​
Examples

# Sync from a specific cloud instance
helix sync my-instance

# Interactive instance selection
helix sync

# Skip confirmation prompts
helix sync my-instance --yes