Skip to main content
Reference
Delete an instance from helix.toml and clean up any local runtime state for it. Works for local instances and Helix Cloud links; a Cloud database itself is never deleted.

Usage

Arguments

Options

Behavior

  • For local instances, Helix-owned containers, networks, disk-mode and disk-cache volumes, and the per-instance directory under .helix/ are deleted. Cleanup errors are ignored: with Docker or Podman stopped, the instance leaves helix.toml but its volumes stay. Start the runtime and run helix prune <instance>, which works for removed instances.
  • For Helix Cloud instances, only the [enterprise.<name>] block in helix.toml is removed — the database itself is untouched.
  • Remote S3 object-store data is not deleted.
  • The CLI refuses to delete the last instance in helix.toml (Cannot delete the final instance '<instance>'); add a replacement first.
  • Rewrites helix.toml, removing its comments; see Commands that rewrite helix.toml.
  • In a TTY, helix delete prints a warning and asks for confirmation. Without a TTY, or with --json, it refuses to run without --yes:

Examples