Marco D'Aleo fa8a194ccb Merge pull request #2 from guardutils/update_filedust_20251129
Improve sefety and add config file
- Add .cache and build to the skip dir list, make filedust run ONLY in the user home directory
- Major rewrite of junk.py, adding user config file for custom rules, don't treat broken symlink as junk
- Add filedust config file, update README, version bump
2025-11-29 10:52:40 +00:00
2025-11-23 17:59:42 +00:00
2025-11-23 17:59:42 +00:00
2025-11-23 17:59:42 +00:00

License Language GitHub Release PyPI - Version PyPI downloads

filedust

filedust is a small, fast, and safe command-line tool that scans your filesystem for obvious junk — things like Python pycache folders, build artifacts, editor backup files, and leftover temporary files — and cleans them up.

Think of it as “autoremove for files.”

Features

Cleans common junk

Deletes well-known clutter such as:

  • __pycache__/

  • .pytest_cache, .mypy_cache, .ruff_cache

  • build/, dist/

  • editor backups *~, *.swp, *.tmp, etc.

  • OS metadata like .DS_Store, Thumbs.db

Rich, colorful table output

It wasn't essential, but it's easy to read at a glance.

Single confirmation prompt

One interactive prompt at the end of the run (unless -y is used).

Reclaimed space summary

Shows how much disk space can be freed.

Safe by design

  • It ONLY runs within user's $HOME

  • Put user in control by reading ~/.filedust.conf

  • Never touches dotfiles, configs, project files, or anything important unless you want.

Installation

From PyPI

pip install filedust

From this repository

git clone https://github.com/guardutils/filedust.git
cd filedust/
poetry install

Custom config

You can download the example and add your custom rule

wget -O ~/.filedust.conf https://raw.githubusercontent.com/guardutils/filedust/main/.filedust.conf.example

TAB completion

Add this to your .bashrc

eval "$(register-python-argcomplete filedust)"

And then

source ~/.bashrc
Description
Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)
Readme 111 KiB
0.3.1 Latest
2025-11-29 17:02:59 +00:00
Languages
Python 100%