Probably the sharpest git repository organizer & rebase workflow automation tool you've ever seen
Project description
git-machete
git machete is a versatile tool for organizing your git repo, including features like:
- Neat, customizable
git machete status
that shows what branches are in sync with their parent branch/remote tracking branch and which of them need to be rebased/pulled/pushed
- Semi-automatic traversal of the branches that helps you effortlessly rebase and push/pull the branches you care for (
git machete traverse
)
- Automatic discovery of branch relations (
git machete discover
)
Install
We suggest a couple of alternative ways of installation.
Bash and zsh completion scripts are provided in completion/ directory, see wiki for their installation instructions.
git-machete works under both Python 2.7 and Python 3.x.
Using Homebrew (macOS)
brew tap VirtusLab/git-machete
brew install git-machete
Using PPA (Ubuntu)
Tip: run sudo apt-get install -y software-properties-common
first if add-apt-repository
is not available on your system.
sudo add-apt-repository ppa:virtuslab/git-machete
sudo apt-get update
sudo apt-get install -y python3-git-machete
Using AUR (Arch Linux)
Install the AUR package git-machete using an AUR helper of your preference.
Using Nix (macOS & most Linux distributions)
On macOS and most Linux distributions, you can install via Nix:
nix-channel --add https://nixos.org/channels/nixos-unstable unstable # if you haven't set up any channels yet
nix-env -i git-machete
Using pip with sudo (system-wide install)
You need to have Python and pip
installed from system packages.
sudo -H pip install --system git-machete
Using pip without sudo (user-wide install)
You need to have Python and pip
installed from system packages.
pip install git-machete
Please verify that your PATH
variable has ${HOME}/.local/bin/
included.
Using make with sudo (deprecated)
Run the following commands to install git machete:
git clone --depth=1 https://github.com/VirtusLab/git-machete.git
cd git-machete
sudo make install
Quick start
cd your-repo/
git machete discover --checked-out-since='2 weeks ago' # increase/decrease the timespan if you want more/less old branches included
# (see and possibly edit the suggested layout of branches - branch layout is always kept as text file .git/machete)
git machete go root
git machete traverse
# (put each branch one by one in sync with its parent and remote counterpart)
Reference
Take a look at https://medium.com/virtuslab/make-your-way-through-the-git-rebase-jungle-with-git-machete-e2ed4dbacd02 for a guide on how to use the tool.
The more advanced features like automated traversal, upstream inference and tree discovery are described in the second part of the series: https://medium.com/virtuslab/git-machete-strikes-again-traverse-the-git-rebase-jungle-even-faster-with-v2-0-f43ebaf8abb0.
Contribute
To develop that project and run tests locally it is needed to have Python installed with tox
.
Use tox -e venv
to setup virtual environment to work on that project in your favorite IDE. Use .tox/venv/bin/python
as a reference python
interpreter in your IDE.
To run tests execute command tox
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for git_machete-2.12.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5adee49a1038bcf432894ae1575fe40e88f103eb394528f03d410939cbe31e14 |
|
MD5 | cc4a0bdcad366132757f87d2a55743e4 |
|
BLAKE2b-256 | 65c45c46b970a3bc4a84923aad5cf05bca17c9afe1435043e4f5750cdc1cf4e8 |