Additional completion definitions for Zsh.
Go to file
Martin Tournoij bef2035b69
go: add zstyle to prevent listing packages from GOROOT and GOPATH
Adding all of GOROOT means all of stdlib is added as completions to many
commands, which I find rather noisy and rarely useful.

Before:

    [~/check]% go install <Tab>
    archive/    context/    fmt/        log/        regexp/     testing/
    bufio/      crypto/     go/         math/       runtime/    text/
    builtin/    database/   hash/       mime/       sort/       time/
    bytes/      debug/      html/       net/        strconv/    unicode/
    check.go    encoding/   image/      os/         strings/    unsafe/
    cmd/        errors/     index/      path/       sync/       vendor/
    compress/   expvar/     internal/   plugin/     syscall/
    container/  flag/       io/         reflect/    testdata/

After:

    [~/check]% go install <Tab>
    # completes to ./check.go, which is the only file in this small package.

Also add a setting to disable GOPATH, as it's kind deprecated and on its
way out. Sometimes I have some stuff "go get"'d in there, but I rarely
want that as completions.
2020-06-03 15:03:11 +08:00
.github #591: move CONTRIBUTING to root directory, README cleanup 2018-10-13 23:07:50 +02:00
src go: add zstyle to prevent listing packages from GOROOT and GOPATH 2020-06-03 15:03:11 +08: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 Fix typos 2020-04-09 11:51:09 +03: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 replace broken link to linux-mag with its latest archive.org backup 2020-05-02 15:47:16 -03: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.