github.com/ActiveState/cli@v0.0.0-20240508170324-6801f60cd051/internal/assets/contents/usage.tpl (about)

     1  Usage:
     2  {{- if .Cobra.Runnable}}
     3      {{.Cobra.UseLine}}
     4  {{- range  .Cmd.Arguments }} <{{ .Name }}>{{ end }}
     5  {{- end}}
     6  {{- if .Cobra.HasAvailableSubCommands}}
     7      {{.Cobra.CommandPath}} [command]
     8  {{- end}}
     9  {{- if gt (len .Cobra.Aliases) 0}}
    10  
    11  Aliases:
    12      {{.Cobra.NameAndAliases}}
    13  {{- end}}
    14  
    15  {{- if .Cmd.Examples  }}
    16  
    17  Examples:
    18  {{- range  .Cmd.Examples }}
    19      {{ . -}}
    20  {{- end }}
    21  {{- end }}
    22  
    23  {{- childCommands .Cmd}}
    24  {{- if gt (len .Cmd.Arguments) 0}}
    25  
    26  Arguments:
    27  {{-  range .Cmd.Arguments }}
    28    <{{ .Name }}> {{ if .Required }}          {{ else }}(optional){{ end }} {{ .Description }}
    29  {{-  end }}
    30  {{-  end }}
    31  
    32  {{- if .Cobra.HasAvailableFlags}}
    33  
    34  Flags:
    35  {{.Cmd.LocalFlagUsages | trimTrailingWhitespaces}}
    36  {{- end}}
    37  {{- if .Cobra.HasAvailableInheritedFlags}}
    38  
    39  Global Flags:
    40  {{.Cmd.InheritedFlagUsages | trimTrailingWhitespaces}}
    41  {{- end}}
    42  
    43  {{- if .Cobra.HasHelpSubCommands}}
    44  
    45  Additional help topics:
    46  {{- range .Cobra.Commands}}
    47      {{- if .Cobra.IsAdditionalHelpTopicCommand}}
    48      {{rpad .Cobra.CommandPath .Cobra.CommandPathPadding}} {{.Cobra.Short}}
    49      {{- end}}
    50  {{- end}}
    51  {{- end}}
    52  {{- if .Cobra.HasAvailableSubCommands}}
    53  
    54  Use "{{.Cobra.CommandPath}} [command] --help" for more information about a command.
    55  
    56  {{- if not .OptinUnstable}}
    57  
    58  To access the list of full commands, including unstable features still in beta, run:
    59  
    60  "state config set optin.unstable true"
    61  {{- end}}
    62  {{- end}}
    63  
    64  {{- if .OptinUnstable }}
    65  
    66  WARNING: You have access to all State Tool commands, including unstable features still in beta, in order to hide these features run:
    67  
    68  "state config set optin.unstable false"
    69  {{- end}}