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,251 Commits 3 Branches 39 Tags 4.3 MiB
Shell 94.1%
Python 5.1%
Emacs Lisp 0.8%
Go to file
Shohei YOSHIDA 578d1d59c2
Merge pull request #697 from dancek/git-revise 
Add completion for git-revise
 		2020-04-08 23:20:19 +09:00
.github #591: move CONTRIBUTING to root directory, README cleanup 2018-10-13 23:07:50 +02:00
src Merge pull request #697 from dancek/git-revise 2020-04-08 23:20:19 +09:00
.editorconfig Add EditorConfig file denoting indentation style. 2012-06-25 00:46:52 +08:00
.gitignore git ignore some IDE files 2018-11-04 14:27:35 +01:00
CONTRIBUTING.md Delete some compdefs that have been included in zsh (thanks @okapia) 2018-11-04 14:36:19 +01: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 change os name: Mac OS to macOS (#656) 2020-01-17 14:35:38 -08:00
zsh-completions-howto.org Fix typo 2018-12-09 16:23:58 +01: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.

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

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.