diff --git a/How-to-Add-Custom-Suggestion-Strategy.md b/How-to-Add-Custom-Suggestion-Strategy.md new file mode 100644 index 0000000..36a49ab --- /dev/null +++ b/How-to-Add-Custom-Suggestion-Strategy.md @@ -0,0 +1,16 @@ +## Adding a Custom Suggestion Strategy + +1. Add a `_zsh_autosuggest_strategy_` function to your `.zshrc`. It must set the global variable `suggestion` +2. Export the `ZSH_AUTOSUGGEST_STRATEGY` + +#### Example +This example applies the history strategy first and if it fails to find a match then it applies the custom strategy + +``` +_zsh_autosuggest_strategy_custom() { + typeset -g suggestion + suggestion=`./my-custom-suggestion-script.sh "$1"` +} + +export ZSH_AUTOSUGGEST_STRATEGY=(history custom) +``` \ No newline at end of file