diff --git a/docs/install.md b/docs/install.md index 147249c6b8588edfefc48f215242efeee93772f3..9caa5fa5fc9ba564c7366b12e0e1ec258b38035b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -141,6 +141,27 @@ pip3 uninstall silkaj --user silkaj ``` +## Shell completion + +Set up the shell completion by adding following line in your shell configuration depending on your shell: + +=== "Bash" + ```title="$HOME/.bashrc" + eval "$(_SILKAJ_COMPLETE=bash_source silkaj)" + ``` + +=== "Zsh" + ```title="$HOME/.zshrc" + eval "$(_SILKAJ_COMPLETE=zsh_source silkaj)" + ``` + +=== "Fish" + ```title="$HOME/.config/fish/completions/silkaj.fish" + _SILKAJ_COMPLETE=fish_source silkaj | source + ``` + +For further details checkout [Click documentation](https://click.palletsprojects.com/en/8.1.x/shell-completion/). + ## Install to contribute Check out the [installation guide with Poetry](/contributing/install_poetry/).