Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Skip to main content
CLI Command Reference
helix stop
Stop a background local instance and remove its containers
Reference
Stop a background local instance and remove its containers. Local only.
Usage
helix stop [INSTANCE]
Arguments
| Argument | Description |
|---|---|
INSTANCE | Local instance to stop. Defaults to dev, then the only local instance, then a picker in a terminal; otherwise the command fails and lists the local instances. |
Options
| Flag | Description | Default |
|---|---|---|
--json | Print instance, wasRunning, and explorerStopped as JSON on stdout, plus explorerError when the Explorer could not be removed, and never prompt. | Off |
Behavior
helix stopis idempotent — if the instance is not running, the CLI exits successfully without error.- Default in-memory data is wiped when the container is removed.
- For disk-mode instances,
helix stopremoves the Helix and SeaweedFS containers, and any MinIO sidecar left by an older CLI, but keeps the persistent local volumes. Usehelix pruneto delete disk-mode data. - The disk-cache volume of a disk-mode or S3 instance is kept too, so the next start reads recently used data locally.
- Remote S3 data is never touched.
- The instance’s Explorer container, when one is running, is stopped too. Failing to remove it never fails the stop: the CLI prints a warning with the cause and suggests
helix explorer <instance> --stopto retry.
Examples
# Stop the default 'dev' instance
helix stop dev
# Stop 'dev' or the only local instance, or pick one
helix stop
# Safe to call in scripts even if the instance is already stopped
helix stop staging
Related
helix start— start a local instance.helix restart— restart a local instance.helix prune— remove all Helix-owned local state for an instance.
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.
