Skip to content

Commit a7c8bca

Browse files
dnephindnephin
committed
Only hide commands if the env variable is set.
Better formatting for usage template. Group commands in usage to management/operation commands. Remove the word Docker from the description of management commands. Signed-off-by: Daniel Nephin <[email protected]>
1 parent dda1987 commit a7c8bca

12 files changed

Lines changed: 86 additions & 18 deletions

File tree

‎cli/cobra.go‎

Lines changed: 71 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ import (
99
// SetupRootCommand sets default usage, help, and error handling for the
1010
// root command.
1111
func SetupRootCommand(rootCmd *cobra.Command) {
12+
cobra.AddTemplateFunc("hasSubCommands", hasSubCommands)
13+
cobra.AddTemplateFunc("hasManagementSubCommands", hasManagementSubCommands)
14+
cobra.AddTemplateFunc("operationSubCommands", operationSubCommands)
15+
cobra.AddTemplateFunc("managementSubCommands", managementSubCommands)
16+
1217
rootCmd.SetUsageTemplate(usageTemplate)
1318
rootCmd.SetHelpTemplate(helpTemplate)
1419
rootCmd.SetFlagErrorFunc(FlagErrorFunc)
@@ -34,23 +39,81 @@ func FlagErrorFunc(cmd *cobra.Command, err error) error {
3439
}
3540
}
3641

37-
var usageTemplate = `Usage: {{if not .HasSubCommands}}{{.UseLine}}{{end}}{{if .HasSubCommands}}{{ .CommandPath}} COMMAND{{end}}
42+
func hasSubCommands(cmd *cobra.Command) bool {
43+
return len(operationSubCommands(cmd)) > 0
44+
}
45+
46+
func hasManagementSubCommands(cmd *cobra.Command) bool {
47+
return len(managementSubCommands(cmd)) > 0
48+
}
49+
50+
func operationSubCommands(cmd *cobra.Command) []*cobra.Command {
51+
cmds := []*cobra.Command{}
52+
for _, sub := range cmd.Commands() {
53+
if sub.IsAvailableCommand() && !sub.HasSubCommands() {
54+
cmds = append(cmds, sub)
55+
}
56+
}
57+
return cmds
58+
}
59+
60+
func managementSubCommands(cmd *cobra.Command) []*cobra.Command {
61+
cmds := []*cobra.Command{}
62+
for _, sub := range cmd.Commands() {
63+
if sub.IsAvailableCommand() && sub.HasSubCommands() {
64+
cmds = append(cmds, sub)
65+
}
66+
}
67+
return cmds
68+
}
69+
70+
var usageTemplate = `Usage:
3871
39-
{{ .Short | trim }}{{if gt .Aliases 0}}
72+
{{- if not .HasSubCommands}} {{.UseLine}}{{end}}
73+
{{- if .HasSubCommands}} {{ .CommandPath}} COMMAND{{end}}
74+
75+
{{ .Short | trim }}
76+
77+
{{- if gt .Aliases 0}}
4078
4179
Aliases:
42-
{{.NameAndAliases}}{{end}}{{if .HasExample}}
80+
{{.NameAndAliases}}
81+
82+
{{- end}}
83+
{{- if .HasExample}}
4384
4485
Examples:
45-
{{ .Example }}{{end}}{{if .HasFlags}}
86+
{{ .Example }}
87+
88+
{{- end}}
89+
{{- if .HasFlags}}
4690
4791
Options:
48-
{{.Flags.FlagUsages | trimRightSpace}}{{end}}{{ if .HasAvailableSubCommands}}
92+
{{.Flags.FlagUsages | trimRightSpace}}
93+
94+
{{- end}}
95+
{{- if hasManagementSubCommands . }}
96+
97+
Management Commands:
98+
99+
{{- range managementSubCommands . }}
100+
{{rpad .Name .NamePadding }} {{.Short}}
101+
{{- end}}
102+
103+
{{- end}}
104+
{{- if hasSubCommands .}}
105+
106+
Commands:
107+
108+
{{- range operationSubCommands . }}
109+
{{rpad .Name .NamePadding }} {{.Short}}
110+
{{- end}}
111+
{{- end}}
49112
50-
Commands:{{range .Commands}}{{if .IsAvailableCommand}}
51-
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{ if .HasSubCommands }}
113+
{{- if .HasSubCommands }}
52114
53-
Run '{{.CommandPath}} COMMAND --help' for more information on a command.{{end}}
115+
Run '{{.CommandPath}} COMMAND --help' for more information on a command.
116+
{{- end}}
54117
`
55118

56119
var helpTemplate = `

