This tool allows you to list any node_modules directories in your system, as well as the space they take up. You can then select which ones you want to erase to free up space. Yay!
We're making an effort to internationalize the Npkill docs. Here's a list of the available translations:
Clear space: Get rid of old and dusty node_modules cluttering up your machine.
Last Workspace Usage: Check when was the last time you modified a file in the workspace (indicated in the last_mod column).
Very fast: NPKILL is written in TypeScript, but searches are performed at a low level, improving performance greatly.
Easy to use: Say goodbye to lengthy commands. Using npkill is as simple as reading a list of your node_modules, and pressing Del to get rid of them. Could it be any easier? ;)
Minified: It barely has any dependencies.
You don't really need to install it to use it! Simply use the following command:
Or if for some reason you really want to install it:
$ npm i -g npkill # Unix users may need to run the command with sudo. Go carefully
NPKILL does not support node<v14. If this affects you you can use
npkill@0.8.3
$ npx npkill # or just npkill if installed globally
By default, npkill will scan for node_modules starting at the path where npkill command is executed.
Move between the listed folders with ↓ ↑, and use Space or Del to delete the selected folder. You can also use j and k to move between the results.
You can open the directory where the selected result is placed by pressing o.
To exit, Q or Ctrl + c if you're brave.
Important! Some applications installed on the system need their node_modules directory to work and deleting them may break them. NPKILL will highlight them by displaying a ⚠️ to be careful.
This mode allows you to select and delete multiple folders at once, making it more efficient when cleaning up many directories.
Entering Multi-Select ModePress T to toggle multi-select mode. When active, you'll see a selection counter and additional instructions at the top of the results.
After pressing V to enter range selection mode:
-x. -e, --hide-errors Hide errors if any -E, --exclude Exclude directories from search (directory list must be inside double quotes "", each directory separated by ',' ) Example: "ignore1, ignore2" -f, --full Start searching from the home of the user (example: "/home/user" in linux) --size-unit Set the unit for displaying folder sizes. (Available: auto, mb, gb). With auto, sizes < 1024MB are shown in MB (rounded), larger sizes in GB (with decimals). -h, --help, ? Show this help page and exit -nu, --no-check-update Don't check for updates on startup -s, --sort Sort results by: size, path or last-mod -t, --target Specify the name of the directories you want to search for (by default, it's 'node_modules'). You can define multiple targets separating with comma. Ej. -t node_modules,.cache,. -x, --exclude-hidden-directories Exclude hidden directories ("dot" directories) from search. --dry-run It does not delete anything (will simulate it with a random delay). --json Output results in JSON format at the end of the scan. Useful for automation and scripting. --json-stream Output results in streaming JSON format (one JSON object per line as results are found). Useful for real-time processing. -v, --version Show npkill version
Warning: In future versions some commands may change
npkill -d ~/projects # other alternative: cd ~/projects npkill
npkill --bg-color magenta
npkill -d '~/more projects' --size-unit gb --sort size --target vendor
npkill -d 'projects' --exclude "progress, ignore-this"
npkill -d ~/backups/ --delete-all
npkill --json > results.json
npkill --json-stream | jq '.'
npkill --json-stream 2>/dev/null | jq -s '.' > clean-results.json
Npkill supports JSON output formats for automation and integration with other tools:
--json: Output all results as a single JSON object at the end of the scan--json-stream: Output each result as a separate JSON object in real-timeFor detailed documentation, examples, and TypeScript interfaces, see JSON Output Documentation.
Quick Examples:
# Get all results as JSON npkill --json > results.json # Process results in real-time npkill --json-stream | jq '.result.path' # Find directories larger than 100MB npkill --json | jq '.results[] | select(.size > 104857600)'
# -- First, clone the repository git clone https://github.com/voidcosmos/npkill.git # -- Navigate to the dir cd npkill # -- Install dependencies npm install # -- And run! npm run start # -- If you want to run it with some parameter, you will have to add "--" as in the following example: npm run start -- -f -e
The api allows you to interact with npkill from node to create your own implementations in your scripts (automations, for example).
You can check the basic API here or on the web (comming soon).
If you find any bugs, don't hesitate and open an issue :)
If you want to contribute check the CONTRIBUTING.md
We have developed npkill in our free time, because we are passionate about the programming sector. Tomorrow we would like to dedicate ourselves to this, but first, we have a long way to go.We will continue to do things anyway, but donations are one of the many ways to support what we do.
A huge thank you to our backers ❤️MIT © Nya García Gallardo and Juan Torres Gómez
🐱🐤
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4