登录
首页 >  Golang >  Go问答

如何将 Cobra 应用程序中的别名隐藏显示在帮助屏幕

来源:stackoverflow

时间:2024-03-03 23:33:26 396浏览 收藏

Golang不知道大家是否熟悉?今天我将给大家介绍《如何将 Cobra 应用程序中的别名隐藏显示在帮助屏幕》,这篇文章主要会讲到等等知识点,如果你在看完本篇文章后,有更好的建议或者发现哪里有问题,希望大家都能积极评论指出,谢谢!希望我们能一起加油进步!

问题内容

是否可以禁止 aliases 显示在 golang cobra 应用程序的帮助屏幕中?我基本上想删除下面的整个“别名”部分:

Usage:
  my-app [flags]

Aliases:
 alias1 , alias2

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

我知道可以隐藏帮助中显示的标志 (cmd.flags().markhidden("myflag"))。是否也可以隐藏别名?


解决方案


这意味着定义您自己的使用函数,可以使用 usageFunc
或者使用特定的使用模板 (command#SetUsageTemplate()),如 "Defining your own usage" README section 中所述。

您可以看到 default template here。它确实包含别名部分:

aliases:
  {{.nameandaliases}}{{end}}{{if .hasexample}}

您所需要的只是定义相同的模板,但不包括 aliases 部分。

您可以查看 such a temmplate for 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}}

到这里,我们也就讲完了《如何将 Cobra 应用程序中的别名隐藏显示在帮助屏幕》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>