Fish-like autosuggestions for zsh
Fish-like fast/unobtrusive autosuggestions for zsh.
It suggests commands as you type based on history and completions.
Requirements: Zsh v4.3.11 or later
As you type commands, you will see a completion offered after the cursor in a muted gray color. This color can be changed by setting the
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLEvariable. See configuration.
If you press the → key (
forward-charwidget) or End (
end-of-linewidget) with the cursor at the end of the buffer, it will accept the suggestion, replacing the contents of the command line buffer with the suggestion.
If you invoke the
forward-wordwidget, it will partially accept the suggestion up to the point that the cursor moves to.
You may want to override the default global config variables. Default values of these variables can be found here.
Note: If you are using Oh My Zsh, you can put this configuration in a file in the
$ZSH_CUSTOMdirectory. See their comments on overriding internals.
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLEto configure the style that the suggestion is shown with. The default is
fg=8, which will set the foreground color to color 8 from the 256-color palette. If your terminal only supports 8 colors, you will need to use a number between 0 and 7.
Background color can also be set, and the suggestion can be styled bold, underlined, or standout. For example, this would show suggestions with bold, underlined, pink text on a cyan background:
For more info, read the Character Highlighting section of the zsh manual:
man zshzleor online.
Note: Some iTerm2 users have reported not being able to see the suggestions. If this affects you, the problem is likely caused by incorrect color settings. In order to correct this, go into iTerm2's setting, navigate to profile > colors and make sure that the colors for Basic Colors > Background and ANSI Colors > Bright Black are different.
ZSH_AUTOSUGGEST_STRATEGYis an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from:
history: Chooses the most recent match from history.
completion: Chooses a suggestion based on what tab-completion would suggest. (requires
history, but chooses the most recent match whose preceding history item matches the most recently executed command (more info). Note that this strategy won't work as expected with ZSH options that don't preserve the history order such as
For example, setting
ZSH_AUTOSUGGEST_STRATEGY=(history completion)will first try to find a suggestion from your history, but, if it can't find a match, will find a suggestion from the completion engine.
This plugin works by triggering custom behavior when certain zle widgets are invoked. You can add and remove widgets from these arrays to change the behavior of this plugin:
ZSH_AUTOSUGGEST_CLEAR_WIDGETS: Widgets in this array will clear the suggestion when invoked.
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS: Widgets in this array will accept the suggestion when invoked.
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS: Widgets in this array will execute the suggestion when invoked.
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS: Widgets in this array will partially accept the suggestion when invoked.
ZSH_AUTOSUGGEST_IGNORE_WIDGETS: Widgets in this array will not trigger any custom behavior.
Widgets that modify the buffer and are not found in any of these arrays will fetch a new suggestion after they are invoked.
Note: A widget shouldn't belong to more than one of the above arrays.
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZEto an integer value to disable autosuggestion for large buffers. The default is unset, which means that autosuggestion will be tried for any buffer size. Recommended value is 20. This can be useful when pasting large amount of text in the terminal, to avoid triggering autosuggestion for strings that are too long.
Suggestions are fetched asynchronously by default in zsh versions 5.0.8 and greater. To disable asynchronous suggestions and fetch them synchronously instead,
unset ZSH_AUTOSUGGEST_USE_ASYNCafter sourcing the plugin.
Alternatively, if you are using a version of zsh older than 5.0.8 and want to enable asynchronous mode, set the
ZSH_AUTOSUGGEST_USE_ASYNCvariable after sourcing the plugin (it can be set to anything). Note that there is a bug in versions of zsh older than 5.0.8 where ctrl + c will fail to reset the prompt immediately after fetching a suggestion asynchronously.
ZSH_AUTOSUGGEST_MANUAL_REBIND(it can be set to anything) to disable automatic widget re-binding on each precmd. This can be a big boost to performance, but you'll need to handle re-binding yourself if any of the widget lists change or if you or another plugin wrap any of the autosuggest widgets. To re-bind widgets, run
ZSH_AUTOSUGGEST_HISTORY_IGNOREto a glob pattern to prevent offering suggestions for history entries that match the pattern. For example, set it to
"cd *"to never suggest any
cdcommands from history. Or set to
"?(#c50,)"to never suggest anything 50 characters or longer.
Note: This only affects the
ZSH_AUTOSUGGEST_COMPLETION_IGNOREto a glob pattern to prevent offering completion suggestions when the buffer matches that pattern. For example, set it to
"git *"to disable completion suggestions for git subcommands.
Note: This only affects the
This plugin provides a few widgets that you can use with
autosuggest-accept: Accepts the current suggestion.
autosuggest-execute: Accepts and executes the current suggestion.
autosuggest-clear: Clears the current suggestion.
autosuggest-fetch: Fetches a suggestion (works even when suggestions are disabled).
autosuggest-disable: Disables suggestions.
autosuggest-enable: Re-enables suggestions.
autosuggest-toggle: Toggles between enabled/disabled suggestions.
For example, this would bind ctrl + space to accept the current suggestion.
bindkey '^ ' autosuggest-accept
If you have a problem, please search through the list of issues on GitHub to see if someone else has already reported it.
Before reporting an issue, please try temporarily disabling sections of your configuration and other plugins that may be conflicting with this plugin to isolate the problem.
When reporting an issue, please include:
.zshrcconfiguration that will reproduce the problem. See this comment for a good example of what this means.
Remove the code referencing this plugin from
Remove the git repository from your hard drive
rm -rf ~/.zsh/zsh-autosuggestions # Or wherever you installed
Edit the source files in
zsh-autosuggestions.zshfrom those source files.
Pull requests are welcome! If you send a pull request, please:
tmuxto drive a pseudoterminal, sending simulated keystrokes and making assertions on the terminal content.
Test files live in
spec/. To run the tests, run
make test. To run a specific test, run
TESTS=spec/some_spec.rb make test. You can also specify a
zshbinary to use by setting the
TEST_ZSH_BINenvironment variable (ex:
TEST_ZSH_BIN=/bin/zsh make test).
A docker image for testing is available on docker hub. It comes with ruby, the bundler dependencies, and all supported versions of zsh installed.
Pull the docker image with:
docker pull ericfreese/zsh-autosuggestions-test
To run the tests for a specific version of zsh (wherebelow is substituted with the contents of a line from the
docker run -it -e TEST_ZSH_BIN=zsh- -v $PWD:/zsh-autosuggestions zsh-autosuggestions-test make test