Additional completion definitions for Zsh.
This project aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.
| System | Package |
|---|---|
| Debian / Ubuntu | zsh-completions OBS repository |
| Fedora / CentOS / RHEL / Scientific Linux | zsh-completions OBS repository |
| OpenSUSE / SLE | zsh-completions OBS repository |
| Arch Linux / Manjaro / Antergos / Hyperbola | zsh-completions, zsh-completions-git |
| Gentoo / Funtoo | app-shells/zsh-completions |
| NixOS | zsh-completions |
| Void Linux | zsh-completions |
| Slackware | Slackbuilds |
| macOS | homebrew, MacPorts |
| NetBSD | pkgsrc |
| FreeBSD | shells/zsh-completions |
Add antigen bundle zsh-users/zsh-completions to your ~/.zshrc.
To avoid issues with redundant .zcompdump cache generation (see #603), do not load zsh-completions as a standard plugin.
Instead, follow this optimized approach:
- Clone the repository into your custom plugins directory:
git clone https://github.com/zsh-users/zsh-completions.git \
${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions- Update your
~/.zshrcconfiguration before sourcing oh-my-zsh:
fpath+=${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions/src
autoload -U compinit && compinit
source "$ZSH/oh-my-zsh.sh"This prevents compinit from being called twice and significantly improves shell startup time.
Add zinit light zsh-users/zsh-completions to your ~/.zshrc.
- Clone the repository:
git clone https://github.com/zsh-users/zsh-completions.git- Include the directory in your
$fpath, for example by adding in~/.zshrc:
fpath=(path/to/zsh-completions/src $fpath)- You may have to force rebuild
zcompdump:
rm -f ~/.zcompdump; compinitContributions are welcome, see CONTRIBUTING.
Completions use the Zsh license, unless explicitly mentioned in the file header.
See LICENSE for more information.