Hide auto-generated completion command

[blacktop]

Is there a way to hide the completion cmd? I like having it, but don't want it to show up in --help

Thanks!

[marckhouzam]

Hi @blacktop, there is currently no way to hide the completion command provided by Cobra. You would need to define your own completion and mark it hidden.

I think it would be nice to add such an option to Cobra.

[marcellmars]

one of the ways to keep completion in as a command but only hide it from the help/usage output could be by using SetHelpTemplate or SetUsageTemplate...

for example if you just copy the template from command.go and paste it into your custom template. just change what is in the line 501:

cobra/command.go

Line 501 in de187e8

Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}

...into this¹:

Available commands:
{{range .Commands}}
  {{if and (ne .Name "completion") .IsAvailableCommand}}
    {{rpad .Name .NamePadding }} {{.Short}}{{end}}
   {{end}}
 {{end}}
 {{if .HasAvailableLocalFlags}}

it should hide completion from listing it under "Available commands:"..

Footnotes

1. here I also got rid off the help as a [command] and unfolded the change into multiline snippet just here on github so it shows better what's done there... ↩

[jpmcb]

@marckhouzam - is this something we could tackle in the next release? That would be great

[marckhouzam]

I was hoping to make the command public so that people could adapt it any way they want, but IIRC it is not that easy.

I'll try again and if I can't figure it out, I'll add an new completionOption to allow hiding the command.

Glad to have you back @jpmcb 😄

[zliang90]

@blacktop i rewrite the completion command, can hide the completion subcommand, code examples:

func completionCommand() *cobra.Command {
	return &cobra.Command{
		Use:   "completion",
		Short: "Generate the autocompletion script for the specified shell",
	}
}

func init() {
	completion := completionCommand()

       // mark completion hidden
	completion.Hidden = true
	rootCommand.AddCommand(completion)

        // other subcommands
	rootCommand.AddCommand(...)
}

[abs007]

@marckhouzam Are there new docs explaining how to hide the "completion" sub-command?

AFAI can see, the line: rootCmd.Root().CompletionOptions.DisableDefaultCmd = true needs to be added to the rootCmd's init() func

[marckhouzam]

@abs007 here you go: https://github.com/spf13/cobra/blob/main/site/content/completions/_index.md#adapting-the-default-completion-command