Dr. Seuss, The Cat in the Hat Comes Back
Reclaim every build artifact on your disk in one parallel pass — and prove each one before deleting it.
voom finds and removes build output anywhere in a tree: target/, dist/, __pycache__/,
.gradle/, .zig-cache/ and the rest. A directory counts as an artifact only when a marker file
proves its ecosystem, so a hand-written bin/ or vendor/ is never taken.
Every major ecosystem · marker-anchored classification · six deletion rails · a dry run that is the real pipeline · hierarchical TOML · a named tool-cache catalog · watch mode · git hooks
Install · Usage · Safety · Caches · Suggest · Ecosystems · Configuration · JSON · Git hooks
Installation
| Channel | Command |
|---|---|
| Homebrew (macOS/Linux) | brew install goldziher/tap/voom |
| Cargo (Rust) | cargo install voom |
| npm (Node.js) | npm install -g @goldziher/voom |
| pip (Python) | pip install voom-cli |
The binary is called voom however you install it. The package names differ because voom was
already taken on npm and PyPI — see ADR 0010.
Prefer prebuilt binaries? cargo binstall voom
downloads a release archive instead of compiling from source.
Run without installing:
Requires Rust 1.88+ (edition 2024).
Quick start
What a run prints:
/projects
removed 4.20 GB rust api/target
refused 0 B rust link/target — is a symlink
removed 18.50 MB node web/dist
2 artifacts, 4.22 GB reclaimed in 1.23s
scan 900.00ms · policy 12.00ms · size 210.00ms · delete 98.00ms
rust 4.20 GB (1), node 18.50 MB (1)
1 artifact refused by a safety rail
Usage
Start narrow: voom --dry-run --verbose ~/projects, and read the skips before widening to ~.
|
Run voom --help for the full, grouped list of options, or see the
options reference below.
Exit codes: 0 clean, 1 some artifacts could not be removed (a partial removal counts), 2
usage or config error, 3 findings with --dry-run --exit-code (for hooks). Git housekeeping
never fails a sweep. catalog, caches, config show and suggest always exit 0.
Options reference
The Group column matches voom --help's own grouping.
| Group | Flag | Short | Default | What it does |
|---|---|---|---|---|
| Behaviour | --dry-run |
-n |
off | Report what would be removed, without touching anything. |
| Behaviour | --report |
Print the per-artifact report. Already the default; accepted so a git hook can name it explicitly. | ||
| Behaviour | --exit-code |
off | Exit 3 when a dry run finds artifacts, for a hook to fail on. |
|
| Behaviour | --no-git |
off | Skip git worktree prune and git gc --auto in every repository walked. Also [git] enabled = false; the flag wins. |
|
| Behaviour | --force |
off | Retry a failed removal, first clearing read-only bits (and, on macOS, the immutable flag) on paths already inside a proven artifact. Never relaxes a rail, follows a symlink, or touches the artifact's parent. A repair that does not go on to succeed is not undone. | |
| Behaviour | --jobs <N> |
-j |
every core | Worker threads for the walk, sizing and removal. Lower on spinning disks or network filesystems. |
| Output | --verbose |
-v |
off | Explain every candidate that was passed over. |
| Output | --summary |
off | Print only the totals footer. | |
| Output | --format <human|json> |
human |
See JSON output. | |
| Output | --color <auto|always|never> |
auto |
auto colorizes when stdout is a terminal, honouring NO_COLOR and CLICOLOR_FORCE. |
|
| Selection | --ecosystem <ID> |
-e |
all | Only sweep this ecosystem. Repeatable. |
| Selection | --enable <SPEC> |
Turn on an off-by-default artifact, e.g. python.venv. Repeatable. |
||
| Selection | --disable <SPEC> |
Turn off an ecosystem or one of its artifacts. Repeatable. | ||
| Selection | --clean-dependencies |
off | Also remove node_modules/, Rust, composer and Go vendor/, mix deps/ and Python virtualenvs. Sugar over --enable-ing each. |
|
| Selection | --exclude <GLOB> |
Never scan this path. Repeatable. Relative to the tree being swept. | ||
| Selection | --include <GLOB> |
Remove this path whether or not a marker proves it. Repeatable. Outranks every prune, cannot reach inside a pruned directory, and --exclude still wins. |
||
| Selection | --clean-caches <IDS> |
Remove these named tool caches. Repeatable, or comma-separated — see voom caches. |
||
| Selection | --caches |
off | Also sweep tool caches and installed toolchains, which are skipped by default. | |
| Selection | --config <PATH> |
discovered hierarchy | Use this configuration file instead of resolving voom.toml from the tree. |
|
| Keep policies | --min-age <DURATION> |
unset | Never remove an artifact modified more recently, e.g. 7d. |
|
| Keep policies | --min-size <SIZE> |
unset | Skip artifacts smaller than this, e.g. 1MB. |
|
| Keep policies | --max-size <SIZE> |
unset | Skip artifacts larger than this, e.g. 50GB. |
|
| Safety | --one-file-system[=BOOL] |
true |
Stay on the scan root's filesystem. --one-file-system=false opts out — the = is required, or clap reads the next argument as a path. |
Subcommands
| Command | What it does |
|---|---|
voom catalog |
Print the built-in ecosystem catalog. Always exits 0. |
voom caches |
Print the tool-cache table, resolved against this machine. Always exits 0. |
voom config show [PATH] |
Print the fully merged, resolved configuration and the files it came from. PATH defaults to .. Always exits 0. |
voom suggest [PATHS] |
Rank repeated directories a .gitignore names that the catalog does not cover. Removes nothing. Takes --one-file-system[=BOOL] and -j/--jobs <N>. Always exits 0. |
voom watch [PATHS] |
Keep a tree pruned continuously. --debounce <DURATION> (default 5s), --quiet-period <DURATION> (default 60s). Sweep flags come from the top-level arguments. |
voom git-prune [PATHS] |
Run git's own housekeeping on its own. -n/--dry-run, --remotes, --timeout <DURATION>, --expire <TIME> (default git's own three-month gc.worktreePruneExpire), --format <human|json>. Exits 1 if a repository's housekeeping failed. |
Safety
voom deletes by default, with no confirmation prompt. Safety comes from these rules:
1. Nothing is removed without a marker file proving its ecosystem. target/ is only Rust's
build output when a Cargo.toml sits beside it; obj/ is only .NET's when a project file —
*.csproj, *.fsproj, *.vbproj or *.sln — sits at most three directories above it. A marker's
position relative to the candidate is one of three anchors: Sibling (beside the artifact, most
ecosystems), Ancestor(n) (up to n directories above, for artifacts nested inside a project),
or Inside (the marker is written inside the candidate itself — ~/.cargo/registry's
CACHEDIR.TAG, .basemind/'s agent-id). --verbose says which marker was missing.
2. Dependency directories are off by default. node_modules/, vendor/ (Rust, PHP composer,
Go), mix's deps/ and Python's .venv/ are network-fetched caches, not build output — removing
one costs a re-download and can break offline work. --clean-dependencies turns the group on and
--enable <spec> turns on exactly one; a marker still has to prove each.
3. Tool caches and installed toolchains are skipped by location, not name — an installed pnpm
sits beside a real package.json and is otherwise indistinguishable from a project someone built.
--caches opts back in; naming one of those paths as a scan root sweeps it regardless.
4. Six rails you cannot switch off. Symlinks and Windows reparse points are refused rather than
followed. Every target is canonicalized. An append-only denylist protects /, $HOME itself,
/usr, /System, .git and friends. The result must resolve strictly below a scan root.
Filesystem boundaries are not crossed (--one-file-system=false to opt out). A failure on one
artifact is reported and isolated rather than aborting the run.
5. --dry-run is the real pipeline with the last step withheld, not a simulation.
Full reasoning in ADR 0002 and ADR 0006.
Cache catalog
The ecosystem catalog covers build output; it has nothing to say about ~/.cargo/registry or
~/.cache/uv, which are machine-global downloads rather than anything a project built. voom caches lists the ones voom knows how to empty by name:
| id | Cache | Location(s) |
|---|---|---|
cargo-registry |
Cargo registry | ~/.cargo/registry |
cargo-git |
Cargo git checkouts | ~/.cargo/git |
uv |
uv | ~/.cache/uv |
gradle-caches |
Gradle caches | ~/.gradle/caches |
go-build |
Go build cache | ~/Library/Caches/go-build, ~/.cache/go-build |
go-mod |
Go module cache | ~/go/pkg/mod |
npm |
npm cache | ~/.npm/_cacache |
pnpm |
pnpm metadata cache | ~/Library/Caches/pnpm, ~/.cache/pnpm |
pub |
Dart pub cache | ~/.pub-cache |
deno |
Deno cache | ~/Library/Caches/deno, ~/.cache/deno, ~/.deno |
poly |
poly cache | ~/.cache/poly, ~/Library/Caches/poly, ~/AppData/Local/poly |
alef-global |
alef global cache | ~/.cache/alef |
The id is what --clean-caches and [caches] enable take — not always the tool's name, since a
cache id and an ecosystem id sharing one word would leave a report unable to say which table a
line came from. Each is proven the way everything else is: not by its path, but by a marker the
tool wrote inside it, most often the cross-tool CACHEDIR.TAG.
None is on by default and none is reachable without naming it:
A cache whose contents are only shard directories — sccache, zig, NuGet, Maven — is deliberately absent: the marker would prove nothing the path had not already said. See ADR 0012.
Finding what the catalog does not cover
The catalog covers ecosystems, not the cache your own tooling writes into every package
directory. include (ADR 0004) is the answer, but you have to know
the directory's name to write the line. voom suggest walks a tree and reports the repeated
directories git already ignores where they sit, ranked by size, with the line that would sweep
each:
$ voom suggest ~/projects
42.70 GB .alef across 69 directories
3.00 GB .basemind across 13 directories
Add to voom.toml what you recognise:
include = [".alef"]
include = [".basemind"]
Read the list before pasting it. A .gitignore also lists local configuration and
scratch data, which is why voom suggests rather than sweeps.
It removes nothing. --include <GLOB> is the command-line equivalent of voom.toml's include
key, for when you already know the name.
Supported ecosystems
| Ecosystem | Marker | Artifacts |
|---|---|---|
| Rust | Cargo.toml |
target/, vendor/† |
| Node / TypeScript | package.json |
dist/, .next/, .nuxt/, .svelte-kit/, .astro/, .turbo/, .parcel-cache/, .vite/, .nyc_output/, *.tsbuildinfo, build/†, node_modules/† |
| Python | pyproject.toml, setup.py, setup.cfg |
__pycache__/, .pytest_cache/, .mypy_cache/, .ruff_cache/, *.egg-info/, htmlcov/, .coverage, dist/, .tox/†, build/†, .venv/† |
| Go | go.mod |
bin/†, vendor/† |
| Zig | build.zig |
.zig-cache/, zig-cache/, zig-out/ |
| Swift | Package.swift |
.build/ |
| Xcode | *.xcodeproj, *.xcworkspace |
DerivedData/ |
| Maven | pom.xml |
target/ |
| Gradle / Kotlin | build.gradle, build.gradle.kts, settings.gradle* |
build/, .gradle/ |
| .NET | *.csproj, *.fsproj, *.vbproj, *.sln |
bin/, obj/ |
| CMake / C++ | CMakeLists.txt |
cmake-build-*/, CMakeFiles/, build/† |
| Dart / Flutter | pubspec.yaml |
.dart_tool/, build/ |
| Elixir | mix.exs |
_build/, .elixir_ls/, deps/† |
| Ruby | Gemfile, *.gemspec |
coverage/, vendor/bundle/†, pkg/†, tmp/† |
| PHP | composer.json |
.phpunit.cache/, .phpunit.result.cache, vendor/† |
| Scala / sbt | build.sbt |
target/, project/target/, .bloop/, .metals/ |
| Haskell | *.cabal, stack.yaml |
dist-newstyle/, .stack-work/ |
| OCaml / dune | dune-project |
_build/ |
| Julia | Project.toml |
deps/build/† |
| R | DESCRIPTION |
*.Rcheck/, src/*.o, src/*.so |
| Nim | *.nimble |
nimcache/ |
| Elm | elm.json |
elm-stuff/ |
| Terraform | *.tf |
.terraform/ |
| Bazel | WORKSPACE, WORKSPACE.bazel, MODULE.bazel |
bazel-bin/, bazel-out/, bazel-testlogs/ |
| alef | CACHEDIR.TAG |
.alef/‡ |
| basemind | agent-id |
.basemind/†‡ |
‡ Proven from inside: agent-id is the file basemind writes into .basemind/ when it
creates the index, so the directory declares itself rather than relying on a sibling config
that is usually absent. Every other row looks for its marker beside or above the artifact.
A tool that wants its caches swept can do the same with the cross-tool
CACHEDIR.TAG.
† Off by default — the name is also a plausible source directory in that ecosystem, or removal is
expensive rather than cheap. Turn one on for a single run with --enable python.venv, or per
ecosystem and per path in your config. voom catalog prints the live table, with the reason each
† entry needs an opt-in.
Configuration
voom merges configuration from built-in defaults, ~/.config/voom/config.toml, and every
voom.toml from the scan root down to each candidate — nearest wins. A repository can therefore
protect its own quirks and still be swept correctly from $HOME. Every table in the schema
rejects unknown fields, so a typo in a key — excludee, min_agee — is a hard load error rather
than a guard that silently never took effect.
# Top-level keys come first: TOML would otherwise read them as part of the table above.
= ["~/work/client-x/**", "**/fixtures/**"] # never scanned, always wins
= ["~/scratch/build-junk"] # swept without a marker — explicit intent
[]
= ["python.venv"] # opt into a † artifact
= ["terraform"]
[]
= false # skip the housekeeping a sweep otherwise does here
[]
= ["uv"] # opt into a named tool cache — additive across the hierarchy, never subtractive
[]
= "7d" # never remove something modified more recently
= "1MB" # not worth the rebuild below this
= "50GB" # probably not what you meant
[]
= "1d"
[[]]
= "~/work/**"
= { = "30d" }
[[]]
= "~/experiments/**"
= { = ["node.build"] }
Paths in include are swept without a marker proving them — the one place voom will remove
something it cannot prove. They report as unanchored rather than as an ecosystem, and JSON marks
them "source": "config-include". exclude always wins over include, and include only
matches paths the walk actually visits: it cannot reach outside the roots you named, and it
cannot reach inside a directory the walk skips whole. For a dependency directory prefer
--clean-dependencies or --enable, which still prove the marker.
On Windows, write paths in single quotes. TOML basic strings take escapes, so
exclude = ["C:\Users\me\work\**"] fails to parse — \U starts a unicode escape. Use a TOML
literal string instead, which takes none:
= ['C:\Users\me\work\**']
voom config show [PATH] lists the files the configuration was merged from, in ascending
precedence, and then the merged result. Details in ADR 0004.
JSON output
--format json renders one JSON object per run on stdout; diagnostics stay on stderr, so
voom ~ --format json | jq works without filtering. It implies --verbose — a machine consumer
has no way to ask for detail after the fact — and suppresses the scan spinner. The shape is
versioned (schema_version, currently 3) so a breaking change is deliberate rather than
accidental.
|
|
Top level:
| Key | Type | Meaning |
|---|---|---|
schema_version |
number | 3. Bumped only on a breaking change. |
dry_run |
boolean | Whether the final step was withheld. |
roots |
string[] | The scan roots, as given. |
artifacts |
object[] | One per artifact found; see below. |
skipped |
object[] | { path, reason, detail } for every candidate passed over — always populated in JSON. |
walk_errors |
object[] | { path, detail, transient } per directory the walker could not read; transient marks an interruption (EINTR) rather than a real problem. |
totals |
object | See below. |
elapsed_ms |
number | The whole run, in milliseconds. timings_us below is the same duration broken down, in microseconds — a small tree can finish under one millisecond, at which point this alone reads 0. |
timings_us |
object | Microsecond stage timings: total, scan, policy, size, delete, git. The stages do not sum to total — the residue is configuration loading and worker-pool setup. |
git |
object or null |
What git housekeeping did. null when it was off, found no repositories, or the machine has no git — a consumer must test the value, since the key is always present. |
Each entry in artifacts[]:
| Field | Meaning |
|---|---|
path |
The path, as walked. |
ecosystem |
The catalog ecosystem id; the cache id for a source: "cache" entry; null for config-include. |
artifact |
The declared artifact path (target/) that matched, or null for cache/config-include. |
bytes |
Size measured before removal was attempted. |
unreadable_directories |
Directories inside the artifact that could not be listed — non-zero means bytes is a lower bound. |
reclaimed_bytes |
What the removal actually freed. sum(artifacts[].reclaimed_bytes) == totals.bytes, always. |
source |
"marker", "config-include", or "cache". |
marker_dir |
The directory the marker was found in; null for config-include and cache. |
include_pattern |
The include pattern that matched; null unless source is "config-include". |
outcome |
{ status, ... } — removed, would_remove, refused (+ reason, detail), partially_removed (+ freed_bytes, remaining_bytes, os_error, os_message), or failed (+ the same failure fields). |
totals: reclaimed, bytes, skipped, refused, failed, partial, partial_bytes (a
subset of bytes), dependencies (a subset of reclaimed), unmeasured.
bytes and reclaimed_bytes follow du's rule on unix — allocated blocks, each hard-linked
inode counted once — and apparent file size on Windows, which has no portable link count to
dedup by.
Git housekeeping
An ordinary sweep also runs git's own local housekeeping in every repository it walks past —
free, since the walker already meets .git on its way past:
| Step | What it does |
|---|---|
git worktree prune --expire |
drops the administration of worktrees whose checkout has been gone for three months |
git gc --auto |
repacks only if git's own thresholds say it is worth it |
Neither contacts a network or expires a reflog beyond git's own policy, and voom never passes
--prune=now, --aggressive, or git reflog expire. Hooks are disabled for every invocation. An
in-progress rebase, merge, cherry-pick or bisect is skipped, and a linked worktree is resolved to
its object store and pruned once rather than per checkout. The report says nothing when nothing
was found:
pruned api — 2 stale worktrees pruned
Turn it off with --no-git, or [git] enabled = false in a voom.toml (the flag wins). See
ADR 0011.
voom git-prune runs the same housekeeping on its own, and is the only place the network step
(--remotes) lives — one round trip per remote per repository, which hangs without connectivity
and can block on a credential prompt, so it is deliberately not part of an ordinary sweep:
A repository whose housekeeping fails or times out makes git-prune exit 1; a skip is a rail
doing its job and exits 0.
Watch mode
Prunes continuously as you work. Filesystem events are coalesced over a debounce window
(--debounce, default 5s), and an artifact is only removed once its subtree has been idle for a
quiet period (--quiet-period, default 60s), so an in-progress build is never touched. Watch
mode never forces. See ADR 0008.
Git hooks
The reporting hook is the one to start with — it fails the commit on findings but deletes nothing.
pre-commit
repos:
- repo: https://github.com/Goldziher/voom
rev: v0.4.2
hooks:
- id: voom-report # reports, deletes nothing
# - id: voom-prune # actually deletes — opt in deliberately
poly
[[]]
= "voom"
= "https://github.com/Goldziher/voom.git"
= "v0.4.2"
= ["voom-report"]
Lefthook
pre-commit:
commands:
voom:
run: voom --dry-run --report --exit-code .
Performance
voom is I/O-bound, so the wins come from not walking things: it prunes matched artifacts, .git/,
dependency directories and tool caches at the directory level rather than descending into them,
and fans sizing and removal across every core. -j throttles the whole sweep, not just the walk —
the point of the flag on a spinning disk or a network filesystem. Measure your own tree with
hyperfine; see ADR 0005 for the walk's design.
Development
Design decisions live in adrs/ — start with
0001 and 0002.
See CONTRIBUTING.md for adding an ecosystem, which is the most common
contribution and has a checklist.
Contributing
Issues and pull requests are welcome, especially new ecosystems.
If voom is useful to you, consider sponsoring development.