From 121570491e97198c7f09976a10c7598b21ab2445 Mon Sep 17 00:00:00 2001 From: killertofus Date: Sat, 26 Apr 2025 14:15:05 -0600 Subject: [PATCH] improved README.MD --- plugins/zsh-autosuggestions/README.MD | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/plugins/zsh-autosuggestions/README.MD b/plugins/zsh-autosuggestions/README.MD index 83a623d31..d2c1c8bfd 100644 --- a/plugins/zsh-autosuggestions/README.MD +++ b/plugins/zsh-autosuggestions/README.MD @@ -1 +1,28 @@ +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 + +If you press the → key (forward-char widget) or End (end-of-line widget) 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-word widget, it will partially accept the suggestion up to the point that the cursor moves to. + +### Key Bindings + +This plugin provides a few widgets that you can use with `bindkey`: + +1. `autosuggest-accept`: Accepts the current suggestion. +2. `autosuggest-execute`: Accepts and executes the current suggestion. +3. `autosuggest-clear`: Clears the current suggestion. +4. `autosuggest-fetch`: Fetches a suggestion (works even when suggestions are disabled). +5. `autosuggest-disable`: Disables suggestions. +6. `autosuggest-enable`: Re-enables suggestions. +7. `autosuggest-toggle`: Toggles between enabled/disabled suggestions. + +For example, this would bind ctrl + space to accept the current suggestion. + +```sh +bindkey '^ ' autosuggest-accept +``` + + As you type commands, you will see a completion offered after the cursor