mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
64 lines
1.9 KiB
Go
64 lines
1.9 KiB
Go
/*
|
|
Copyright 2021 The terraform-docs Authors.
|
|
|
|
Licensed under the MIT license (the "License"); you may not
|
|
use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at the LICENSE file in
|
|
the root directory of this source tree.
|
|
*/
|
|
|
|
package completion
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/terraform-docs/terraform-docs/cmd/completion/bash"
|
|
"github.com/terraform-docs/terraform-docs/cmd/completion/fish"
|
|
"github.com/terraform-docs/terraform-docs/cmd/completion/zsh"
|
|
)
|
|
|
|
// NewCommand returns a new cobra.Command for 'completion' command
|
|
func NewCommand() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Args: cobra.NoArgs,
|
|
Use: "completion SHELL",
|
|
Short: "Generate shell completion code for the specified shell (bash, zsh, fish)",
|
|
Long: longDescription,
|
|
}
|
|
|
|
// subcommands
|
|
cmd.AddCommand(bash.NewCommand())
|
|
cmd.AddCommand(zsh.NewCommand())
|
|
cmd.AddCommand(fish.NewCommand())
|
|
|
|
return cmd
|
|
}
|
|
|
|
const longDescription = `Outputs terraform-docs shell completion for the given shell (bash, zsh, fish)
|
|
This depends on the bash-completion binary. Example installation instructions:
|
|
# for bash users
|
|
$ terraform-docs completion bash > ~/.terraform-docs-completion
|
|
$ source ~/.terraform-docs-completion
|
|
|
|
# or the one-liner below
|
|
|
|
$ source <(terraform-docs completion bash)
|
|
|
|
# for zsh users
|
|
% terraform-docs completion zsh > /usr/local/share/zsh/site-functions/_terraform-docs
|
|
% autoload -U compinit && compinit
|
|
# or if zsh-completion is installed via homebrew
|
|
% terraform-docs completion zsh > "${fpath[1]}/_terraform-docs"
|
|
|
|
# for ohmyzsh
|
|
$ terraform-docs completion zsh > ~/.oh-my-zsh/completions/_terraform-docs
|
|
$ omz reload
|
|
|
|
# for fish users
|
|
$ terraform-docs 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
|
|
`
|