Skip to main content
For the complete documentation index optimized for AI agents, see llms.txt.
Add a new instance to an existing Helix project. The new block is appended to helix.toml.

​
Usage

helix add [SUBCOMMAND]
If you omit the subcommand in a TTY, the CLI prompts you to choose between local and enterprise.

​
Available sub-commands

Sub-commandDescription
localAdd a local v2 development instance.
enterpriseAdd a Helix Cloud instance linked to a cluster.

​
helix add local

FlagTypeRequiredDescriptionDefault
-n, --nameStringYesLocal instance name (must be unique in helix.toml).—
--portNumberNoHost port for the local gateway.6969
--diskBooleanNoPersist local data with on-disk storage backed by a CLI-managed MinIO volume.false
Interactive local add prompts for the storage mode and defaults to in-memory.

​
helix add cloud

FlagTypeRequiredDescriptionDefault
-n, --nameStringYesHelix Cloud instance name.—
--cluster-idStringYesHelix Cloud cluster ID. Find one with helix cluster list.—
--gateway-urlURLNoRuntime gateway URL for dynamic queries. If omitted, run helix sync afterward to fetch it.—
helix add cloud requires Helix Cloud authentication. Run helix auth login first.

​
Examples

# Add a second local instance on a different port
helix add local --name staging --port 9090

# Add a local instance that uses persistent on-disk storage by default
helix add local --name disk-dev --disk

# Add a Helix Cloud instance with a known cluster ID
helix add cloud --name production --cluster-id ec_01HX...

# Add a Helix Cloud instance and let helix sync fill in gateway/auth metadata
helix add cloud --name prod --cluster-id ec_01HX...
helix sync prod