completion

Documentation

Index

• Variables

Variables

var Cmd = &cobra.Command{
	Use:   "completion [bash|zsh|fish|powershell]",
	Short: "Generate completion scripts for various shells",
	Long: `To load completions:

Bash:

$ source <(ocm completion bash)

# To load completions for each session, execute once:
Linux:
  $ ocm completion bash > /etc/bash_completion.d/ocm
MacOS:
  $ ocm completion bash > /usr/local/etc/bash_completion.d/ocm

Zsh:

# If shell completion is not already enabled in your environment you will need
# to enable it.  You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ ocm completion zsh > "${fpath[1]}/_ocm"

# You will need to start a new shell for this setup to take effect.

Fish:

$ ocm completion fish | source

# To load completions for each session, execute once:
$ ocm completion fish > ~/.config/fish/completions/ocm.fish

P.S. Debugging completion logic:
- Set BASH_COMP_DEBUG_FILE env var to enable logging to that file.
- See https://github.com/spf13/cobra/blob/master/shell_completions.md.
`,
	DisableFlagsInUseLine: true,
	ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
	Args:                  cobra.RangeArgs(0, 1),
	RunE: func(cmd *cobra.Command, args []string) error {

		if len(args) == 0 {
			args = []string{"bash"}
		}

		switch args[0] {
		case "bash":
			cmd.Root().GenBashCompletion(os.Stdout)
		case "zsh":
			cmd.Root().GenZshCompletion(os.Stdout)
		case "fish":
			cmd.Root().GenFishCompletion(os.Stdout, true)
		case "powershell":
			cmd.Root().GenPowerShellCompletion(os.Stdout)
		default:
			return fmt.Errorf("invalid shell %q", args[0])
		}
		return nil
	},
}