1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-23 00:17:59 +00:00
prezto/modules/autosuggestions/README.md
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00

1.9 KiB

Autosuggestions

Integrates zsh-autosuggestions into Prezto, which implements the Fish shell's autosuggestions feature, where the user can type in any part of a previously entered command and Zsh suggests commands as you type based on history and completions.

If this module is used in conjunction with the syntax-highlighting module, this module must be loaded after the syntax-highlighting module.

If this module is used in conjunction with the history-substring-search module, this module must be loaded after the history-substring-search module.

To elaborate, the relative order of loading the modules would be autosuggestions, syntax-highlighting and history-substring-search.

Contributors

New features and bug fixes should be submitted to the zsh-autosuggestions project according to its rules and regulations. This module will be synchronized against it.

Settings

Highlighting

If colors are enabled, autosuggestions will automatically highlight positive results.

To enable highlighting for this module only, add the following line to ${ZDOTDIR:-$HOME}/.zpreztorc:

zstyle ':prezto:module:autosuggestions' color 'yes'

To set the query found color, add the following line to ${ZDOTDIR:-$HOME}/.zpreztorc:

zstyle ':prezto:module:autosuggestions:color' found ''

Troubleshooting

Autosuggestions from previous sessions don't show up

For autosuggestions from previous shell sessions to work, please make sure you also have the history module enabled.

Authors

The authors of this module should be contacted via the issue tracker.