A CLI interface to git that relies heavily on
0.21.0 or higher).
You can run
git add and
git reset by selecting or cursoring. You can commit interactively.
You can search the diff from the query bar and the RHS diff will be highlighted accordingly.
Search the log and corresponding diff at once. Notice that when you use
| the left hand side is sent to
log while the right hand side is sent to
fzf is required:
brew install fzf
git clone https://github.com/bigH/git-fuzzy.git # add the executable to your path echo "export PATH=\"$(pwd)/git-fuzzy/bin:\$PATH\"" >> ~/.bashrc
git clone https://github.com/bigH/git-fuzzy.git # add the executable to your path echo "export PATH=\"$(pwd)/git-fuzzy/bin:\$PATH\"" >> ~/.zshrc
Alternatively, you can use a plugin manager:
.zshrc file with the following line:
antibody bundle bigH/git-fuzzy path:bin kind:path
Run the following on the command line:
znap install bigH/git-fuzzy
zplug "bigH/git-fuzzy", as:command, use:"bin/git-fuzzy"
zinit ice as"program" pick"bin/git-fuzzy" zinit light bigH/git-fuzzy
git clone https://github.com/bigH/git-fuzzy.git # add the executable to your path echo "set -x PATH (pwd)\"/git-fuzzy/bin:\$PATH\"" >> ~/.config/fish/config.fish
Simply install and run
git fuzzy and you can begin using the menu.
git fuzzy status(or
Interact with staged and unstaged changes.
git fuzzy branch(or
Search for, checkout and look at branches.
git fuzzy log(or
Look for commits in
git log. Typing in the search simply filters in the usual
git fuzzy reflog(or
Look for entries in
git reflog. Typing in the search simply filters in the usual
git fuzzy stash(or
Look for entries in
git stash. Typing in the search simply filters in the usual
git fuzzy diff(or
Interactively select diff subjects. Drilling down enables searching through diff contents in a diff browser.
git fuzzy pr(or
Interactively select and open/diff GitHub pull requests.
All items from the menu can be accessed via the CLI by running
git fuzzy <command>. Many of the commands simply pass on additional CLI args to the underlying commands. (e.g.
git fuzzy diff a b -- XYZ uses the args you provided in the listing and preview)
git command output is used in preview or listing, there is a header with the command run (useful for copy-pasting or just knowing what's happening). You can optionally enable debugging switches to see other commands being run in the background or how commands are routed.
For the ideal experience, install:
git fuzzy diff uses
grep to highlight your search term. The default may clash with
diff formatting or just not be to your liking. You can configure
git fuzzy without affecting the global setting.
GF_PREFERRED_PAGER is used as a way to decorate diffs. Otherwise,
delta are tried before using raw diffs. Remember to adequately quote this value as it's subject to string splitting.
export GF_PREFERRED_PAGER="delta --theme=gruvbox --highlight-removed -w __WIDTH__"
bat is used for highlighting. You can choose different defaults in
git fuzzy if you so desire.
# set them for `git fuzzy` only export GF_BAT_STYLE=changes export GF_BAT_THEME=zenburn # OR set these globally for all `bat` instances export BAT_STYLE=changes export BAT_THEME=zenburn
You may often want to use a different branch and remote to use as your "merge-base" in
git fuzzy. The default is
export GF_BASE_REMOTE=upstream export GF_BASE_BRANCH=main
You may want the diff search to behave differently in
git fuzzy diff (this doesn't apply to
log or any other command that uses
diff). The query will be quoted by
fzf and provided as the next argument. In the default case, that means
-G <query>. The default is
export GF_DIFF_SEARCH_DEFAULTS="--pickaxe-regex -S"
You may want custom formats for your
reflog experience. This is hidden from the command headers to save room and enable freedom in formatting parameters. Remember to adequately quote this value as it's subject to string splitting. If you have trouble quoting formats, you can use a pretty format alias (see
man git-config) The default is
# for `git fuzzy log` export GF_LOG_MENU_PARAMS='--pretty="%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset" --topo-order' # for `git fuzzy reflog` export GF_REFLOG_MENU_PARAMS='--pretty=fuzzyformat'
You can also configure various
git commands' default args in various contexts. This is hidden from the command headers to save room and enable freedom in formatting parameters. Remember to adequately quote this value as it's subject to string splitting. These are not set by default.
# when diffing with branches or commits for preview export GF_DIFF_COMMIT_PREVIEW_DEFAULTS="--patch-with-stat" # when diffing with branches or commits for preview export GF_DIFF_COMMIT_RANGE_PREVIEW_DEFAULTS="--summary" # when diffing individual files export GF_DIFF_FILE_PREVIEW_DEFAULTS="--indent-heuristic"
If you use vertical terminals/windows often, you may want to configure the threshold for switching to a vertical view. This ratio is calculated by running
"__WIDTH__ / __HEIGHT__ > $GF_VERTICAL_THRESHOLD". This is calculated using GNU
bc. The default is
export GF_VERTICAL_THRESHOLD="1.7 * __HEIGHT__ / 80"
You can also configure how the size of the preview window is calculated. They're calculated using GNU
bc. Try using Desmos to tweak the calculation. The defaults are more complex than shown below.
# use __WIDTH__ for horizontal scenarios export GF_HORIZONTAL_PREVIEW_PERCENT_CALCULATION='max(50, min(80, 100 - (7000 / __WIDTH__)))' # use __HEIGHT__ for horizontal scenarios export GF_VERTICAL_PREVIEW_PERCENT_CALCULATION='max(50, min(80, 100 - (5000 / __HEIGHT__)))'
In cases where you are using a particularly small terminal, you can configure the following calculations to determine when to hide extraneous things. Note that both defaults use
# use __WIDTH__ for horizontal scenarios export GF_HORIZONTAL_SMALL_SCREEN_CALCULATION='__HEIGHT__ <= 30' # use __HEIGHT__ for horizontal scenarios export GF_VERTICAL_SMALL_SCREEN_CALCULATION='__HEIGHT__ <= 60'
You may want to customize the default keyboard shortcuts. There are many configuration options available. Here's an example:
If you are using nano as your default editor, you need to pass
/dev/tty as stdin otherwise you may receive an error similar to
Too many errors from stdintor to close the file...:
git config --global core.editor 'nano < /dev/tty'
git fuzzy takes a backup of your current sha, branch, index diff, unstaged diff and new files. This is helpful in case you take an action hastily (like discarding a file you meant to stage) or there is a bug. If you'd like snapshots, simply set the variable below. I have the following entry in my
.zshrc (with corresponding
# a directory in the repository is perfectly fine export GF_SNAPSHOT_DIRECTORY='./git-fuzzy-snapshots'
bc programs are all run with some useful functions defined (
max). If you'd like to add any others, you can do so. This is not set by default.
# defining your own function: export GF_BC_LIB='my_favorite_variable = 3.14159;'
git fuzzy sources
./git-fuzzy-config if it's present. You can add the following to your
~/.gitignore_global to avoid having to worry about
git picking it up:
This file is sourced at the end, so you can build on top of existing or default configurations:
# make the preview bigger, but keep the flexibility export GF_HORIZONTAL_PREVIEW_PERCENT_CALCULATION='(80 + $GF_HORIZONTAL_PREVIEW_PERCENT_CALCULATION) / 2'
Why does the UI flash?
execute from the
fzf man page states that
fzf switches to the alternate screen when executing a command. I've filed this issue, which should enable making the transitions smoother.
Stability & Hacking
I built this for myself and it's working reasonably well.
That being said, I've gone through great pains to polish existing functionality to work pretty nicely. I've made it easy to develop or change features by using debug output to check behavior. All debug output goes to
/dev/stderr, so you can hack on this while using it in pipes and in your
bash readline shortcuts.
These variables are considered
true if they are non-empty.
# debugging information export GF_DEBUG_MODE="YES" # commands run by the program (those without headers) export GF_COMMAND_DEBUG_MODE="YES" # fzf commands run by the program export GF_COMMAND_FZF_DEBUG_MODE="YES" # log output of commands run by `git fuzzy` export GF_COMMAND_LOG_OUTPUT="YES" # log internal commands (pretty noisy) export GF_INTERNAL_COMMAND_DEBUG_MODE="YES"