clean-my-code (npm)

This npm package is a thin wrapper around the Rust clean-my-code CLI.

On install, it downloads a prebuilt binary for your OS/CPU and exposes the clean-my-code command.

Quick Start

npx clean-my-code
# or
npm i -g clean-my-code
clean-my-code

Requirements

• Node.js >= 14
• git available on PATH (the CLI uses git check-ignore / git log)

Usage

# Default (TUI)
clean-my-code

# Choose scan root
clean-my-code --root /path/to/workspace

# Scan-only (no TUI)
clean-my-code scan

# TUI with options
clean-my-code tui --min-size 1MiB
clean-my-code tui --dry-run

# Control parallelism
clean-my-code --threads 8

# Add artifact dir names (repeatable)
clean-my-code --artifact .gradle --artifact .venv

# Only use your custom list (disable built-ins)
clean-my-code --no-default-artifacts --artifact target --artifact node_modules

Run clean-my-code --help for the full CLI reference.

The built-in artifact list is intentionally conservative. It excludes stateful or user-managed directories that may contain secrets, deployment metadata, uploads, or local state, such as .terraform, .direnv, .vercel, .serverless, public, packages, bin, and tmp. Add them explicitly via --artifact only if you are sure they are safe to remove.

TUI keybindings

• Up/Down: move cursor
• Space: toggle selection
• a: select all
• n: select none
• Tab: toggle sort (age/size)
• Enter: confirm and delete (with a second confirmation)
• q / Esc: quit

Supported Platforms

Prebuilt binaries are provided for:

• macOS: x64, arm64
• Linux (gnu): x64, arm64
• Windows (MSVC): x64

For Linux x64 prebuilt releases (x86_64-unknown-linux-gnu), CI enforces that required GLIBC symbols do not exceed GLIBC_2.36.

If your platform isn’t covered, build from source (Rust required).

Install Details & Troubleshooting

• This package downloads a prebuilt binary during npm install into vendor/ and runs it via a small JS shim at bin/clean-my-code.js.
• To use a custom mirror, set CLEAN_MY_CODE_DOWNLOAD_BASE (or legacy CLEAN_CODE_DOWNLOAD_BASE) to a base URL that mirrors the GitHub Releases layout.
• Git worktree and other multi-level layouts are supported; scanning probes 1-2 levels below non-repo directories to find nested git repos.