diff --git a/README.md b/README.md index c80a550..bff92cf 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,7 @@ vaultik [--config ] info vaultik [--config ] remote info [--json] vaultik [--config ] store info vaultik [--config ] database purge [--force] +vaultik completion vaultik version ``` @@ -120,6 +121,25 @@ vaultik version * `VAULTIK_CONFIG`: Path to config file (overridden by `--config`) * `VAULTIK_INDEX_PATH`: Override local SQLite index path +### shell completion + +```sh +# zsh: load for the current session +source <(vaultik completion zsh) + +# zsh: install permanently +vaultik completion zsh > "${fpath[1]}/_vaultik" + +# bash: load for the current session +source <(vaultik completion bash) + +# bash: install permanently (Linux) +vaultik completion bash > /etc/bash_completion.d/vaultik + +# fish +vaultik completion fish > ~/.config/fish/completions/vaultik.fish +``` + ### command details **`config init`**: Write a default config file with commented explanations for