Skip to content

zsh += vcs_info and native completion #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ben merged 2 commits into from
Oct 27, 2015
Merged

zsh += vcs_info and native completion #440

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30ab202
Grammaro
danielshahaf Sep 27, 2015
42891b4
zsh: Mention vcs_info and built-in _git completion.
danielshahaf Sep 27, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions book/A-git-in-other-environments/sections/zsh.asc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=== Git in Zsh

(((zsh)))(((tab completion, zsh)))(((shell prompts, zsh)))
Git also ships with a tab-completion library for Zsh.
Just copy `contrib/completion/git-completion.zsh` to your home directory and source it from your `.zshrc`.
Zsh also ships with a tab-completion library for Git.
To use it, simply run `autoload -Uz compinit && compinit` in your `.zshrc`.
Zsh's interface is a bit more powerful than Bash's:

[source,console]
Expand All @@ -17,24 +17,36 @@ cherry-pick -- apply changes introduced by some existing commits
----

Ambiguous tab-completions aren't just listed; they have helpful descriptions, and you can graphically navigate the list by repeatedly hitting tab.
This works with Git commands, their arguments, and names of things inside the repository (like refs and remotes), as well filenames and all the other things Zsh knows how to tab-complete.
This works with Git commands, their arguments, and names of things inside the repository (like refs and remotes), as well as filenames and all the other things Zsh knows how to tab-complete.

Zsh happens to be fairly compatible with Bash when it comes to prompt customization, but it allows you to have a right-side prompt as well.
To include the branch name on the right side, add these lines to your `~/.zshrc` file:
Zsh ships with a framework for getting information from version control systems, called `vcs_info`.
To include the branch name in the prompt on the right side, add these lines to your `~/.zshrc` file:

[source,console]
----
autoload -Uz vcs_info
precmd_vcs_info() { vcs_info }
precmd_functions+=( precmd_vcs_info )
setopt prompt_subst
. ~/git-prompt.sh
export RPROMPT=$'$(__git_ps1 "%s")'
RPROMPT=\$vcs_info_msg_0_
# PROMPT=\$vcs_info_msg_0_'%# '
zstyle ':vcs_info:git:*' formats '%b'
----

This results in a display of the current branch on the right-hand side of the terminal window, whenever your shell is inside a Git repository.
(The left side is supported as well, of course; just uncomment the assignment to PROMPT.)
It looks a bit like this:

.Customized `zsh` prompt.
image::images/zsh-prompt.png[Customized `zsh` prompt.]

For more information on vcs_info, check out its documentation
in the `zshcontrib(1)` manual page,
or online at http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Version-Control-Information[].

Instead of vcs_info, you might prefer the prompt customization script that ships with Git, called `git-prompt.sh`; see http://git-prompt.sh[] for details.
`git-prompt.sh` is compatible with both Bash and Zsh.

Zsh is powerful enough that there are entire frameworks dedicated to making it better.
One of them is called "oh-my-zsh", and it can be found at https://github.com/robbyrussell/oh-my-zsh[].
oh-my-zsh's plugin system comes with powerful git tab-completion, and it has a variety of prompt "themes", many of which display version-control data.
Expand Down