Additional completion definitions for Zsh.
Go to file
Ondřej Svoboda 9a7bf55661 yaourt: support .pkg.tar extension
pacman's completion already supports this extension so just follow suit.

Motivation: makepkg produces packages (e.g. from AUR) without compression
with its PKGEXT='.pkg.tar' setting, which speeds up building and installing
them manually.
2017-01-02 14:10:27 +01:00
src yaourt: support .pkg.tar extension 2017-01-02 14:10:27 +01:00
.editorconfig Add EditorConfig file denoting indentation style. 2012-06-25 00:46:52 +08:00
.gitignore ignore *.zwc 2012-08-01 13:27:59 +02:00
README.md Add RPM installation info 2016-12-28 00:00:57 +01:00
zsh-completions-howto.org Completion for ps command, for iw and a how-to guide for creating 2014-04-12 12:53:41 +02:00
zsh-completions.plugin.zsh Made it a oh-my-zsh plugin and documented how to use it. 2015-01-31 15:26:35 +01:00

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 !
Fedora/RHEL/CentOS copr: nicoulaj/zsh-completions
Arch Linux zsh-completions, zsh-completions-git
Gentoo app-shells/zsh-completions
NixOS 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.