2011-07-20 12:38:50 +00:00
zsh-completions
===============
**Additional completion definitions for [Zsh ](http://www.zsh.org ).**
2011-07-31 18:04:09 +00:00
*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts are meant to be contributed to the Zsh project when stable enough.*
2011-07-20 12:38:50 +00:00
Status
------
2013-02-27 02:13:49 +00:00
See [issues ](https://github.com/zsh-users/zsh-completions/issues ) for details on each completion definition.
2011-07-20 12:38:50 +00:00
2014-11-21 12:02:05 +00:00
Gentoo's completions have been removed, as they are maintained upstream. See: [Gentoo zsh-completions ](https://github.com/radhermit/gentoo-zsh-completions )
2011-07-20 12:38:50 +00:00
Usage
-----
2011-10-12 20:34:01 +00:00
#### Using packages
2014-01-09 00:35:16 +00:00
* Arch Linux: [community/zsh-completions ](https://www.archlinux.org/packages/zsh-completions ) / [AUR/zsh-completions-git ](https://aur.archlinux.org/packages/zsh-completions-git/ )
2014-11-21 12:02:05 +00:00
* [Gentoo ](http://packages.gentoo.org/package/app-shells/zsh-completions )
2016-07-30 14:08:56 +00:00
* Mac OS: [Homebrew ](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zsh-completions.rb )
2012-08-01 11:21:33 +00:00
* 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 !
2011-12-03 18:50:36 +00:00
2014-10-06 00:20:00 +00:00
#### Using frameworks
2016-06-30 21:30:58 +00:00
* If you're using [antigen ](https://github.com/zsh-users/antigen ), just add `antigen bundle zsh-users/zsh-completions` to your .zshrc where you're loading your other zsh plugins.
2014-10-06 00:20:00 +00:00
2011-10-12 20:34:01 +00:00
#### Manual installation
2011-07-31 18:04:09 +00:00
* Clone the repository:
2011-07-21 22:35:27 +00:00
2011-07-31 18:04:09 +00:00
git clone git://github.com/zsh-users/zsh-completions.git
2011-10-12 20:34:01 +00:00
* Include the directory in your `$fpath` , for example by adding in `~/.zshrc` :
2011-07-31 18:04:09 +00:00
2012-08-01 11:30:37 +00:00
fpath=(path/to/zsh-completions/src $fpath)
2011-07-31 18:04:09 +00:00
2011-10-12 20:34:01 +00:00
* You may have to force rebuild `zcompdump` :
rm -f ~/.zcompdump; compinit
2011-07-31 18:04:09 +00:00
2015-01-31 14:09:24 +00:00
#### oh-my-zsh
If you use [oh-my-zsh][] then just clone the repository inside your oh-my-zsh repo:
```Shell
git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions
```
2016-06-27 12:56:08 +00:00
and enable it in your `.zshrc` by adding it to your plugin list and reloading the completion:
2015-01-31 14:09:24 +00:00
```zsh
2016-06-27 12:56:08 +00:00
plugins=(… zsh-completions)
2015-01-31 14:09:24 +00:00
autoload -U compinit & & compinit
```
[oh-my-zsh]: http://github.com/robbyrussell/oh-my-zsh
2011-07-31 18:04:09 +00:00
Contributing
------------
Contributions are welcome, just make sure you follow the guidelines:
2016-02-04 22:02:26 +00:00
* Completions are not accepted when already available in zsh.
2014-07-16 20:14:17 +00:00
* Completions are not accepted when already available in their original project.
2014-07-16 19:35:49 +00:00
* Please do not just copy/paste someone else completion, ask before.
* Completions only partially implemented are not accepted.
2013-02-07 00:55:37 +00:00
* Please add a header containing authors, license info, status and origin of the script (example [here ](src/_ack )).
2011-07-31 18:04:09 +00:00
* Please try to follow [Zsh completion style guide ](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide ).
2016-02-04 22:02:26 +00:00
* Please send one separate pull request per file.
2011-07-31 18:04:09 +00:00
* Send a pull request or ask for committer access.
2011-07-20 12:38:50 +00:00
License
-------
See each file for license details.
