A ZSH plugin that wraps git operations for simplicity and productivity. Also, it contains completions and combines the FZF tool to make the operations more convenient.
You can find my plugin listed among other useful plugin in the awesome-zsh-plugins repository!
- Benefits
- Dependencies
- Installation
- Usage
- Supported operations
- Properties
- ZSH preferred keybinds
- Hooks
- Contribution
- License
- Interactive
- Simplicity and Productivity
- Plugin completions. After typing
git-fzf
,gfzf
orgf
, pressTAB
to view the completions (Demo) - git worktree
- Simpler API
- No need to
cd
around. After you have created a git worktree you will be moved into it - You will never stash your changes again
- Git version: 2.34.1
- fzf: This tool will be installed by the installation script
- Install Plugin
wget -q https://raw.githubusercontent.com/alexiszamanidis/zsh-git-fzf/master/install -O install && \
chmod +x install && \
./install && \
rm -rf ./install
- Add plugin to plugin list
- Open .zshrc(e.g. code .zshrc, vim .zshrc)
- Add plugin to plugin list
plugins=(... zsh-git-fzf)
- Restart your shell or reload config file(source ~/.zshrc)
After installing the plugin you can execute git-fzf help to check the operations that are provided:
-
git-fzf branch
Search for both local and remote branches (Demo)
-
git-fzf checkout
Search for a branch and checkout into it (Demo)
-
git-fzf diff
Show changes between commits, commit and working tree, etc
-
git-fzf stash
Show stash entities
-
git-fzf reflog
Show reflog entities
-
git-fzf log
Show commit logs
-
git-fzf worktree [worktree-operation]
add
- Create a new worktree:
- Run the following command:
git-fzf worktree add
- After executing the command above, select a working tree from the fzf results and it will create a new worktree for you checked out from the remote branch you selected
- if you do not select a new branch(ENTER), it will create a new worktree with the remote branch you typed. This was made for convenience, instead of having
git worktree add master master
, you can just rungit worktree add master
- if you do not select a new branch(ENTER), it will create a new worktree with the remote branch you typed. This was made for convenience, instead of having
- Run the following command:
remove
-
Remove a worktree
- Run the following command:
git-fzf worktree remove
- After executing the command above, select a working tree from the fzf results and the selected worktree will be removed
Restrictions
- You cannot delete the same Worktree as the one you are currently working on
- Run the following command:
list
- List all worktrees
- Run the following command:
git-fzf worktree list
- After executing the command above, close the fzf by pressing
ESC
- Run the following command:
- Switch worktree
- Run the following command:
git-fzf worktree list
- After executing the command above, select a working tree from the fzf results and you will be moved into the selected working tree
- Run the following command:
clean
- Removes all working trees that do not have a corresponding remote repository
- Create a new worktree:
You can add the following properties to your .zshrc file:
Property | Type | Default value | Description |
---|---|---|---|
ZSH_GIT_FZF_REMOVE_STALLED_BRANCHES | string | false | Removes local(stalled) branches that do not exist on remote |
Include the code below in your .zshrc file
bindkey -s ^o "git-fzf checkout\n"
bindkey -s ^l "git-fzf log\n"
bindkey -s ^d "git-fzf diff\n"
If you want to execute automatically some code after executing any of the operations below, you can by adding each of the following hooks to your .bashrc(.zshrc, dotfiles, etc).
checkout
# Arguments
# - $1: branch name
# - $2: current path
# Example
zsh_git_fzf_on_checkout() {
BRANCH_NAME=$1
if [[ "$BRANCH_NAME" = "master" ]]
then
# code
elif [[ "$BRANCH_NAME" = "dev" ]]
then
# code
fi
PWD=$2
PROJECT_NAME_1='project-name-1'
PROJECT_NAME_2='project-name-2'
if [[ "$PWD" == *"$PROJECT_NAME_1"* ]]
then
# code
elif [[ "$PWD" == *"$PROJECT_NAME_2"* ]]
then
# code
fi
}
worktree
# Arguments
# - $1: worktree operation("add", "remove", "list")
# Rest arguments based on the worktree operation
# - "add":
# - $2: path where worktree created
# - $3: branch name
# - "remove":
# - $2: path where worktree deleted
# - "list":
# - $2: path you switched to
# - $3: previous worktree path
# Example
zsh_git_fzf_on_worktree_operation() {
IS_BARE_REPO=$(git rev-parse --is-bare-repository)
if [ $IS_BARE_REPO = "true" ]; then
return 1
fi
WORKTREE_OPERATION=$1
if [[ "$WORKTREE_OPERATION" = "list" ]]
then
# code
elif [[ "$WORKTREE_OPERATION" = "add" ]]
then
# code
elif [[ "$WORKTREE_OPERATION" = "remove" ]]
then
# code
fi
PWD=$2
PROJECT_NAME_1='project-name-1'
PROJECT_NAME_2='project-name-2'
if [[ "$PWD" == *"$PROJECT_NAME_1"* ]]
then
# code
elif [[ "$PWD" == *"$PROJECT_NAME_2"* ]]
then
# code
fi
}
- Reporting a bug
- Improving this documentation
- Writing tests
- Sharing this project and recommending it to your friends
- Giving a star on this repository
- TODO