github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/cmd/templates.go (about)

     1  package cmd
     2  
     3  const rootUsageTemplate = `Usage:{{if .HasAvailableSubCommands}}
     4    {{.CommandPath}} [command]{{end}}
     5  {{if .HasAvailableSubCommands}}
     6  Dataset Commands:{{range .Commands}}{{if eq .Annotations.group "dataset"}}
     7    {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}
     8  
     9  Network Commands:{{range .Commands}}{{if eq .Annotations.group "network"}}
    10    {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}
    11  
    12  Other Commands:{{range .Commands}}{{if (or (eq .Annotations.group "other") (eq .Name "help"))}}
    13    {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}
    14  
    15  Flags:
    16  {{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
    17  
    18  Global Flags:
    19  {{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
    20  Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
    21    {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
    22  
    23  Use "{{.CommandPath}} [command] --help" for more information about a command.{{end}}
    24  `
    25  
    26  const defaultUsageTemplate = `Usage:{{if .Runnable}}
    27    {{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}
    28    {{.CommandPath}} [command]{{end}}{{if gt (len .Aliases) 0}}
    29  
    30  Aliases:
    31    {{.NameAndAliases}}{{end}}{{if .HasExample}}
    32  
    33  Examples:
    34  {{.Example}}{{end}}{{if .HasAvailableSubCommands}}
    35  
    36  Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
    37    {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}
    38  
    39  Flags:
    40  {{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
    41  
    42  Global Flags:
    43  {{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
    44  
    45  Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
    46    {{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
    47  
    48  Use "{{.CommandPath}} [command] --help" for more information about a command.{{end}}
    49  `