Additional completion definitions for Zsh.
This projects 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.
See issues for details on each completion definition.
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 | zsh-completions, zsh-completions-git |
Gentoo | app-shells/zsh-completions |
NixOS | zsh-completions |
Void Linux | zsh-completions |
Mac OS | homebrew |
Add antigen bundle zsh-users/zsh-completions
to your ~/.zshrc
.
-
Clone the repository inside your oh-my-zsh repo:
git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions
-
Enable it in your
.zshrc
by adding it to your plugin list and reloading the completion:plugins=(… zsh-completions) autoload -U compinit && compinit
-
Clone the repository:
git clone git://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; compinit
Contributions are welcome, just make sure you follow the guidelines:
- Completions are not accepted when already available in zsh.
- Completions are not accepted when already available in their original project.
- Please do not just copy/paste someone else completion, ask before.
- Completions only partially implemented are not accepted.
- Please add a header containing authors, status and origin of the script and license header if you do not wish to use the Zsh license (example here).
- Please try to follow Zsh completion style guide.
- Please send one separate pull request per file.
- Send a pull request or ask for committer access.
Completions use the Zsh license, unless explicitely mentionned in the file header. See LICENSE for more information.