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,990 Commits 1 Branch 39 Tags 4.1 MiB
Shell 93.8%
Python 5.3%
Emacs Lisp 0.9%
Go to file
Jesse Ayala d326bdc241
Fix error when no matching files in working dir 
If there are no files in the current working directory, zparse opts complains with "missing argument for option: -g"

Co-authored-by: Shohei YOSHIDA <syohex@gmail.com>
 		2025-06-11 20:17:41 -04:00
.github Remove empty issue template 2025-03-12 19:39:41 +09:00
src Fix error when no matching files in working dir 2025-06-11 20:17:41 -04: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 Improve oh-my-zsh install instructions to avoid compinit duplication (fixes #603) 2025-04-10 20:04:49 +02: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 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

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

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