Как скрыть псевдонимы с экрана справки в приложении Cobra

Question

Можно ли запретить отображение Aliases на экране справки приложения golang cobra? Я в основном хотел бы избавиться от всего раздела «Псевдонимы» ниже:

Usage:
  my-app [flags]

Aliases:
 alias1 , alias2

Flags:
  -h, --help              help for this command

Я знаю, что можно скрыть флаги, чтобы они не отображались в справке (cmd.Flags().MarkHidden("myflag")). Можно ли как-нибудь скрыть и псевдонимы?

Answer 1

Это будет означать определение вашей собственной функции использования, которая возможна с использованием usageFunc
или с использованием специального c шаблона использования (command#SetUsageTemplate()), как указано в разделе «Определение собственного использования» README .

Здесь вы можете увидеть шаблон по умолчанию . Он включает в себя раздел псевдонимов:

Aliases:
  {{.NameAndAliases}}{{end}}{{if .HasExample}}

Все, что вам нужно, это определить тот же шаблон, но за исключением части Aliases.

Вы можете увидеть пример , например шаблон для emacski/redact.
И да, у него нет Aliases.

{{with (or .Long .Short)}}{{. | trimTrailingWhitespaces}}{{end}}
{{if .HasAvailableLocalFlags}}
Options:
{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableSubCommands}}
Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
Use "{{.CommandPath}} COMMAND --help" for more information about a command.{{end}}

Answer 2

использовать настраиваемый шаблон использования, просто удалите часть псевдонима

customUsageTpl:=`Usage:{{if .Runnable}}
  {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}
  {{.CommandPath}} [command]{{end}}{{if .HasExample}}
Examples:
{{.Example}}{{end}}{{if .HasAvailableSubCommands}}
Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
  {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}
Flags:
{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
Global Flags:
{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
  {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
Use "{{.CommandPath}} [command] --help" for more information about a command.{{end}}
`

Затем установите настраиваемый шаблон

cmd.SetUsageTemplate(customUsageTpl)