From 7e18d183b64b6772927d7e200db7956c60d23ff7 Mon Sep 17 00:00:00 2001
From: Chris Ellrich <c.ellrich@ellri.ch>
Date: Fri, 18 Apr 2025 17:29:05 +0200
Subject: [PATCH] added instructions for shell completion

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index b99c3c0..54ffc58 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,22 @@ Run the following command to import roles and map them to groups:
 cloaksmith import-roles --client-id <target_client_id> --realm <target_client_realm> <path_to_csv>
 ```
 
+## Enabling Completion
+
+### ZSH
+Add this to ~/.zshrc:
+
+```shell
+eval "$(_CLOAKSMITH_COMPLETE=zsh_source cloaksmith)"
+```
+
+### BASH
+Add this to ~/.bashrc:
+
+```shell
+eval "$(_CLOAKSMITH_COMPLETE=bash_source cloaksmith)"
+```
+
 ## Extensibility
 Cloaksmith is designed to be easily extensible. You can add new commands or functionality by modifying the CLI or the underlying modules.