zsh-users/zsh-completions

zsh-completions

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.

---

Usage

Using packages

---

Using zsh frameworks

antigen

Add antigen bundle zsh-users/zsh-completions to your ~/.zshrc.

oh-my-zsh

To avoid issues with redundant .zcompdump cache generation (see #603), do not load zsh-completions as a standard plugin.
Instead, follow this optimized approach:

1. 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

2. Update your ~/.zshrc configuration 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.

zinit

Add zinit light zsh-users/zsh-completions to your ~/.zshrc.

---

Manual installation

• 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; compinit

---

Contributing

Contributions are welcome, see CONTRIBUTING.

---

License

Completions use the Zsh license, unless explicitly mentioned in the file header.
See LICENSE for more information.