added instructions for shell completion

This commit is contained in:
Chris Ellrich 2025-04-18 17:29:05 +02:00
parent 122bdb113d
commit 7e18d183b6
Signed by: c.ellrich
GPG Key ID: D1850E1719D845AE

View File

@ -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> 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 ## Extensibility
Cloaksmith is designed to be easily extensible. You can add new commands or functionality by modifying the CLI or the underlying modules. Cloaksmith is designed to be easily extensible. You can add new commands or functionality by modifying the CLI or the underlying modules.