Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

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:=~/.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
    

Manual installation

  • 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
    

Contributing

Contributions are welcome, see CONTRIBUTING.

License

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