aaa912c9f7
This adds a new annotation to commands that are known to be frequently used, and allows setting a custom weight/order for these commands to influence in what order they appear in the --help output. I'm not entirely happy with the implementation (we could at least use some helpers for this, and/or make it more generic to group commands in output), but it could be a start. For now, limiting this to only be used for the top-level --help, but we can expand this to subcommands as well if we think it makes sense to highlight "common" / "commonly used" commands. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
101 lines
2.6 KiB
Go
101 lines
2.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/docker/cli/opts"
|
|
"github.com/docker/docker/api/types"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type imagesOptions struct {
|
|
matchName string
|
|
|
|
quiet bool
|
|
all bool
|
|
noTrunc bool
|
|
showDigests bool
|
|
format string
|
|
filter opts.FilterOpt
|
|
}
|
|
|
|
// NewImagesCommand creates a new `docker images` command
|
|
func NewImagesCommand(dockerCli command.Cli) *cobra.Command {
|
|
options := imagesOptions{filter: opts.NewFilterOpt()}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "images [OPTIONS] [REPOSITORY[:TAG]]",
|
|
Short: "List images",
|
|
Args: cli.RequiresMaxArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
if len(args) > 0 {
|
|
options.matchName = args[0]
|
|
}
|
|
return runImages(dockerCli, options)
|
|
},
|
|
Annotations: map[string]string{
|
|
"category-top": "7",
|
|
},
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
|
|
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Only show image IDs")
|
|
flags.BoolVarP(&options.all, "all", "a", false, "Show all images (default hides intermediate images)")
|
|
flags.BoolVar(&options.noTrunc, "no-trunc", false, "Don't truncate output")
|
|
flags.BoolVar(&options.showDigests, "digests", false, "Show digests")
|
|
flags.StringVar(&options.format, "format", "", flagsHelper.FormatHelp)
|
|
flags.VarP(&options.filter, "filter", "f", "Filter output based on conditions provided")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func newListCommand(dockerCli command.Cli) *cobra.Command {
|
|
cmd := *NewImagesCommand(dockerCli)
|
|
cmd.Aliases = []string{"list"}
|
|
cmd.Use = "ls [OPTIONS] [REPOSITORY[:TAG]]"
|
|
return &cmd
|
|
}
|
|
|
|
func runImages(dockerCli command.Cli, options imagesOptions) error {
|
|
ctx := context.Background()
|
|
|
|
filters := options.filter.Value()
|
|
if options.matchName != "" {
|
|
filters.Add("reference", options.matchName)
|
|
}
|
|
|
|
listOptions := types.ImageListOptions{
|
|
All: options.all,
|
|
Filters: filters,
|
|
}
|
|
|
|
images, err := dockerCli.Client().ImageList(ctx, listOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
format := options.format
|
|
if len(format) == 0 {
|
|
if len(dockerCli.ConfigFile().ImagesFormat) > 0 && !options.quiet {
|
|
format = dockerCli.ConfigFile().ImagesFormat
|
|
} else {
|
|
format = formatter.TableFormatKey
|
|
}
|
|
}
|
|
|
|
imageCtx := formatter.ImageContext{
|
|
Context: formatter.Context{
|
|
Output: dockerCli.Out(),
|
|
Format: formatter.NewImageFormat(format, options.quiet, options.showDigests),
|
|
Trunc: !options.noTrunc,
|
|
},
|
|
Digest: options.showDigests,
|
|
}
|
|
return formatter.ImageWrite(imageCtx, images)
|
|
}
|