zsh-autocomplete adds real-time type-ahead autocompletion to Zsh. Find as you type, then press Tab to insert the top completion, ShiftTab to insert the bottom one, or ↓/PgDn to select another completion.

• Other Features
• Key Bindings
• Requirements
• Installing & Updating
• Configuration
• Author
• License

Besides live autocompletion, zsh-autocomplete comes with many other useful completion features.

Zsh's completion system is powerful, but hard to configure. So, zsh-autocomplete does it for you, while providing a manageable list of settings for changing the defaults.

Press ControlR or ControlS to do an interactive, multi-line, fuzzy history search.

Press ↑ or PgUp to browse the last 16 history items. If the command line is not empty, then it will instead list the 16 most recent fuzzy matches.

Press ControlSpace in the completion menu or the history menu to insert more than one item.

Works out of the box with zero configuration, but also supports zsh-z, zoxide, z.lua, rupa/z.sh, autojump and fasd.

Recommended:

• Zsh 5.8 or later.

Minimum:

• Zsh 5.3 or later.

To install:

1. Clone the repo:

   % cd ~/git  # or wherever you keep your Git repos/Zsh plugins
   % git clone --depth 1 -- https://github.com/marlonrichert/zsh-autocomplete.git

2. Add to your ~/.zshrc file, before any calls to compdef:

   source ~/git/zsh-autocomplete/zsh-autocomplete.plugin.zsh

3. Remove any calls to compinit from your ~/.zshrc file.

To update:

git -C ~zsh-autocomplete pull

Instead of following the instructions above, you can also install zsh-autocomplete through whichever Zsh frameworks or plugin manager you use. Please refer to your framework's/plugin manager's documentation for instructions.

© 2020 Marlon Richert

This project is licensed under the MIT License. See the LICENSE file for details.