xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Additional completion definitions for Zsh.
1,973 Commits 1 Branch 39 Tags 3.6 MiB
Shell 93.6%
Python 5.5%
Emacs Lisp 0.9%
Go to file
Sumathi Dhanasekaran 3dc13483c1
Update README.md - Zsh rebuilding the completion cache twice 
Zsh rebuilding the completion cache twice
 		2025-03-13 13:28:59 +00:00
.github Remove empty issue template 2025-03-12 19:39:41 +09:00
src Merge pull request #1125 from egorlem/TS-5.7-5.8 2025-03-04 16:26:40 +09:00
.editorconfig Update links 2022-11-23 13:31:48 +09:00
.gitignore git ignore some IDE files 2018-11-04 14:27:35 +01:00
CONTRIBUTING.md Fix typos 2020-04-09 11:51:09 +03:00
LICENSE Change default license to the Zsh license (as discussed on zsh-workers mailing-list) 2017-10-19 19:54:32 +02:00
README.md Update README.md - Zsh rebuilding the completion cache twice 2025-03-13 13:28:59 +00:00
zsh-completions-howto.org Update links 2022-11-23 13:31:48 +09:00
zsh-completions.plugin.zsh fix: entrypoint fpath expansion 2021-12-01 12:08:52 +06:00

README.md

zsh-completions GitHub release GitHub contributors IRC Gitter

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.

Usage

Using packages

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

Using zsh frameworks

antigen

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

oh-my-zsh

  • Clone the repository inside your oh-my-zsh repo:

      git clone https://github.com/zsh-users/zsh-completions ${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions

  • Add it to FPATH in your .zshrc by adding the following line before source "$ZSH/oh-my-zsh.sh":

      fpath+=${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions/src

Note: adding it as a regular Oh My ZSH! plugin will not work properly (see #603).

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

Second Solution: zsh-completions as a plugin, they suggest manually adding its source directory to fpath before sourcing oh-my-zsh.sh. This ensures Zsh loads the completion files only once, improving performance. Recommended Fix: Instead of the existing method, they propose adding this line:

fpath=($ZSH/custom/plugins/zsh-completions/src $fpath)

Contributing

Contributions are welcome, see CONTRIBUTING.

License

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