centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

fix completion installing command

Browse Source 
Signed-off-by: Yutaro Suzuki <yutaro.suzuki@cloudys.dev>
This commit is contained in:
Yutaro Suzuki
2023-06-30 06:10:10 +09:00
parent 090efce37a
commit eb2e3b77ea
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/completion/completion.go
View File

@@ -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

8
docs/user-guide/installation.md
View File

@@ -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