rskill 0.4.0

npkill like cli utility for removing node_modules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**rskill** is a clone of [npkill](https://github.com/voidcosmos/npkill), written in Rust for study purposes. It allows you to quickly find and delete `node_modules` directories to free up disk space. While it tries to follow the same CLI API as `npkill`, it does not implement all of it's features. **User discretion is advised** when deleting directories.

---

## Features

- 🚀 **Fast**: Slightly faster than the original `npkill` (though not streamed directly to the terminal and some features are missing such as automatic updates, bg color customization etc.).
- 🎯 **Same CLI API**: Supports the same command-line flags as `npkill` for familiarity.
- 🛠 **Study Project**: Written in Rust as a learning exercise.

---

## Options

| ARGUMENT                         | DESCRIPTION                                                                                                                                    |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| -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, --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                                                                                                                   |
| -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.                                                                                    |
| -V, --version                    | Show rskill version                                                                                                                            |


## Installation

You can install `rskill` via Cargo:
```bash
cargo install rskill
```

or download the latest release from [Releases](https://github.com/xsadia/rskill/releases) and add the binary to your system's PATH.
```bash
wget https://github.com/xsadia/rskill/releases/download/v0.1.0/rskill-linux-x86_64.tar.gz
tar -xzf rskill-linux-x86_64.tar.gz
sudo mv rskill /usr/local/bin
```

## Acknowledgments
  - Inspired by [npkill](https://github.com/voidcosmos/npkill).