Repository files navigation

This tool allows you to list anynode_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:

• Español

• Features
• Installation
• Usage
  • Options
  • Examples
• Set Up Locally
• Roadmap
• Known bugs
• Contributing
• Buy us a coffee
• License

• Clear space: Get rid of old and dustynode_modules cluttering up your machine.

• Last Workspace Usage: Check when was the last time you modified a file in the workspace (indicated in thelast_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:

$ npx npkill

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 usenpkill@0.8.3

$ npx npkill# or just npkill if installed globally

By default, npkill will scan for node_modules starting at the path wherenpkill command is executed.

Move between the listed folders with↓↑, and useSpace orDel to delete the selected folder.You can also usej andk to move between the results.

You can open the directory where the selected result is placed by pressingo.

To exit,Q orCtrl +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.

Warning:In future versions some commands may change

• Searchnode_modules directories in yourprojects directory:

npkill -d~/projects# other alternative:cd~/projectsnpkill

• List directories named "dist" and show errors if any occur:

npkill --target dist -e

• Displays the magenta color cursor... because I like magenta!

npkill --color magenta

• Listvendor directories in yourprojects directory, sort by size, and show size in gb:

npkill -d'~/more projects' -gb --sort size --target vendor

• Listnode_modules in yourprojects directory, excluding the ones inprogress andignore-this directories:

npkill -d'projects' --exclude"progress, ignore-this"

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

npkill -d~/backups/ --delete-all

# -- First, clone the repositorygit clone https://github.com/voidcosmos/npkill.git# -- Navigate to the dircd npkill# -- Install dependenciesnpm 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

• Release 0.1.0 !
• Improve code
  • Improve performance
  • Improve performance even more!
• Sort results by size and path
• Allow the search for other types of directories (targets)
• Reduce dependencies to be a more minimalist module
• Allow to filter by directories that have not been used in a period of time
• Create option for displaying directories in tree format
• Add some menus
• Add log service
• Periodic and automatic cleaning (?)

• Sometimes, CLI is blocked while folder is deleting.
• Some terminals that do not use TTY (like git bash in windows) do not work.
• Sorting, especially by routes, can slow down the terminal when there are many results at the same time.
• Sometimes, size calculations are higher than they should be.
• (SOLVED) Performance issues when searching from high level directories (like / in linux).
• (SOLVED) Sometimes text collapses when updating the cli.
• (SOLVED) Analyzing the size of the directories takes longer than it should.

If you find any bugs, don't hesitate and open an issue :)

If you want to contribute check theCONTRIBUTING.md

We will continue to do things anyway, but donations are one of the many ways to support what we do.

• btc: 1ML2DihUoFTqhoQnrWy4WLxKbVYkUXpMAX
• bch: 1HVpaicQL5jWKkbChgPf6cvkH8nyktVnVk
• eth: 0x7668e86c8bdb52034606db5aa0d2d4d73a0d4259

MIT ©Nya García Gallardo andJuan Torres Gómez

🐱🐤