Fish-like autosuggestions for zsh
Go to file
Michael Robinson fe6e9812b0 Merge pull request #45 from tirkarthi/patch-1
Added clarification to use bash
2015-02-18 19:42:58 +13:00
.gitignore First commit 2013-10-26 13:05:17 -03:00
LICENSE-MIT First commit 2013-10-26 13:05:17 -03:00
README.mkd Added clarification to use bash 2015-02-18 11:32:19 +05:30
autosuggestions.plugin.zsh add autosuggestions.plugin.zsh to get this repo working with antigen 2014-02-25 22:45:29 +02:00
autosuggestions.zsh Merge pull request #31 from maksimr/patch-1 2014-12-09 15:45:18 +13:00
completion-client.zsh Refactored, only use completion server on 2013-11-07 18:42:17 -03:00
completion-server-init.zsh Add magic prefix to distinguish completion lines 2013-10-29 08:26:59 -03:00
completion-server.zsh Direct less frequent log messages to stderr for 2013-10-30 08:36:53 -03:00
install Fixed: installation on OS X fails 2015-01-23 23:38:46 +01:00

README.mkd

zsh-autosuggestions

Fish-like fast/unobtrusive autosuggestions for zsh.

Installation

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

On some linux distributions like ubuntu and debian sh is symlinked to /bin/dash and causes an installation error since the installation script needs some bash features. If sh is symlinked to dash, please run it with the bash :

bash ~/.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.

Known Issues

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