⚠️ Note: this tool is currently in beta. As such I can't guarantee that this won't nuke your git history. Use with care.
This is a utility to help with the cleaning up of any local copies of remote deleted branches.
Often a local repository will have checked out a branch that is tracking a remote. What happens when that remote branch is deleted? Typically, it is just orphaned locally. That's where git-local-prune comes in. Running this utility will delete any branches that have been abandoned.
- This is a rust project. So ensure you have rust and cargo installed. You can find instructions here.
- run
cargo build
- Make sure you are in a
gitrepository - Update your remotes:
git fetch --prune - Make sure that you don't have any work in any deleted remotes locally that you need
- Execute:
./git-local-prune
⚠️ Note: this tool alters the contents of the.gitfolder directly. So I would recommend running agit gcafterwards. Fair warning, this is a destructive action.
- unit tests:
cargo test - functional tests:
./test/end-to-end/test.sh- this requiresbatsto be installed locally
- Q: Will this delete all my local branches?
Nope. Just the branches that previously tracked a remote. If you create an entirely fresh branch then run this utility. It will ignore this branch. - Q: Does this not just make a bunch of
gitcommands?
Nope. It will go straight to the relevant files in you.gitdirectory and make the changes there.gitis just distributed files and folders! - Q: HECK, I just deleted something I should not have! What can I do?
Ouch! If you haven't rungit gcorgit prune, you may be able to dig old commits out usinggit reflog. Otherwise, your code probably was not that good anyway. 🤷 - Q: Why not use
<insert-custom-script-here>?
Because Rust. gottagofast. Check out the benchmarking results here