gitreaper

GitReaper ☠️

Clean up your Git repository like a pro.
GitReaper safely reaps stale, merged, or orphaned branches and cleans your workspace with intelligent, configurable rules.

⚡️ Features

• 🔍 Dry run mode with color-coded output
• 🧹 Delete local branches merged into main, master, or develop
• 🚫 Automatically protect important branches (via .gitreaperrc)
• 📅 Age-based cleanup (--older-than, --keep-recent)
• 🧠 Interactive mode with commit info and author context
• 🔥 --force, --aggressive cleanup for CI or cron
• 📊 Post-cleanup reports: what was deleted and how much space was saved
• 🪄 Git hook integration (e.g., run before git push)
• 🛠 Configurable per-repo or globally

📦 Installation

Using go install:

go install github.com/yourusername/gitreaper@latest

Make sure $GOPATH/bin is in your $PATH.

Or build from source:

git clone https://github.com/yourusername/gitreaper.git
cd gitreaper
make build
./build/gitreaper --help

🚀 Usage

gitreaper --dry-run

Example:

gitreaper --older-than 30d --exclude "release/*" --interactive

Available flags:

🛡 Configuration (.gitreaperrc)

Create a .gitreaperrc file in your repo root or ~/.gitreaperrc:

protect = ["main", "master", "develop", "release/*"]
dry_run = true
interactive = true
older_than_days = 30

📂 Project Structure

gitreaper/
├── cmd/gitreaper         # CLI entrypoint
├── internal/             # App logic modules
│   ├── git/              # Git command wrappers
│   ├── reaper/           # Branch cleanup logic
│   ├── config/           # Config parsing
│   ├── ui/               # Interactive prompts, output
│   └── errors/           # Custom error handling
├── pkg/                  # Exportable packages
├── docs/                 # Project documentation
├── scripts/              # Dev tools and helpers
├── testdata/             # Test fixtures
├── .github/workflows/    # CI/CD configs
├── .gitignore
├── LICENSE
├── Makefile
└── README.md

🧪 Testing

Run all tests:

make test

🧰 Development

Install dependencies:

make deps

Run linter:

make lint

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.

✨ Future Roadmap

• GitHub remote branch cleanup
• GUI or TUI interface (fzf-style)
• VS Code extension
• Auto-scheduling or daemon mode