home/.zsh/plugins/zsh-completions
Christoph J. Scherr 1b0d6b0c82 zsh dir 2023-09-06 14:03:56 +02:00
..
.github zsh dir 2023-09-06 14:03:56 +02:00
src zsh dir 2023-09-06 14:03:56 +02:00
.editorconfig zsh dir 2023-09-06 14:03:56 +02:00
.gitignore zsh dir 2023-09-06 14:03:56 +02:00
CONTRIBUTING.md zsh dir 2023-09-06 14:03:56 +02:00
LICENSE zsh dir 2023-09-06 14:03:56 +02:00
README.md zsh dir 2023-09-06 14:03:56 +02:00
zsh-completions-howto.org zsh dir 2023-09-06 14:03:56 +02:00
zsh-completions.plugin.zsh zsh dir 2023-09-06 14:03:56 +02: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
    

Contributing

Contributions are welcome, see CONTRIBUTING.

License

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