polykill 1.6.0

Lightweight command line utility for removing dependencies and build artifacts from unused projects.
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Polykill

[![Crates.io](https://img.shields.io/crates/v/polykill?style=flat-square&color=peru)](https://crates.io/crates/polykill)
[![Crates.io (Downloads)](https://img.shields.io/crates/d/polykill?style=flat-square&color=mediumseagreen)](https://crates.io/crates/polykill)
[![Crates.io Size](https://img.shields.io/crates/size/polykill?style=flat-square&color=steelblue)](https://crates.io/crates/polykill)

*Like [polyfill](https://developer.mozilla.org/en-US/docs/Glossary/Polyfill) - but more violent*

Lightweight command line utility for removing unwanted dependencies and build artifacts from local projects. Inspired by [npkill](https://www.npmjs.com/package/npkill).

Supported project types:
- Node
- Cargo
- .NET
- Go
- Gradle
- Mix
- Composer
- Misc. (see "Additional Information")

## Installation

**Cargo**
```sh
cargo install polykill
```

**Homebrew**
```sh
brew tap bdeering1/polykill
brew install polykill
```

**Nix (Flake)**

```sh
nix shell github:Bdeering1/polykill
# OR
nix run github:Bdeering1/polykill
```

## Usage

```sh
polykill [OPTIONS] [DIR]
```

Polykill will recursively search for projects in the provided directory and output a list of all projects found. If no directory is provided, the current directory will be searched.

When the search has completed, navigate the menu using the following controls:

| Key Bind   | Action           |
| ---------- | ---------------- |
| ↓, ↑, ←, →, h, j, k, l | select project |
| enter, del | remove artifacts |
| esc, q     | exit             |

**Warning for Node projects:** Some Node applications need their node_modules directory to work and deleting it may break them.

## Options

| Argument         | Description                                                       |
| ---------------- | ----------------------------------------------------------------- |
| -v, --verbose    | Verbose output                                                    |
| -a, --auto       | Automatically clean up older project artifacts (no menu)          |
| -t, --threshold  | Minimum threshold for automatic artifact cleanup (days since last modified) |
|       --register | Register system service to run polykill automatically  |
|       --unregister | Remove registered system service  |
| -i, --interval | Interval (in days) to run system service on                         |
|       --status | Check if a polykill service exists, print info if found |
| -s, --skip-empty | Hide projects with zero possible disk savings                     |
| -u, --unsorted   | Don't sort projects                                               |
|       --no-vcs | Include projects without version control (this will slow down search) |
| -h, --help       | Print help                                                        |
| -V, --version    | Print version                                                     |

*supported version control systems are: git, svn, and mercurial

## Additional Information

How projects are identified and which files or directories will be removed:

| Type      | Identifier(s)      | Artifacts        |
| --------- | ------------------ | ---------------- |
| Node      | package.json       | node_modules     |
| Cargo     | cargo.toml         | target           |
| .NET      | .csproj            | bin, obj         |
| Go        | go.mod             | dir(.exe), dir.test(.exe) |
| Gradle    | build.gradle(.kts) | build            |
| Mix       | mix.exs            | _build, deps     |
| Composer  | composer.json      | vendor           |
| Misc.     | bin, build, dist   | bin, build, dist |

*dir for go projects is the name of the project directory