npkill

README

Easily find and remove old and heavy node_modules folders ✨

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!

Table of Contents

• Installation
• Usage
  • Options
  • Examples
• Roadmap
• Known-bugs
• Contributing

Installation

$ npm i -g npkill

Unix users may need to run the command with sudo

Usage

npkill

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 Del to delete the selected folder (Supr for spanish keyboards.)

To exit, Ctrl + c.

Options

ARGUMENT	DESCRIPTION
-h, --help, ?	Show this help page and exit
-v, --version	Show npkill version
-d, --directory	Set the directory from which to begin searching. By default, starting-point is .
-f, --full	Start searching from the home of the user (example: "/home/user" in linux)
-D, --delete-all	Automatically delete all node_modules folders that are found
-e, --show-errors	Show error messages if any

Warning: In future versions some commands may change

Examples

• Search node_modules directories in your projects directory:

npkill -r ~/projects

# other alternative:
cd ~/projects
npkill

• Automatically delete all node_modules that have sneaked into your backups:

npkill -r ~/backups/ --delete-all

Roadmap

• Release 0.1.0 !
• Improve code
  • Improve performance
• Reduce dependencies to be a more minimalist module
• Allow the search for other types of directories (targets)
• Allow to filter by directories that have not been used in a period of time
• Periodic and automatic cleaning (?)

Known-bugs

• Performance issues when searching from high level directories (like / in linux).
• Sometimes text collapses when updating the cli.
• (SOLVED) Analyzing the size of the directories takes longer than it should.
• (SOLVED) State "searching..." does not change even if search has been completed

Contributing

Available soon

---