zsh-autosuggestions/README.md

# zsh-autosuggestions

> [Fish](http://fishshell.com/)-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:

```sh
# 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](https://github.com/zsh-users/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 <kbd>TAB</kbd>
First commit 2013-10-27 00:05:17 +08:00			`# zsh-autosuggestions`

Add link to shelr demo 2013-10-30 03:08:56 +08:00			`> [Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh.`
First commit 2013-10-27 00:05:17 +08:00
			`## Installation`
updated readme for new install script 2014-11-22 05:54:47 +08:00			```
Reverted 9e710593e3979d0aa8f0da2c1fb728070b61b2dc 2014-12-09 10:53:40 +08:00			`$ git clone git://github.com/tarruda/zsh-autosuggestions ~/.zsh-autosuggestions`
Update README.mkd My rational for this is: 1. Most linux desktop users are using some kind of debian/ubuntu/mint, so why not have them catered for primarily? 2. the bash instructions work for everyone who has bash. Last time I checked, that was 99% of the linux community. 2015-04-14 17:41:32 +08:00			`$ bash ~/.zsh-autosuggestions/install`
Fixed accept-line and motion widgets integration with zsh-syntax-highlighting 2013-11-08 19:20:57 +08:00			```

Update README.mkd My rational for this is: 1. Most linux desktop users are using some kind of debian/ubuntu/mint, so why not have them catered for primarily? 2. the bash instructions work for everyone who has bash. Last time I checked, that was 99% of the linux community. 2015-04-14 17:41:32 +08:00			`If you do not have bash, please run it with sh :`
Added clarification to use bash Some linux distros have sh symlinked to dash. So I have added a clarification to use bash for the distros. 2015-02-18 14:02:19 +08:00
			`
Update README.mkd My rational for this is: 1. Most linux desktop users are using some kind of debian/ubuntu/mint, so why not have them catered for primarily? 2. the bash instructions work for everyone who has bash. Last time I checked, that was 99% of the linux community. 2015-04-14 17:41:32 +08:00			`sh ~/.zsh-autosuggestions/install`
Added clarification to use bash Some linux distros have sh symlinked to dash. So I have added a clarification to use bash for the distros. 2015-02-18 14:02:19 +08:00			`

Fixed accept-line and motion widgets integration with zsh-syntax-highlighting 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:`
Update documentation 2013-11-08 07:17:10 +08:00
Fixed accept-line and motion widgets integration with zsh-syntax-highlighting 2013-11-08 19:20:57 +08:00			```sh
			`# Accept suggestions without leaving insert mode`
			`bindkey '^f' vi-forward-word`
Remove spaces at the end of lines 2013-12-04 03:25:52 +08:00			`# or`
Fixed accept-line and motion widgets integration with zsh-syntax-highlighting 2013-11-08 19:20:57 +08:00			`bindkey '^f' vi-forward-blank-word`
First commit 2013-10-27 00:05:17 +08:00			```
Fixed accept-line and motion widgets integration with zsh-syntax-highlighting 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.`
Add highlight color config variables 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`.
Added backticks to 0, so it will highlight as code 2015-05-13 01:33:33 +08:00			- `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).
Update README.mkd 2014-12-10 05:06:52 +08:00
			`## Known Issues`

Fix and unify formatting and code-style 2015-05-18 20:50:14 +08:00			- `COMPLETION_WAITING_DOTS`: setting this to `true` is known to cause problems when attempting to autocomplete with <kbd>TAB</kbd>