{"id":20978829,"url":"https://github.com/nicoulaj/broom","last_synced_at":"2025-05-14T14:32:52.240Z","repository":{"id":2264960,"uuid":"3221129","full_name":"nicoulaj/broom","owner":"nicoulaj","description":"A disk cleaning utility for developers.","archived":false,"fork":false,"pushed_at":"2019-02-05T18:57:34.000Z","size":57,"stargazers_count":39,"open_issues_count":13,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T19:40:09.588Z","etag":null,"topics":["ant","bundle","cargo","cleaner","git","gradle","make","maven","ninja","python","rake","rant","sbt","shell","vagrant","waf"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicoulaj.png","metadata":{"files":{"readme":"README.pod","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-01-19T21:10:05.000Z","updated_at":"2023-10-01T06:58:42.000Z","dependencies_parsed_at":"2022-08-31T03:41:25.718Z","dependency_job_id":null,"html_url":"https://github.com/nicoulaj/broom","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicoulaj%2Fbroom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicoulaj%2Fbroom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicoulaj%2Fbroom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicoulaj%2Fbroom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicoulaj","download_url":"https://codeload.github.com/nicoulaj/broom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254160648,"owners_count":22024574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ant","bundle","cargo","cleaner","git","gradle","make","maven","ninja","python","rake","rant","sbt","shell","vagrant","waf"],"created_at":"2024-11-19T05:09:38.467Z","updated_at":"2025-05-14T14:32:51.995Z","avatar_url":"https://github.com/nicoulaj.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"=encoding utf8\n\n=head1 NAME\n\nbroom - a disk cleaning utility for developers\n\n=begin html\n\n\u003ca href=\"https://asciinema.org/a/102852\" target=\"_blank\"\u003e\u003cimg src=\"http://i.imgur.com/VoqGIzo.png\" width=\"717\"/\u003e\u003c/a\u003e\n\n=end html\n\n=head1 SYNOPSIS\n\nI\u003cbroom\u003e [option...] [directory]\n\n=head1 DESCRIPTION\n\nbroom recursively looks for projects inside a directory and cleans them\nby removing build artifacts (eg: by invoking \"make clean\"), optimizing\nversion control system files (eg: by invoking \"git gc\"), etc.\n\n=head1 OPTIONS\n\n=over\n\n=item B\u003c-n, --dry-run\u003e\n\nOnly show commands that would be executed instead of actually performing\nthem.\n\n=item B\u003c-t\u003e I\u003cTOOLS\u003eB\u003c, --tools=\u003eI\u003cTOOLS\u003e\n\nComma-separated list of tools to run the cleanup for. The available tools\nare: I\u003cmake\u003e, I\u003crake\u003e, I\u003cpython\u003e, I\u003cant\u003e, I\u003cmvn\u003e, I\u003cgradle\u003e, I\u003cbuildr\u003e,\nI\u003csbt\u003e, I\u003cninja\u003e, I\u003cscons\u003e, I\u003cwaf\u003e, I\u003crant\u003e, I\u003cgit\u003e, I\u003cbundle\u003e, I\u003cvagrant\u003e\n, I\u003ccargo\u003e and I\u003cmakepkg\u003e. By default, all tools are used.\n\n=item B\u003c-v, --verbose\u003e\n\nBe more verbose. Pass this option several times to see debug info.\n\n=item B\u003c-s, --stats\u003e\n\nPrint disk space gained.\n\n=item B\u003c--noconfirm\u003e\n\nDo not ask for confirmation before performing actions that may result in\npotential data loss (eg: destroying Vagrant boxes).\n\n=item B\u003c-q, --quiet\u003e\n\nBe less verbose. Pass this option several times to remove all output.\n\n=item B\u003c-h, --help\u003e\n\nShow usage information and exit.\n\n=item B\u003c--version\u003e\n\nShow version information and exit.\n\n=back\n\n=head1 EXAMPLES\n\nTo perform cleanup in the current working directory:\n\n broom\n\nTo perform cleanup in your projects folder:\n\n broom ~/projects\n\nTo perform cleanup in your projects folder, with all logging on:\n\n broom -vvv ~/projects\n\nTo show what commands would be performed, without running them:\n\n broom -n ~/projects\n\n\nTo perform cleanup only for git and make projects:\n\n broom -t git,make ~/projects\n\n=head1 FILES\n\nbroom allows to define default execution parameters in the F\u003c~/.broomrc\u003e\nfile. Here is an example of F\u003c~/.broomrc\u003e file:\n\n # Use dry run mode by default.\n DRY_RUN=true\n\n # Only show warnings and errors.\n LOG_LEVEL=0\n\n # Show statistics.\n STATS=true\n\n # Run in projects directory.\n DIRECTORY=~/projects\n\n # Only look for some specific kind of projects.\n TOOLS=(make python ant git)\n\n=begin html\n\n=head1 INSTALLING\n\n=head2 Using packages\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eSystem\u003c/th\u003e\n    \u003cth\u003eInstallation instructions\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eDebian / Ubuntu\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://software.opensuse.org/download.html?project=home%3Anicoulaj%3Abroom\u0026package=broom\"\u003ebroom repository\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eFedora / CentOS / RHEL / Scientific Linux\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://software.opensuse.org/download.html?project=home%3Anicoulaj%3Abroom\u0026package=broom\"\u003ebroom repository\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eOpenSUSE / SLE\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://software.opensuse.org/download.html?project=home%3Anicoulaj%3Abroom\u0026package=broom\"\u003ebroom repository\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eArch Linux\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://aur.archlinux.org/packages/broom\"\u003eAUR\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n=head2 Building from sources\n\n\u003cpre\u003e\ngit clone https://github.com/nicoulaj/broom.git\ncd broom\nmake\nsudo make install\n\u003c/pre\u003e\n\n=end html\n\n=begin man\n\n=head1 ISSUES\n\nPlease report issues at https://github.com/nicoulaj/broom/issues.\n\n=head1 AUTHOR\n\nJulien Nicoulaud \u003cjulien.nicoulaud@gmail.com\u003e\n\n=end man\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicoulaj%2Fbroom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicoulaj%2Fbroom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicoulaj%2Fbroom/lists"}