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>
67 lines
1.7 KiB
Go
67 lines
1.7 KiB
Go
package image
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/completion"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type saveOptions struct {
|
|
images []string
|
|
output string
|
|
}
|
|
|
|
// NewSaveCommand creates a new `docker save` command
|
|
func NewSaveCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts saveOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "save [OPTIONS] IMAGE [IMAGE...]",
|
|
Short: "Save one or more images to a tar archive (streamed to STDOUT by default)",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.images = args
|
|
return RunSave(dockerCli, opts)
|
|
},
|
|
Annotations: map[string]string{
|
|
"aliases": "docker image save, docker save",
|
|
},
|
|
ValidArgsFunction: completion.ImageNames(dockerCli),
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
|
|
flags.StringVarP(&opts.output, "output", "o", "", "Write to a file, instead of STDOUT")
|
|
|
|
return cmd
|
|
}
|
|
|
|
// RunSave performs a save against the engine based on the specified options
|
|
func RunSave(dockerCli command.Cli, opts saveOptions) error {
|
|
if opts.output == "" && dockerCli.Out().IsTerminal() {
|
|
return errors.New("cowardly refusing to save to a terminal. Use the -o flag or redirect")
|
|
}
|
|
|
|
if err := command.ValidateOutputPath(opts.output); err != nil {
|
|
return errors.Wrap(err, "failed to save image")
|
|
}
|
|
|
|
responseBody, err := dockerCli.Client().ImageSave(context.Background(), opts.images)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer responseBody.Close()
|
|
|
|
if opts.output == "" {
|
|
_, err := io.Copy(dockerCli.Out(), responseBody)
|
|
return err
|
|
}
|
|
|
|
return command.CopyToFile(opts.output, responseBody)
|
|
}
|