Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helix-db.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Usage

helix sync [INSTANCE]

​
Arguments

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

​
What gets updated

For each matched V2 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 V2 Cloud instance
helix sync production

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