Adding Git Completion to Zsh

Adding Git Completion to Zsh

Oliver Spryn
November 7, 2018

Easily setup completion for Git using the project’s official scripts for Zsh.

I recently switched my shell from Bash to Zsh, and after installing my new favorite extensions (Powerlevel10k and Meslo Nerd Font), I realized I was missing a key component from Bash: Git completion.

Since we don’t all have the luxury of running `brew install bash-completion` and following the associated directions, I’ll discuss how I manually installed the shell scripts necessary to support Git completion in Zsh.

Finding the Dependencies

The Git community maintains all the shell completion scripts in their repository on GitHub. Navigating to this folder reveals scripts for a variety of shells, including Bash and Zsh.

Git's shell completion scripts on GitHub
Git’s shell completion scripts on GitHub

Since both Bash and Zsh are based on the Bourne shell, they tend to share many similarities. Git makes this pretty evident after one opens the `git-completion.zsh` and the comment at the top states:

You need git’s bash completion script installed somewhere, by default it would be the location bash-completion uses.

Thus, we need two scripts to have Git completion in its entirety.

Downloading the Scripts

Now that it is clear which scripts are necessary for full Git completion functionality, let’s get them:

Notice how, by convention, I placed the shell scripts in a folder called `.zsh` under the user’s home folder.

Configuring the Shell

Once the scripts are in position, the `.zshrc` file may be configured to provide access to their functionality. Open up the `~/.zshrc` file and add the following lines of code:

On your first run, make sure you clear out the shell’s autocompletion cache with:

Then save the script, reload your shell, and voila!

An animation showing the result of the configuration
The result of the configuration (along with some Powerlevel10k polish)

For the curious reader, here’s a quick summary of what the above configuration script accomplishes:

  • `zstyle`: Instructs the shell on how to provide inline, contextual hints
  • `fpath`: The `git-completion.zsh` is a function file, not designed to be sourced like the bash script. This command appends the `~/.zsh` directory onto the shell’s function lookup list.
  • `autoload`: Scan each path within the `fpath` variable for files starting with an underscore (`_git,` in our case) and loads the corresponding script as a function file
  • `compinit`: Initializes the shell’s auto-completion functionality


These links proved themselves immensely helpful as I learned how to understand and configure this on my own:

Oliver Spryn

I'm teaching 100k how to fast-track their Android development process to build chart-topping apps the right way, the first time. Subscribe on Twitter or LinkedIn for daily engineering tips and on YouTube for weekly in-depth Android tutorials.

YouTube logoTwitter logoLinkedIn logo
Go Further

Jump ahead 5 years, right now

Build your next Android app in less time, the right way, the first time

Free 15-min consult

1 on 1 assitance

Access premium courses

Get Access