### Easily find and **remove** old and heavy **node_modules** folders :sparkles:
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!
## i18n
We're making an effort to internationalize the Npkill docs. Here's a list of the available translations:
- [Español](./README.es.md)
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
- [Examples](#examples)
- [Set Up Locally](#setup-locally)
- [Roadmap](#roadmap)
- [Known bugs](#known-bugs)
- [Contributing](#contributing)
- [Buy us a coffee](#donations)
- [License](#license)
# :heavy_check_mark: Features
- **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.
# :cloud: Installation
You don't really need to install it to use it!
Simply use the following command:
```bash
$ npx npkill
```
Or if for some reason you really want to install it:
```bash
$ npm i -g npkill
# Unix users may need to run the command with sudo. Go carefully
```
> NPKILL does not support node
# :clipboard: Usage
```bash
$ 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 :warning: to be careful.
## Options
| ARGUMENT | DESCRIPTION |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| -c, --bg-color | Change row highlight color. _(Available: **blue**, cyan, magenta, white, red and yellow)_ |
| -d, --directory | Set the directory from which to begin searching. By default, starting-point is . |
| -D, --delete-all | Automatically delete all node_modules folders that are found. Suggested to be used together with `-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) |
| -gb | Show folders in Gigabytes instead of Megabytes. |
| -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 (by default, is node_modules) |
| -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). |
| -v, --version | Show npkill version |
**Warning:** _In future versions some commands may change_
## Examples
- Search **node_modules** directories in your _projects_ directory:
```bash
npkill -d ~/projects
# other alternative:
cd ~/projects
npkill
```
- List directories named "dist" and show errors if any occur:
```bash
npkill --target dist -e
```
- Displays the magenta color cursor... because I like magenta!
```bash
npkill --color magenta
```
- List **vendor** directories in your _projects_ directory, sort by size, and show size in gb:
```bash
npkill -d '~/more projects' -gb --sort size --target vendor
```
- List **node_modules** in your _projects_ directory, excluding the ones in _progress_ and _ignore-this_ directories:
```bash
npkill -d 'projects' --exclude "progress, ignore-this"
```
- Automatically delete all node_modules that have sneaked into your backups:
```bash
npkill -d ~/backups/ --delete-all
```
# :pager: Set Up Locally
```bash
# -- 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
```
# :crystal_ball: Roadmap
- [x] Release 0.1.0 !
- [x] Improve code
- [x] Improve performance
- [ ] Improve performance even more!
- [x] Sort results by size and path
- [x] 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
- [x] Add some menus
- [x] Add log service
- [ ] Periodic and automatic cleaning (?)
# :bug: Known bugs :bug:
- 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 :)
# :revolving_hearts: Contributing
If you want to contribute check the [CONTRIBUTING.md](.github/CONTRIBUTING.md)
# :coffee: Buy us a coffee
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.
### Thanks!!
## A huge thank you to our backers :heart:
---
### Crypto alternative
- btc: 1ML2DihUoFTqhoQnrWy4WLxKbVYkUXpMAX
- bch: 1HVpaicQL5jWKkbChgPf6cvkH8nyktVnVk
- eth: 0x7668e86c8bdb52034606db5aa0d2d4d73a0d4259
# :scroll: License
MIT © [Nya García Gallardo](https://github.com/NyaGarcia) and [Juan Torres Gómez](https://github.com/zaldih)
:cat::baby_chick:
---