‎cli/command/checkpoint/cmd_experimental.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
func NewCheckpointCommand(rootCmd *cobra.Command, dockerCli *command.DockerCli) {
1616
cmd := &cobra.Command{
1717
Use: "checkpoint",
18-
Short: "Manage Container Checkpoints",
18+
Short: "Manage checkpoints",
1919
Args: cli.NoArgs,
2020
Run: func(cmd *cobra.Command, args []string) {
2121
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/commands/commands.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package commands
22

33
import (
4+
"os"
5+
46
"github.com/docker/docker/cli/command"
57
"github.com/docker/docker/cli/command/checkpoint"
68
"github.com/docker/docker/cli/command/container"
@@ -75,6 +77,9 @@ func AddCommands(cmd *cobra.Command, dockerCli *command.DockerCli) {
7577
}
7678

7779
func hide(cmd *cobra.Command) *cobra.Command {
80+
if os.Getenv("DOCKER_HIDE_LEGACY_COMMANDS") == "" {
81+
return cmd
82+
}
7883
cmdCopy := *cmd
7984
cmdCopy.Hidden = true
8085
cmdCopy.Aliases = []string{}

‎cli/command/container/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func NewContainerCommand(dockerCli *command.DockerCli) *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "container",
16-
Short: "Manage Docker containers",
16+
Short: "Manage containers",
1717
Args: cli.NoArgs,
1818
Run: func(cmd *cobra.Command, args []string) {
1919
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/image/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func NewImageCommand(dockerCli *command.DockerCli) *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "image",
16-
Short: "Manage Docker images",
16+
Short: "Manage images",
1717
Args: cli.NoArgs,
1818
Run: func(cmd *cobra.Command, args []string) {
1919
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/network/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func NewNetworkCommand(dockerCli *command.DockerCli) *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "network",
16-
Short: "Manage Docker networks",
16+
Short: "Manage networks",
1717
Args: cli.NoArgs,
1818
Run: func(cmd *cobra.Command, args []string) {
1919
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/node/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
func NewNodeCommand(dockerCli *command.DockerCli) *cobra.Command {
1515
cmd := &cobra.Command{
1616
Use: "node",
17-
Short: "Manage Docker Swarm nodes",
17+
Short: "Manage Swarm nodes",
1818
Args: cli.NoArgs,
1919
Run: func(cmd *cobra.Command, args []string) {
2020
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/plugin/cmd_experimental.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
func NewPluginCommand(rootCmd *cobra.Command, dockerCli *command.DockerCli) {
1515
cmd := &cobra.Command{
1616
Use: "plugin",
17-
Short: "Manage Docker plugins",
17+
Short: "Manage plugins",
1818
Args: cli.NoArgs,
1919
Run: func(cmd *cobra.Command, args []string) {
2020
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/service/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func NewServiceCommand(dockerCli *command.DockerCli) *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "service",
16-
Short: "Manage Docker services",
16+
Short: "Manage services",
1717
Args: cli.NoArgs,
1818
Run: func(cmd *cobra.Command, args []string) {
1919
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

‎cli/command/stack/cmd.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
func NewStackCommand(dockerCli *command.DockerCli) *cobra.Command {
1515
cmd := &cobra.Command{
1616
Use: "stack",
17-
Short: "Manage Docker stacks",
17+
Short: "Manage stacks",
1818
Args: cli.NoArgs,
1919
Run: func(cmd *cobra.Command, args []string) {
2020
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())

0 commit comments

Comments
 (0)