cli: use custom annotation for aliases

cli/cobra.go

@@ -31,6 +31,7 @@ func setupCommonRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *p
 	opts.Common.InstallFlags(flags)
 
 	cobra.AddTemplateFunc("add", func(a, b int) int { return a + b })
+	cobra.AddTemplateFunc("hasAliases", hasAliases)
 	cobra.AddTemplateFunc("hasSubCommands", hasSubCommands)
 	cobra.AddTemplateFunc("hasTopCommands", hasTopCommands)
 	cobra.AddTemplateFunc("hasManagementSubCommands", hasManagementSubCommands)
@@ -239,6 +240,10 @@ func isPlugin(cmd *cobra.Command) bool {
 	return cmd.Annotations[pluginmanager.CommandAnnotationPlugin] == "true"
 }
 
+func hasAliases(cmd *cobra.Command) bool {
+	return len(cmd.Aliases) > 0 || cmd.Annotations["aliases"] != ""
+}
+
 func hasSubCommands(cmd *cobra.Command) bool {
 	return len(operationSubCommands(cmd)) > 0
 }
@@ -263,6 +268,9 @@ func hasTopCommands(cmd *cobra.Command) bool {
 // formatted as the full command as they're called (contrary to the default
 // Aliases function, which only returns the subcommand).
 func commandAliases(cmd *cobra.Command) string {
+	if cmd.Annotations["aliases"] != "" {
+		return cmd.Annotations["aliases"]
+	}
 	var parentPath string
 	if cmd.HasParent() {
 		parentPath = cmd.Parent().CommandPath() + " "
@@ -411,7 +419,7 @@ EXPERIMENTAL:
   https://docs.docker.com/go/experimental/
 
 {{- end}}
-{{- if gt .Aliases 0}}
+{{- if hasAliases . }}
 
 Aliases:
   {{ commandAliases . }}

cli/cobra_test.go

@@ -81,9 +81,18 @@ func TestInvalidPlugin(t *testing.T) {
 func TestCommandAliases(t *testing.T) {
 	root := &cobra.Command{Use: "root"}
 	sub := &cobra.Command{Use: "subcommand", Aliases: []string{"alias1", "alias2"}}
+	sub2 := &cobra.Command{Use: "subcommand2", Annotations: map[string]string{"aliases": "root foo, root bar"}}
 	root.AddCommand(sub)
+	root.AddCommand(sub2)
 
+	assert.Equal(t, hasAliases(sub), true)
 	assert.Equal(t, commandAliases(sub), "root subcommand, root alias1, root alias2")
+	assert.Equal(t, hasAliases(sub2), true)
+	assert.Equal(t, commandAliases(sub2), "root foo, root bar")
+
+	sub.Annotations = map[string]string{"aliases": "custom alias, custom alias 2"}
+	assert.Equal(t, hasAliases(sub), true)
+	assert.Equal(t, commandAliases(sub), "custom alias, custom alias 2")
 }
 
 func TestDecoratedName(t *testing.T) {

cli/command/container/attach.go

@@ -55,6 +55,9 @@ func NewAttachCommand(dockerCli command.Cli) *cobra.Command {
 			opts.container = args[0]
 			return runAttach(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container attach, docker attach",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false, func(container types.Container) bool {
 			return container.State != "paused"
 		}),

cli/command/container/commit.go

@@ -37,6 +37,9 @@ func NewCommitCommand(dockerCli command.Cli) *cobra.Command {
 			}
 			return runCommit(dockerCli, &options)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container commit, docker commit",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/container/cp.go

@@ -101,6 +101,9 @@ func NewCopyCommand(dockerCli command.Cli) *cobra.Command {
 			}
 			return runCopy(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container cp, docker cp",
+		},
 	}
 
 	flags := cmd.Flags()

cli/command/container/create.go

@@ -57,6 +57,9 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command {
 			}
 			return runCreate(dockerCli, cmd.Flags(), &options, copts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container create, docker create",
+		},
 		ValidArgsFunction: completion.ImageNames(dockerCli),
 	}
 

cli/command/container/diff.go

@@ -27,6 +27,9 @@ func NewDiffCommand(dockerCli command.Cli) *cobra.Command {
 			opts.container = args[0]
 			return runDiff(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container diff, docker diff",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 }

cli/command/container/exec.go

@@ -59,6 +59,7 @@ func NewExecCommand(dockerCli command.Cli) *cobra.Command {
 		}),
 		Annotations: map[string]string{
 			"category-top": "2",
+			"aliases":      "docker container exec, docker exec",
 		},
 	}
 

cli/command/container/export.go

@@ -28,6 +28,9 @@ func NewExportCommand(dockerCli command.Cli) *cobra.Command {
 			opts.container = args[0]
 			return runExport(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container export, docker export",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 

cli/command/container/kill.go

@@ -30,6 +30,9 @@ func NewKillCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runKill(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container kill, docker kill",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/container/list.go

@@ -40,6 +40,7 @@ func NewPsCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "3",
+			"aliases":      "docker container ls, docker container list, docker container ps, docker ps",
 		},
 		ValidArgsFunction: completion.NoComplete,
 	}

cli/command/container/logs.go

@@ -35,6 +35,9 @@ func NewLogsCommand(dockerCli command.Cli) *cobra.Command {
 			opts.container = args[0]
 			return runLogs(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container logs, docker logs",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 

cli/command/container/pause.go

@@ -29,6 +29,9 @@ func NewPauseCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runPause(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container pause, docker pause",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false, func(container types.Container) bool {
 			return container.State != "paused"
 		}),

cli/command/container/port.go

@@ -35,6 +35,9 @@ func NewPortCommand(dockerCli command.Cli) *cobra.Command {
 			}
 			return runPort(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container port, docker port",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 	return cmd

cli/command/container/rename.go

@@ -30,6 +30,9 @@ func NewRenameCommand(dockerCli command.Cli) *cobra.Command {
 			opts.newName = args[1]
 			return runRename(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container rename, docker rename",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 	return cmd

cli/command/container/restart.go

@@ -34,6 +34,9 @@ func NewRestartCommand(dockerCli command.Cli) *cobra.Command {
 			opts.timeoutChanged = cmd.Flags().Changed("time")
 			return runRestart(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container restart, docker restart",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 

cli/command/container/rm.go

@@ -34,6 +34,9 @@ func NewRmCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runRm(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container rm, docker rm",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 

cli/command/container/run.go

@@ -48,6 +48,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {
 		ValidArgsFunction: completion.ImageNames(dockerCli),
 		Annotations: map[string]string{
 			"category-top": "1",
+			"aliases":      "docker container run, docker run",
 		},
 	}
 

cli/command/container/start.go

@@ -44,6 +44,9 @@ func NewStartCommand(dockerCli command.Cli) *cobra.Command {
 			opts.Containers = args
 			return RunStart(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container start, docker start",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true, func(container types.Container) bool {
 			return container.State == "exited" || container.State == "created"
 		}),

cli/command/container/stats.go

@@ -40,6 +40,9 @@ func NewStatsCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runStats(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container stats, docker stats",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/container/stop.go

@@ -34,6 +34,9 @@ func NewStopCommand(dockerCli command.Cli) *cobra.Command {
 			opts.timeoutChanged = cmd.Flags().Changed("time")
 			return runStop(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container stop, docker stop",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/container/top.go

@@ -31,6 +31,9 @@ func NewTopCommand(dockerCli command.Cli) *cobra.Command {
 			opts.args = args[1:]
 			return runTop(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container top, docker top",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/container/unpause.go

@@ -29,6 +29,9 @@ func NewUnpauseCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runUnpause(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container unpause, docker unpause",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false, func(container types.Container) bool {
 			return container.State == "paused"
 		}),

cli/command/container/update.go

@@ -49,6 +49,9 @@ func NewUpdateCommand(dockerCli command.Cli) *cobra.Command {
 			options.nFlag = cmd.Flags().NFlag()
 			return runUpdate(dockerCli, &options)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container update, docker update",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, true),
 	}
 

cli/command/container/wait.go

@@ -28,6 +28,9 @@ func NewWaitCommand(dockerCli command.Cli) *cobra.Command {
 			opts.containers = args
 			return runWait(dockerCli, &opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker container wait, docker wait",
+		},
 		ValidArgsFunction: completion.ContainerNames(dockerCli, false),
 	}
 

cli/command/image/build.go

@@ -107,6 +107,7 @@ func NewBuildCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "4",
+			"aliases":      "docker image build, docker build, docker buildx build, docker builder build",
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			return nil, cobra.ShellCompDirectiveFilterDirs

cli/command/image/history.go

@@ -31,6 +31,9 @@ func NewHistoryCommand(dockerCli command.Cli) *cobra.Command {
 			opts.image = args[0]
 			return runHistory(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image history, docker history",
+		},
 	}
 
 	flags := cmd.Flags()

cli/command/image/import.go

@@ -36,6 +36,9 @@ func NewImportCommand(dockerCli command.Cli) *cobra.Command {
 			}
 			return runImport(dockerCli, options)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image import, docker import",
+		},
 	}
 
 	flags := cmd.Flags()

cli/command/image/list.go

@@ -39,6 +39,7 @@ func NewImagesCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "7",
+			"aliases":      "docker image ls, docker image list, docker images",
 		},
 	}
 

cli/command/image/load.go

@@ -29,6 +29,9 @@ func NewLoadCommand(dockerCli command.Cli) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runLoad(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image load, docker load",
+		},
 		ValidArgsFunction: completion.NoComplete,
 	}
 

cli/command/image/pull.go

@@ -37,6 +37,7 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "5",
+			"aliases":      "docker image pull, docker pull",
 		},
 		ValidArgsFunction: completion.NoComplete,
 	}

cli/command/image/push.go

@@ -38,6 +38,7 @@ func NewPushCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "6",
+			"aliases":      "docker image push, docker push",
 		},
 		ValidArgsFunction: completion.ImageNames(dockerCli),
 	}

cli/command/image/remove.go

@@ -29,6 +29,9 @@ func NewRemoveCommand(dockerCli command.Cli) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runRemove(dockerCli, opts, args)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image rm, docker image remove, docker rmi",
+		},
 	}
 
 	flags := cmd.Flags()

cli/command/image/save.go

@@ -28,6 +28,9 @@ func NewSaveCommand(dockerCli command.Cli) *cobra.Command {
 			opts.images = args
 			return RunSave(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image save, docker save",
+		},
 		ValidArgsFunction: completion.ImageNames(dockerCli),
 	}
 

cli/command/image/tag.go

@@ -27,6 +27,9 @@ func NewTagCommand(dockerCli command.Cli) *cobra.Command {
 			opts.name = args[1]
 			return runTag(dockerCli, opts)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker image tag, docker tag",
+		},
 		ValidArgsFunction: completion.ImageNames(dockerCli),
 	}
 

cli/command/system/events.go

@@ -37,6 +37,9 @@ func NewEventsCommand(dockerCli command.Cli) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runEvents(dockerCli, &options)
 		},
+		Annotations: map[string]string{
+			"aliases": "docker system events, docker events",
+		},
 		ValidArgsFunction: completion.NoComplete,
 	}
 

cli/command/system/info.go

@@ -57,6 +57,7 @@ func NewInfoCommand(dockerCli command.Cli) *cobra.Command {
 		},
 		Annotations: map[string]string{
 			"category-top": "12",
+			"aliases":      "docker system info, docker info",
 		},
 		ValidArgsFunction: completion.NoComplete,
 	}