helix add

​

Usage

helix add local --name <name> [--port 6969] [--disk | --storage-uri s3://bucket/prefix]
helix add cloud --name <name> [--database <database>] \
  [--project <project>] [--workspace <workspace>]

​

Subcommands

​

Options

​

helix add local

​

helix add cloud

​

Behavior

• Fails if an instance with the same name already exists in helix.toml.
• Without a subcommand, the CLI prompts for the instance type in a terminal and fails in non-interactive shells.
• --s3-region, --s3-endpoint-url, and --s3-allow-http require --storage-uri.
• add cloud uses the WorkOS session and resolves the database as described in Cloud resource resolution.
• add cloud writes only stable IDs to helix.toml, and sets [project] id and workspace_id when they are missing.
• Without --database, add cloud only offers databases that are not in helix.toml yet, and says so when every database is already added. Pass --database to add one again under another name.
• add cloud refuses a database from a different project than the one helix.toml is linked to. Relink with helix project link first.
• A cluster:<id> target must be a dedicated cluster; shared clusters are not database targets.

​

Examples

# Add a second local instance on another port
helix add local --name staging --port 7070

# Add a local instance with persistent on-disk storage
helix add local --name qa --disk

# Link a Cloud database from the linked project, picking one if there are several
helix add cloud --name production

# Link a specific Cloud database
helix add cloud --name analytics --database tenant:<id>

​

Related

• helix init — create a new project.
• helix delete — remove an instance from helix.toml.
• CLI configuration — the helix.toml format.