From eb2e3b77ea4c1801c2632e23720aedcd57d5fcd7 Mon Sep 17 00:00:00 2001 From: Yutaro Suzuki Date: Fri, 30 Jun 2023 06:10:10 +0900 Subject: [PATCH] fix completion installing command Signed-off-by: Yutaro Suzuki --- cmd/completion/completion.go | 2 +- docs/user-guide/installation.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/cmd/completion/completion.go b/cmd/completion/completion.go index a5322ba..777b7db 100644 --- a/cmd/completion/completion.go +++ b/cmd/completion/completion.go @@ -48,7 +48,7 @@ This depends on the bash-completion binary. Example installation instructions: % terraform-doc completion zsh > "${fpath[1]}/_terraform-doc" # for fish users - $ terraform-doc completion fish | source + $ terraform-doc completion fish > ~/.config/fish/completions/terraform-docs.fish Additionally, you may want to output the completion to a file and source in your .bashrc Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md index adec7b1..b224afb 100644 --- a/docs/user-guide/installation.md +++ b/docs/user-guide/installation.md @@ -138,11 +138,17 @@ source <(terraform-docs completion bash) ### zsh -```bash +```zsh terraform-docs completion zsh > /usr/local/share/zsh/site-functions/_terraform-docs autoload -U compinit && compinit ``` +### fish + +```fish +terraform-doc completion fish > ~/.config/fish/completions/terraform-docs.fish +``` + To make this change permanent, the above commands can be added to `~/.profile` file. [Chocolatey]: https://www.chocolatey.org