mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2025-12-11 01:30:42 +01:00
Add a doc describing how to add custom suggestion strategies. This was very hard to figure out without guidance.
16
How-to-Add-Custom-Suggestion-Strategy.md
Normal file
16
How-to-Add-Custom-Suggestion-Strategy.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
## Adding a Custom Suggestion Strategy
|
||||||
|
|
||||||
|
1. Add a `_zsh_autosuggest_strategy_<your custom strategy name>` 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)
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user