Getting started
Installation
Section titled “Installation”Run purgeit directly with npx:
npx purgeit ~/devOr install it globally:
npm install -g purgeitpurgeit ~/devFirst run
Section titled “First run”In a terminal, purgeit opens an interactive TUI:
purgeit ~/devUse the keyboard to navigate, select artifacts, and delete them after confirming.
For a non-interactive dry-run preview, use headless mode:
purgeit --headless --dry-run ~/devOr emit JSON for downstream tools:
purgeit --json --dry-run ~/devWhat gets cleaned
Section titled “What gets cleaned”By default, purgeit matches the most common regenerable directories:
node_modules,dist,.next,.nuxt,out,target- Framework caches:
.cache,.vite,.turbo,.swc,.angular,.svelte-kit,.astro - Test artifacts:
coverage,.nyc_output,playwright-report,test-results - Python artifacts:
__pycache__,.venv,.tox,.pytest_cache,.mypy_cache,.ruff_cache - Gated directories (only when a sibling manifest exists):
Pods,build,.gradle,bin,obj
See the full built-in rules reference for the complete list and gate conditions. You can extend or replace these rules with a configuration file.
Exit codes
Section titled “Exit codes”0— success1— nothing found or deletion had failures2— usage or environment error