putzen-cli

Crates.ioputzen-cli
lib.rsputzen-cli
version1.0.9
sourcesrc
created_at2022-01-31 00:59:04.663566
updated_at2024-10-31 10:02:17.997473
descriptionhelps keeping your disk clean of build and dependency artifacts safely
homepage
repositoryhttps://github.com/sassman/putzen-rs
max_upload_size
id524273
size71,210
Sven Kanoldt (sassman)

documentation

README

Putzen

License: GPL v3 crates.io dependency status Build Status LOC

"putzen" is German and means cleaning. It helps keeping your disk clean of build and dependency artifacts safely.

demo

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

Get it from the Snap Store

TL;DR:

sudo snap install putzen

With cargo

To install the putzen, you just need to run

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

$HOME/.cargo/bin/putzen

Usage

$ putzen --help

Usage: putzen <folder> [-v] [-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
  -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            display usage information

Alternative Projects

License

Commit count: 38

cargo fmt