From 28a54ca3c75850cb3c012b8f2c3b0142ed260f7c Mon Sep 17 00:00:00 2001
From: Moul <moul@moul.re>
Date: Thu, 12 Dec 2024 18:46:42 +0100
Subject: [PATCH] doc: install: Add shell completion set-up (#166)

---
 docs/install.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/docs/install.md b/docs/install.md
index 147249c6..9caa5fa5 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/).
-- 
GitLab