Additional completion definitions for Zsh.
Shell
Latest commit fd176b1 Dec 2, 2016 @nicoulaj nicoulaj committed on GitHub Merge pull request #471 from ViktorHaag/ag-past-version-one
fix version logic for major version > 0

README.md

zsh-completions GitHub release GitHub contributors IRC

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.

Status

See issues for details on each completion definition.

Usage

Using packages

System Package
Debian based distributions (Debian/Ubuntu/Linux Mint...) Packager needed, please get in touch !
RPM based distributions (Fedora/RHEL/CentOS...) Packager needed, please get in touch !
Arch Linux zsh-completions, zsh-completions-git
Gentoo app-shells/zsh-completions
Mac OS homebrew

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 ~/.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, just make sure you follow the guidelines:

  • Completions are not accepted when already available in zsh.
  • Completions are not accepted when already available in their original project.
  • Please do not just copy/paste someone else completion, ask before.
  • Completions only partially implemented are not accepted.
  • Please add a header containing authors, license info, status and origin of the script (example here).
  • Please try to follow Zsh completion style guide.
  • Please send one separate pull request per file.
  • Send a pull request or ask for committer access.

License

See each file for license details.