ReclaimSpace Docs

Usage

Here are some common ways to use reclaimspace:

Interactive Mode (Default)

This is the default behavior. It lists all the folders, and you can select which ones to delete.

Copynpx reclaimspace

Auto-Delete Everything

This will find all reclaimable items and delete them automatically without confirmation.

Copynpx reclaimspace --yes

Dry Run (Preview)

This will list all the items that can be deleted but won't actually delete anything.

Copynpx reclaimspace --dry

Scan a Specific Folder

You can specify one or more directories to scan.

Copynpx reclaimspace <foldername>

Display Version Number

This will display the version number of the tool.

Copynpx reclaimspace --version

Display Help Message

This will display the help message with all available options.

Copynpx reclaimspace --help

Combine Flags and Folders

You can combine any of the flags with a specific folder.

Copynpx reclaimspace --yes my-project

Enable Build Analysis

This will enable build analysis logs.

Copynpx reclaimspace --build-analysis

Ignore Certain Folders Permanently

You can permanently exclude folders from the scan by providing a comma-separated list of patterns. This will update or create a .reclaimspacerc file in the current directory using the --save or -s flag.

Copynpx reclaimspace --ignore "node_modules,dist" --save

Include Only Specific Folders

You can specify a comma-separated list of patterns to include in the scan. When this flag is used, only folders matching these patterns will be considered.

Copynpx reclaimspace --include "my-custom-build,temp-files"

Features

• Interactive Deletion: Navigate through a list of found items using arrow keys, space to select, and Enter to proceed.
• Zero Runtime Dependencies: Built from the ground up with native Node.js APIs for maximum speed and security. No node_modules at runtime!
• Categorized & Grouped: Results are grouped by type for clarity.
• Size Information: See the size of each item and the total reclaimable space.
• Concurrent Scanning: Quickly finds and processes files.
• Build Artifact Detection: Intelligently detects build folders.
• Auto-Delete Mode: Use the --yes flag to delete all found items without confirmation.
• Dry Run Mode: Use the --dry flag to see what would be deleted without actually deleting anything.
• Ignore Patterns: Exclude specific folders or patterns using a .reclaimspacerc file or the --ignore flag.
• Interactive UI: Supports 'a' to select all and 'i' to invert selection.
• Windows Stability: Includes built-in retry logic for locked files (EBUSY/EPERM), ensuring smooth cleanup on Windows systems.
• Smart Error Handling: Clear, actionable messages for resource-busy errors, helping you identify which applications to close.
• Cool Logo: Displays a cool logo when you run the tool.

Configuration

You can create a .reclaimspacerc file in the root of your project to specify folders and patterns to ignore.

Example .reclaimspacerc file:

Copy# Ignore all node_modules folders
node_modules

# Ignore a specific build folder
my-project/dist

Detected Items

reclaimspace detects the following categories:

1. Node Modules
   • node_modules
2. Build/Cache Folders
   • .next, dist, build, storybook-static, .nuxt, .output, .svelte-kit, .angular, out, .expo, .turbo, .cache, .shopify, .react-router, .tanstack, .vite-ssg-temp
   • .rollup.cache, .parcel-cache, .vite, .astro, .solid, .remix, .docusaurus, .eleventy-cache, .gatsby-cache, .eslintcache, .stylelintcache, .prettiercache, .tsbuildinfo, .swc, .nx, .pnpm-store, .wwebjs_cache, .wwebjs_auth, public/build
3. Testing/Reporting Folders
   • coverage, .nyc_output, .pytest_cache, .tox, htmlcov
4. Miscellaneous Dev Junk
   • .venv, venv, env (Python Virtual Environments)
   • __pycache__, .mypy_cache, .ruff_cache (Python caches)
   • vendor (Go/PHP dependencies)
   • .vagrant, .terraform (Infrastructure tools)

Contributing

Contributions are welcome! Please read our contributing guidelines to get started.