Fish-like autosuggestions for zsh
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Jakub Jirutka f090f609ac Rename LICENSE-MIT to LICENSE
LICENSE (optionally with an file extension) is a common file name for
the license file.
10 years ago
.editorconfig Add .editorconfig 10 years ago
.gitignore First commit 12 years ago
LICENSE Rename LICENSE-MIT to LICENSE 10 years ago
README.md Rename README.mkd to README.md 10 years ago
autosuggestions.plugin.zsh add autosuggestions.plugin.zsh to get this repo working with antigen 12 years ago
autosuggestions.zsh Fix indentation in autosuggest-backward-delete-char() 10 years ago
completion-client.zsh Refactored, only use completion server on 12 years ago
completion-server-init.zsh Fix and unify formatting and code-style 10 years ago
completion-server.zsh Fix and unify formatting and code-style 10 years ago
install Fix and unify formatting and code-style 10 years ago

README.md

zsh-autosuggestions

Fish-like fast/unobtrusive autosuggestions for zsh.

Installation

    $ git clone git://github.com/tarruda/zsh-autosuggestions ~/.zsh-autosuggestions
    $ bash ~/.zsh-autosuggestions/install

If you do not have bash, please run it with sh :

sh ~/.zsh-autosuggestions/install

Any widget that moves the cursor to the right(forward-word, forward-char...) will accept parts of the suggested text. For example, vi-mode users can do this:

# Accept suggestions without leaving insert mode
bindkey '^f' vi-forward-word
# or
bindkey '^f' vi-forward-blank-word

Emacs-mode users can simply use alt+f which is bound to forward-word

The zsh-history-substring-search plugin is also recommended.

Configuration

You may override default global config variables after plugin load.

  • AUTOSUGGESTION_HIGHLIGHT_COLOR: suggestion highlight color, default is 'fg=8'.
  • AUTOSUGGESTION_HIGHLIGHT_CURSOR: highlight word after cursor or not. Must be integer value 1 or 0, default is 1.
  • AUTOSUGGESTION_ACCEPT_RIGHT_ARROW: complete entire suggestion with right arrow. Must be integer value 1 or 0, default is 0 (right arrow completes one letter at a time).

Known Issues

  • COMPLETION_WAITING_DOTS: setting this to true is known to cause problems when attempting to autocomplete with TAB