2013-10-27 00:05:17 +08:00
# zsh-autosuggestions
2013-10-30 03:08:56 +08:00
> [Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh.
2013-10-27 00:05:17 +08:00
## Installation
2014-11-22 05:54:47 +08:00
```
2014-12-09 10:53:40 +08:00
$ git clone git://github.com/tarruda/zsh-autosuggestions ~/.zsh-autosuggestions
2015-01-29 21:16:11 +08:00
$ sh ~/.zsh-autosuggestions/install
2013-11-08 19:20:57 +08:00
```
2015-02-18 14:02:19 +08:00
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
`
2013-11-08 19:20:57 +08:00
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:
2013-11-08 07:17:10 +08:00
2013-11-08 19:20:57 +08:00
```sh
# Accept suggestions without leaving insert mode
bindkey '^f' vi-forward-word
2013-12-04 03:25:52 +08:00
# or
2013-11-08 19:20:57 +08:00
bindkey '^f' vi-forward-blank-word
2013-10-27 00:05:17 +08:00
```
2013-11-08 19:20:57 +08:00
Emacs-mode users can simply use alt+f which is bound to forward-word
The [zsh-history-substring-search ](https://github.com/zsh-users/zsh-history-substring-search )
plugin is also recommended.
2013-12-04 03:45:56 +08:00
## 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` .
2014-12-10 05:06:52 +08:00
## Known Issues
- `COMPLETION_WAITING_DOTS` : setting this to `true` is known to cause problems when attempting to autocomplete with < kbd > TAB</ kbd >
