Skip to content
A disk cleaning utility for developers.
Shell Perl
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
completion
src
.gitignore
Makefile
README.pod

README.pod

NAME

broom - a disk cleaning utility for developers

SYNOPSIS

broom [option...] [directory]

DESCRIPTION

broom recursively looks for projects inside a directory and cleans them by removing build artifacts, optimizing version control system files, etc.

OPTIONS

-n, --dry-run

Only show commands that would be executed instead of actually performing them.

-t TOOLS, --tools=TOOLS

Comma-separated list of tools to run the cleanup for. The available tools are: make, rake, python, ant, mvn, gradle, buildr, sbt, ninja and git. By default, all tools are used.

-v, --verbose

Be more verbose. Pass this option several times to see debug info.

-q, --quiet

Be less verbose. Pass this option several times to remove all output.

-h, --help

Show usage information and exit.

--version

Show version information and exit.

EXAMPLES

To perform cleanup in the current working directory:

 broom

To perform cleanup in your projects folder:

 broom ~/projects

To perform cleanup in your projects folder, with all logging on:

 broom -vvv ~/projects

To show what commands would be performed, without running them:

 broom -n ~/projects

To perform cleanup only for git and make projects:

 broom -t git,make ~/projects

FILES

broom allows to define default execution parameters in the ~/.broomrc file. Here is an example of ~/.broomrc file:

 # Use dry run mode by default.
 DRY_RUN=true

 # Only show warnings and errors.
 LOG_LEVEL=0

 # Run in projects directory.
 DIRECTORY=~/projects
 
 # Only look for some specific kind of projects.
 TOOLS=(make python ant git)

INSTALLING

Get the last release here, and follow the steps below to build and install it:
tar xzf broom-*.tar.gz
cd broom-*/
make
sudo make install
Something went wrong with that request. Please try again.