80b1285fec
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
69 lines
1.6 KiB
Go
69 lines
1.6 KiB
Go
package image
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/formatter"
|
|
flagsHelper "github.com/docker/cli/cli/flags"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type historyOptions struct {
|
|
image string
|
|
|
|
human bool
|
|
quiet bool
|
|
noTrunc bool
|
|
format string
|
|
}
|
|
|
|
// NewHistoryCommand creates a new `docker history` command
|
|
func NewHistoryCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts historyOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "history [OPTIONS] IMAGE",
|
|
Short: "Show the history of an image",
|
|
Args: cli.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.image = args[0]
|
|
return runHistory(dockerCli, opts)
|
|
},
|
|
Annotations: map[string]string{
|
|
"aliases": "docker image history, docker history",
|
|
},
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
|
|
flags.BoolVarP(&opts.human, "human", "H", true, "Print sizes and dates in human readable format")
|
|
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Only show image IDs")
|
|
flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Don't truncate output")
|
|
flags.StringVar(&opts.format, "format", "", flagsHelper.FormatHelp)
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runHistory(dockerCli command.Cli, opts historyOptions) error {
|
|
ctx := context.Background()
|
|
|
|
history, err := dockerCli.Client().ImageHistory(ctx, opts.image)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
format := opts.format
|
|
if len(format) == 0 {
|
|
format = formatter.TableFormatKey
|
|
}
|
|
|
|
historyCtx := formatter.Context{
|
|
Output: dockerCli.Out(),
|
|
Format: NewHistoryFormat(format, opts.quiet, opts.human),
|
|
Trunc: !opts.noTrunc,
|
|
}
|
|
return HistoryWrite(historyCtx, opts.human, history)
|
|
}
|