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.
Enjoy using this software? Become a sponsor!.
Besides live autocompletion,
zsh-autocomplete comes with many other useful completion features.
Press CtrlR or CtrlS to do live, multi-line history search.
Press (or Alt or PgUp) to open a menu with the last 16 history items. If the command line is not empty, then the contents of the command line are used to perform a fuzzy history search.
Press CtrlSpace 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
On the command line:
| Key(s) | Action | Widget |
| ------ | ------ | --- |
| Tab | Accept top completion |
| ShiftTab | Accept bottom completion |
| CtrlSpace | Show additional completions |
| | Cursor down (if able) or completion menu |
| PgDn / Alt | Completion menu (always) |
| | Cursor up (if able) or history menu |
| PgUp / Alt | History menu (always) |
| CtrlR | Live history search, newest to oldest |
| CtrlS | Live history search, oldest to newest |
In the completion menu: | Key(s) | Action | | ------ | ------ | | / / / | Change selection | | Alt | Backward one group | | Alt | Forward one group | | PgUp / PgDn | Page up/down | | CtrlR | Full text search or previous search match | | CtrlS | Full text search or next search match | | CtrlSpace | Multi-select | | Tab | Accept selection | | ShiftTab | Accept bottom completion | | Enter | Accept command line | | most other keys | Accept selection, then perform usual action |
In the history menu: | Key(s) | Action | | --- | --- | | / | Change selection | | CtrlSpace | Multi-select | | Tab | Accept selection | | Enter | Accept command line | | most other keys | Accept selection, then perform usual action |
If you use Znap, simply add the following to your
znap source marlonrichert/zsh-autocomplete
Then restart your shell.
To update, do
% znap pull
For configuration options, see the included
To uninstall, remove
znap source marlonrichert/zsh-autocomplete from your
.zshrc file, then run
% znap uninstall
% cd ~/Git # ...or wherever you keep your Git repos/Zsh plugins % git clone --depth 1 -- https://github.com/marlonrichert/zsh-autocomplete.git
.zshrcfile (before any calls to
Then restart your shell.
To update, do:
% git -C ~zsh-autocomplete pull
To uninstall, simply undo the installation steps above in reverse order:
To install with another Zsh framework or plugin manager, please refer to your framework's/plugin manager's documentation for instructions.
Try the steps in the bug report template.
2020-2021 Marlon Richert
This project is licensed under the MIT License. See the LICENSE file for details.