https://github.com/sassman/putzen-rs
"putzen" is German and means cleaning. It helps keeping your disk clean of build and dependency artifacts safely.
https://github.com/sassman/putzen-rs
cleaning cmake command-line-tool javascript nodejs rust
Last synced: 2 months ago
JSON representation
"putzen" is German and means cleaning. It helps keeping your disk clean of build and dependency artifacts safely.
- Host: GitHub
- URL: https://github.com/sassman/putzen-rs
- Owner: sassman
- License: gpl-3.0
- Created: 2022-01-21T21:44:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-18T16:57:44.000Z (2 months ago)
- Last Synced: 2026-04-18T18:38:51.743Z (2 months ago)
- Topics: cleaning, cmake, command-line-tool, javascript, nodejs, rust
- Language: Rust
- Homepage: https://crates.io/crates/putzen-cli
- Size: 1.27 MB
- Stars: 33
- Watchers: 0
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Putzen
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://crates.io/crates/putzen-cli)
[](https://deps.rs/repo/github/sassman/putzen-rs)
[](https://github.com/sassman/putzen-rs/actions?query=branch%3Amain+workflow%3ABuild+)
"putzen" is German and means cleaning. It helps keeping your disk clean of build and dependency artifacts safely.
## About
In short, putzen solves the problem of cleaning up build or dependency artifacts.
It does so by a simple "File" -> "Folder" rule. If the "File" and "Folder" is present, it cleans "Folder"
It also does all this fast, means in parallel (if the filesystem supports it).
### Supported Artifacts
putzen supports cleaning artifacts for:
| type | file that is checked | folder that is cleaned |
|------------|----------------------|------------------------|
| rust | Cargo.toml | target |
| javascript | package.json | node_modules |
| CMake | CMakeLists.txt | build |
furthermore, it does also support:
- It can do run a dry-run (`-d`)
- Interactive asking for deletion
- Sums up the space that will be freed
## Quick Start
### Install
### On Linux as snap
[](https://snapcraft.io/putzen)
- installation [for Linux Mint](https://snapcraft.io/install/putzen/mint)
- installation [for Arch Linux](https://snapcraft.io/install/putzen/arch)
*TL;DR:*
```sh
sudo snap install putzen
```
### With cargo
To install the `putzen`, you just need to run
```sh
cargo install putzen-cli
```
**Note** the binary is called `putzen` (without `-cli`)
to verify if the installation was successful, you can run `which putzen` that should output similar to
```sh
$HOME/.cargo/bin/putzen
```
### Usage
```sh
$ putzen --help
Usage: putzen [-v] [--scores] [-d] [-y] [-L] [-a] [--] []
help keeping your disk clean of build and dependency artifacts
Positional Arguments:
folder path where to start with disk clean up.
Options:
-v, --version show the version number
--scores show the stored highscore board and exit
-d, --dry-run dry-run will never delete anything, good for simulations
-y, --yes-to-all switch to say yes to all questions
-L, --follow follow symbolic links
-a, --dive-into-hidden-folders
dive into hidden folders too, e.g. `.git`
--help, help display usage information
```
### Highscores
Every putzen run earns you a little reward. The biggest single cleanup and the biggest total run ever measured are kept as a tiny gold/silver/bronze podium. Keep running it on your machine and watch your records stack up over time — show the board any time with `--scores`:
```
❯ putzen --scores
──── ★ SINGLE CLEANUP ★ ────
🥇 Gold
40.1GiB · 2026-03-14
────────────────────────────
🥈 Silver
37.9GiB · 2026-03-10
────────────────────────────
🥉 Bronze
6.5GiB · 2026-03-14
────────────────────────────
──── ★ TOTAL RUN ★ ────
🥇 Gold
60.3GiB · 2026-03-14
────────────────────────────
🥈 Silver
44.6GiB · 2026-03-10
────────────────────────────
🥉 Bronze
19.6GiB · 2026-04-03
────────────────────────────
```
## Alternative Projects
- [kondo](https://github.com/tbillington/kondo)
## License
- **[GNU GPL v3 license](https://www.gnu.org/licenses/gpl-3.0)**
- Copyright 2019 - 2023 © [Sven Kanoldt](https://d34dl0ck.me)
- Logo - [Clean icons created by photo3idea_studio - Flaticon](https://www.flaticon.com/free-icons/clean)