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>
68 lines
1.6 KiB
Go
68 lines
1.6 KiB
Go
package container
|
|
|
|
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 exportOptions struct {
|
|
container string
|
|
output string
|
|
}
|
|
|
|
// NewExportCommand creates a new `docker export` command
|
|
func NewExportCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts exportOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "export [OPTIONS] CONTAINER",
|
|
Short: "Export a container's filesystem as a tar archive",
|
|
Args: cli.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.container = args[0]
|
|
return runExport(dockerCli, opts)
|
|
},
|
|
Annotations: map[string]string{
|
|
"aliases": "docker container export, docker export",
|
|
},
|
|
ValidArgsFunction: completion.ContainerNames(dockerCli, true),
|
|
}
|
|
|
|
flags := cmd.Flags()
|
|
|
|
flags.StringVarP(&opts.output, "output", "o", "", "Write to a file, instead of STDOUT")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runExport(dockerCli command.Cli, opts exportOptions) 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 export container")
|
|
}
|
|
|
|
clnt := dockerCli.Client()
|
|
|
|
responseBody, err := clnt.ContainerExport(context.Background(), opts.container)
|
|
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)
|
|
}
|