Git Fury

A lightweight git utility that enables shorthand git syntax to sharpen your git fu and increase productivity.

• Manage Branch Descriptions
• Alphabetic characters (a-zz) represent branch names
• Numeric characters (0-999) are prepended with HEAD~

Table of Contents

• Installation
• Configuration
• Demo
• Usage
• Tips

Installation

Any of the following methods can be used to install git-fury.

Homebrew

brew install greghuels/tap/git-fury

Manual Download

1. Download the latest binary for your computer's architecture (latest release)
2. Grant executable permissions. Example: chmod +x ~/Downloads/git-fury-aarch64-unknown-linux-gnu
3. Rename to "git-fury" and make available to PATH. Example: mv ~/Downloads/git-fury-aarch64-unknown-linux-gnu /usr/local/bin/git-fury

Building from Source

1. Download and unpack the source code from the latest release
2. cd to unpacked directory
3. Build source: deno compile --allow-run ./mod.ts (using deno)
4. Move binary: mv ./git-fury /usr/local/bin

Configuration

Setting Aliases (recommended)

git config --global alias.br 'fury branch'
git config --global alias.co 'fury checkout'
git config --global alias.cp 'fury cherry-pick'
git config --global alias.df 'fury diff'
git config --global alias.ds 'fury desc' # custom "git-fury" command to set and delete branch descriptions
git config --global alias.lg 'fury log --graph --oneline --pretty=format:"%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset"'
git config --global alias.mg 'fury merge'
git config --global alias.ps 'fury push'
git config --global alias.rb 'fury rebase'
git config --global alias.rs 'fury reset'

Any git command works with git fury, not just those listed above. Feel free to configure aliases as you see fit.

Demo

Usage

TIP: Add the --dry-run option on any git fury command to see which git command would be executed, but without actually executing it. This also works if aliases are set up.

Shorthand Syntax

• Alphabetic characters (a-zz) represent branch names
• Numeric characters (0-999) are prepended with HEAD~

## Without aliases configured
git fury diff 2 1         # git diff HEAD~2 HEAD~1

## With aliases configured
git co b                  # git checkout some-branch
git df 2 1                # git diff HEAD~2 HEAD~1
git rb --onto origin/a 1  # git rebase --onto origin/main HEAD~1
git ps . origin/a~1:a     # git push . origin/main~1:main

## Hashes and branch names still work!
git co 17c422g            # git checkout 17c422g
git co some-branch        # git checkout some-branch

Supported Transformations

Clause	Transformation
a	main
1	HEAD~1
origin/a	origin/main
origin:a	origin:main
a~1	main~1
a^1	main^1
a..b	main..some-branch
a...b	main...some-branch

Unsupported Transformations

Clause	Transformation
a.b	a.b
--source=a	--source=a

Manage Branch Descriptions

Branch descriptions allow you to add notes to branches.

## Without 'ds' alias configured
git fury desc 'My description'

## With 'ds' alias configured
git ds 'My description'   # Set description for current branch
git ds -s                 # Show description for current branch
git ds -D                 # Delete description for current branch

git ds a 'My description' # Set description for branch (a)
git ds a -s               # Show description for branch (a)
git ds a -D               # Delete description for branch (a)

Tips

• Add the --dry-run option on any git fury command to see which git command would be executed, but without actually executing it. This also works if aliases are set up.
• It's useful to set the branch description to a URL (e.g. a pull request, user story, bug ticket, etc).
• Mac users using iTerm2 can open a branch description formatted as a URL using cmd+click.
• Tired of typing git? Use bash aliases instead.

Only Want Branch Descriptions?

git-fury commands are opt-in, so you only have to set aliases for commands you want to use. For branch descriptions, set the following aliases:

git config --global alias.br 'fury branch'
git config --global alias.ds 'fury desc'