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. -
For Helix Cloud instances, only the
[enterprise.<name>]block inhelix.tomlis 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; add a replacement first. -
In a TTY,
helix deleteprints a warning and asks for confirmation. Without a TTY, or with--json, it refuses to run without--yes:
Examples
Related
helix prune— clean up local state but keep the instance inhelix.toml.helix add— add a replacement instance.- CLI configuration — the
helix.tomlformat.