Awesome
git curate
<img src="https://raw.githubusercontent.com/matt-harvey/git_curate/master/assets/demo.gif" width="1000" alt="Demo" />Motivation
After a while, my local repo becomes cluttered with branches, and git branch
outputs an awkwardly
long list. I want to delete some of those branches to bring that list back under control; but I
can’t always remember which branches I want to keep from the branch names alone; and inspecting them
one at a time and then running git branch -D
in a separate step, is painful.
git curate
is intended to ease this pain. It steps you through the local branches of a repo one at
a time, outputting the following information about each:
- Last commit date
- Last commit hash
- Last commit author
- Last commit subject
- Whether the branch has been merged into the current HEAD
- The status of the branch relative to the upstream branch it is tracking (if any)
You can then select whether to delete or keep each branch as you go.
NOTE git curate
does not run git fetch
prior to generating its output. If you want to
be sure that the “Status vs upstream” column reflects the latest state of the upstream branches
as per their remote repository, you should run git fetch
first.
Installation
You’ll need Ruby (v3.1.0 or greater) installed. Run:
gem install git_curate
to install the executable.
Note git_curate
uses the rugged library, which comes with a
native C extension, libgit2
. Installation via gem install git_curate
will trigger this extension
to be compiled; this may take a few minutes, depending on your machine.
If you receive an error like ERROR: Failed to build gem native extension
, it’s probably because
your system lacks certain prerequisites needed for building libgit2
, for example cmake
. To fix this,
first follow the installation instructions for rugged; then
run gem install git_curate
again.
Usage
From within a git repo, run:
git curate
This will step you through your local branches one at a time, outputting some information about each, and asking you whether to keep or delete each branch.
At each branch, enter “k”—or simply press Enter—to keep the branch and move to the next one; or enter “d” to select the branch for deletion.
Entering “e” will end the session immediately, deleting all selected branches; and “a” will abort the session without deleting any branches. Once the final branch has been considered, any selected branches will be immediately deleted.
Note the branch you are currently on will not be included in the list, as git
does not allow you to delete
the branch you’re on. (The same applies to any branches that are currently checked out in other
worktrees.)
If you just want to view the information about your local branches without stepping through
them interactively, enter git curate --list
or git curate -l
. Your current branch will
be included in this list in this case.
You can also pass --merged
to see only those branches merged into current HEAD
; or --no-merged
to see only those branches not merged into current HEAD
.
Contributing
Bug reports and pull requests are welcome on GitHub.
To start working on git_curate
, git clone
and cd
into your fork of the repo, then run bin/setup
to
install dependencies.
To run the test suite, run bundle exec rake spec
. For a list of other Rake tasks, run bundle exec rake -T
.
License
The gem is available as open source under the terms of the MIT License.