Help Command

Cobra automatically adds a help command to your application when you have subcommands.
This will be called when a user runs ‘app help’. Additionally, help will also
support all other commands as input. Say, for instance, you have a command called
‘create’ without any additional configuration; Cobra will work when ‘app help
create’ is called. Every command will automatically have the ‘—help’ flag added.

Example

The following output is automatically generated by Cobra. Nothing beyond the
command and flag definitions are needed.

$ cobra help
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.
Usage:
  cobra [command]
Available Commands:
  add         Add a command to a Cobra Application
  help        Help about any command
  init        Initialize a Cobra Application
Flags:
  -a, --author string    author name for copyright attribution (default "YOUR NAME")
      --config string    config file (default is $HOME/.cobra.yaml)
  -h, --help             help for cobra
  -l, --license string   name of license for the project
      --viper            use Viper for configuration (default true)
Use "cobra [command] --help" for more information about a command.

Help is just a command like any other. There is no special logic or behavior
around it. In fact, you can provide your own if you want.

Defining your own help

You can provide your own Help command or your own template for the default command to use
with following functions:

cmd.SetHelpCommand(cmd *Command)
cmd.SetHelpFunc(f func(*Command, []string))
cmd.SetHelpTemplate(s string)

The latter two will also apply to any children commands.