Skip to main content
For the complete documentation index optimized for AI agents, see llms.txt.
Refresh Helix Cloud instance metadata in helix.toml. helix sync fetches the latest gateway URL, auth contract, and node-type info from Helix Cloud and writes it back to the local [enterprise.<instance>] block, so helix query, helix logs, and other Cloud commands can target the instance. Requires Helix Cloud authentication. Run helix auth login first.

​
Usage

helix sync [INSTANCE] [OPTIONS]

​
Arguments

ArgumentDescription
INSTANCEHelix Cloud instance name to sync. If omitted, every [enterprise.*] instance in helix.toml is synced.

​
Available flags

FlagTypeDescriptionDefault
--dry-runBooleanFetch the remote state and print the changes helix sync would make, without writing anything. Mutually exclusive with --yes.false
-y, --yesBooleanSkip interactive conflict prompts and apply the reconciliation non-interactively (useful in CI).false

​
What gets updated

For each matched Helix Cloud instance, helix sync overwrites these fields in helix.toml from the cloud-side configuration:
  • gateway_url
  • query_auth_header (defaults to Authorization)
  • query_auth_env (defaults to HELIX_API_KEY)
  • availability_mode
  • gateway_node_type
  • db_node_type
If the cloud response does not include a gateway_url, the CLI prints: 
Enterprise instance '<name>' is synced, but gateway_url is still missing.
Set it in helix.toml before using 'helix query <name>'.

​
Examples

# Sync a single Helix Cloud instance
helix sync production

# Sync every Helix Cloud instance defined in helix.toml
helix sync

# Preview what would change without writing to helix.toml
helix sync production --dry-run

# Apply without interactive conflict prompts (CI)
helix sync production --yes