xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Additional completion definitions for Zsh.
1,110 Commits 1 Branch 39 Tags 3.6 MiB
Shell 93.6%
Python 5.5%
Emacs Lisp 0.9%
Go to file
Oliver Kiddle 3565da06a6 separate out contribution guidelines and mention upstream/zsh options 2018-08-26 02:19:59 +02:00
src Merge pull request #584 from grimreaper/eax/completion/macports_port_add_select 2018-08-26 00:47:12 +02: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
CONTRIBUTING.md separate out contribution guidelines and mention upstream/zsh options 2018-08-26 02:19:59 +02:00
LICENSE Change default license to the Zsh license (as discussed on zsh-workers mailing-list) 2017-10-19 19:54:32 +02:00
README.md separate out contribution guidelines and mention upstream/zsh options 2018-08-26 02:19:59 +02:00
zsh-completions-howto.org fix 404 for the nicely formatted short tutorial showing basic usage of the _arguments function 2018-04-11 22:40:45 +02:00
zsh-completions.plugin.zsh Use modifier expansion instead of dirname 2017-05-25 23:33:05 +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.

Status

See issues for details on each completion definition.

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 zsh-completions, zsh-completions-git
Gentoo app-shells/zsh-completions
NixOS zsh-completions
Void Linux zsh-completions
Mac OS homebrew, MacPorts

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

License

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