Skip to content

tony-sol/zsh-completions

 
 

Repository files navigation

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

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

  • 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).

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.

About

Additional completion definitions for Zsh.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • Shell 100.0%