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.
Add a new instance to an existing Helix project. The new block is appended to helix.toml.
Usage
If you omit the subcommand in a TTY, the CLI prompts you to choose between local and enterprise.
Available sub-commands
| Sub-command | Description |
|---|
local | Add a local v2 development instance. |
enterprise | Add an V2 Cloud instance linked to a cluster. |
helix add local
| Flag | Type | Required | Description | Default |
|---|
-n, --name | String | Yes | Local instance name (must be unique in helix.toml). | — |
--port | Number | No | Host port for the local gateway. | 8080 |
--disk | Boolean | No | Persist local data with on-disk storage backed by a CLI-managed MinIO volume. | false |
helix add enterprise
| Flag | Type | Required | Description | Default |
|---|
-n, --name | String | Yes | V2 Cloud instance name. | — |
--cluster-id | String | Yes | V2 Cloud cluster ID. Find one with helix cluster list. | — |
--gateway-url | URL | No | Runtime gateway URL for dynamic queries. If omitted, run helix sync afterward to fetch it. | — |
helix add enterprise requires V2 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 an V2 Cloud instance with a known cluster ID
helix add enterprise --name production --cluster-id ec_01HX...
# Add an V2 Cloud instance and let helix sync fill in gateway/auth metadata
helix add enterprise --name prod --cluster-id ec_01HX...
helix sync prod
