Skip to content

Commit b993609

Browse files
dnephindnephin
committed
Move canonical image and container commands into a command group
Hide some top level commands Add docker container and image inspect commands. Signed-off-by: Daniel Nephin <[email protected]>
1 parent 9d2d89c commit b993609

9 files changed

Lines changed: 242 additions & 35 deletions

File tree

‎cli/command/commands/commands.go‎

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,49 +25,58 @@ func AddCommands(cmd *cobra.Command, dockerCli *command.DockerCli) {
2525
stack.NewStackCommand(dockerCli),
2626
stack.NewTopLevelDeployCommand(dockerCli),
2727
swarm.NewSwarmCommand(dockerCli),
28-
container.NewAttachCommand(dockerCli),
29-
container.NewCommitCommand(dockerCli),
30-
container.NewCopyCommand(dockerCli),
31-
container.NewCreateCommand(dockerCli),
32-
container.NewDiffCommand(dockerCli),
33-
container.NewExecCommand(dockerCli),
34-
container.NewExportCommand(dockerCli),
35-
container.NewKillCommand(dockerCli),
36-
container.NewLogsCommand(dockerCli),
37-
container.NewPauseCommand(dockerCli),
38-
container.NewPortCommand(dockerCli),
39-
container.NewPsCommand(dockerCli),
40-
container.NewRenameCommand(dockerCli),
41-
container.NewRestartCommand(dockerCli),
42-
container.NewRmCommand(dockerCli),
28+
container.NewContainerCommand(dockerCli),
29+
image.NewImageCommand(dockerCli),
4330
container.NewRunCommand(dockerCli),
44-
container.NewStartCommand(dockerCli),
45-
container.NewStatsCommand(dockerCli),
46-
container.NewStopCommand(dockerCli),
47-
container.NewTopCommand(dockerCli),
48-
container.NewUnpauseCommand(dockerCli),
49-
container.NewUpdateCommand(dockerCli),
50-
container.NewWaitCommand(dockerCli),
5131
image.NewBuildCommand(dockerCli),
52-
image.NewHistoryCommand(dockerCli),
53-
image.NewImagesCommand(dockerCli),
54-
image.NewLoadCommand(dockerCli),
55-
image.NewRemoveCommand(dockerCli),
56-
image.NewSaveCommand(dockerCli),
57-
image.NewPullCommand(dockerCli),
58-
image.NewPushCommand(dockerCli),
59-
image.NewSearchCommand(dockerCli),
60-
image.NewImportCommand(dockerCli),
61-
image.NewTagCommand(dockerCli),
6232
network.NewNetworkCommand(dockerCli),
6333
system.NewEventsCommand(dockerCli),
64-
system.NewInspectCommand(dockerCli),
6534
registry.NewLoginCommand(dockerCli),
6635
registry.NewLogoutCommand(dockerCli),
6736
system.NewVersionCommand(dockerCli),
6837
volume.NewVolumeCommand(dockerCli),
6938
system.NewInfoCommand(dockerCli),
39+
hide(container.NewAttachCommand(dockerCli)),
40+
hide(container.NewCommitCommand(dockerCli)),
41+
hide(container.NewCopyCommand(dockerCli)),
42+
hide(container.NewCreateCommand(dockerCli)),
43+
hide(container.NewDiffCommand(dockerCli)),
44+
hide(container.NewExecCommand(dockerCli)),
45+
hide(container.NewExportCommand(dockerCli)),
46+
hide(container.NewKillCommand(dockerCli)),
47+
hide(container.NewLogsCommand(dockerCli)),
48+
hide(container.NewPauseCommand(dockerCli)),
49+
hide(container.NewPortCommand(dockerCli)),
50+
hide(container.NewPsCommand(dockerCli)),
51+
hide(container.NewRenameCommand(dockerCli)),
52+
hide(container.NewRestartCommand(dockerCli)),
53+
hide(container.NewRmCommand(dockerCli)),
54+
hide(container.NewStartCommand(dockerCli)),
55+
hide(container.NewStatsCommand(dockerCli)),
56+
hide(container.NewStopCommand(dockerCli)),
57+
hide(container.NewTopCommand(dockerCli)),
58+
hide(container.NewUnpauseCommand(dockerCli)),
59+
hide(container.NewUpdateCommand(dockerCli)),
60+
hide(container.NewWaitCommand(dockerCli)),
61+
hide(image.NewHistoryCommand(dockerCli)),
62+
hide(image.NewImagesCommand(dockerCli)),
63+
hide(image.NewImportCommand(dockerCli)),
64+
hide(image.NewLoadCommand(dockerCli)),
65+
hide(image.NewPullCommand(dockerCli)),
66+
hide(image.NewPushCommand(dockerCli)),
67+
hide(image.NewRemoveCommand(dockerCli)),
68+
hide(image.NewSaveCommand(dockerCli)),
69+
hide(image.NewSearchCommand(dockerCli)),
70+
hide(image.NewTagCommand(dockerCli)),
71+
hide(system.NewInspectCommand(dockerCli)),
7072
)
7173
checkpoint.NewCheckpointCommand(cmd, dockerCli)
7274
plugin.NewPluginCommand(cmd, dockerCli)
7375
}
76+
77+
func hide(cmd *cobra.Command) *cobra.Command {
78+
cmdCopy := *cmd
79+
cmdCopy.Hidden = true
80+
cmdCopy.Aliases = []string{}
81+
return &cmdCopy
82+
}

‎cli/command/container/cmd.go‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
package container
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/spf13/cobra"
7+
8+
"github.com/docker/docker/cli"
9+
"github.com/docker/docker/cli/command"
10+
)
11+
12+
// NewContainerCommand returns a cobra command for `container` subcommands
13+
func NewContainerCommand(dockerCli *command.DockerCli) *cobra.Command {
14+
cmd := &cobra.Command{
15+
Use: "container",
16+
Short: "Manage Docker containers",
17+
Args: cli.NoArgs,
18+
Run: func(cmd *cobra.Command, args []string) {
19+
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())
20+
},
21+
}
22+
cmd.AddCommand(
23+
NewAttachCommand(dockerCli),
24+
NewCommitCommand(dockerCli),
25+
NewCopyCommand(dockerCli),
26+
NewCreateCommand(dockerCli),
27+
NewDiffCommand(dockerCli),
28+
NewExecCommand(dockerCli),
29+
NewExportCommand(dockerCli),
30+
NewKillCommand(dockerCli),
31+
NewLogsCommand(dockerCli),
32+
NewPauseCommand(dockerCli),
33+
NewPortCommand(dockerCli),
34+
NewRenameCommand(dockerCli),
35+
NewRestartCommand(dockerCli),
36+
NewRmCommand(dockerCli),
37+
NewRunCommand(dockerCli),
38+
NewStartCommand(dockerCli),
39+
NewStatsCommand(dockerCli),
40+
NewStopCommand(dockerCli),
41+
NewTopCommand(dockerCli),
42+
NewUnpauseCommand(dockerCli),
43+
NewUpdateCommand(dockerCli),
44+
NewWaitCommand(dockerCli),
45+
newListCommand(dockerCli),
46+
newInspectCommand(dockerCli),
47+
)
48+
return cmd
49+
}

‎cli/command/container/inspect.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package container
2+
3+
import (
4+
"golang.org/x/net/context"
5+
6+
"github.com/docker/docker/cli"
7+
"github.com/docker/docker/cli/command"
8+
"github.com/docker/docker/cli/command/inspect"
9+
"github.com/spf13/cobra"
10+
)
11+
12+
type inspectOptions struct {
13+
format string
14+
size bool
15+
refs []string
16+
}
17+
18+
// newInspectCommand creates a new cobra.Command for `docker container inspect`
19+
func newInspectCommand(dockerCli *command.DockerCli) *cobra.Command {
20+
var opts inspectOptions
21+
22+
cmd := &cobra.Command{
23+
Use: "inspect [OPTIONS] CONTAINER [CONTAINER...]",
24+
Short: "Display detailed information on one or more containers",
25+
Args: cli.RequiresMinArgs(1),
26+
RunE: func(cmd *cobra.Command, args []string) error {
27+
opts.refs = args
28+
return runInspect(dockerCli, opts)
29+
},
30+
}
31+
32+
flags := cmd.Flags()
33+
flags.StringVarP(&opts.format, "format", "f", "", "Format the output using the given go template")
34+
flags.BoolVarP(&opts.size, "size", "s", false, "Display total file sizes")
35+
36+
return cmd
37+
}
38+
39+
func runInspect(dockerCli *command.DockerCli, opts inspectOptions) error {
40+
client := dockerCli.Client()
41+
ctx := context.Background()
42+
43+
getRefFunc := func(ref string) (interface{}, []byte, error) {
44+
return client.ContainerInspectWithRaw(ctx, ref, opts.size)
45+
}
46+
return inspect.Inspect(dockerCli.Out(), opts.refs, opts.format, getRefFunc)
47+
}

cli/command/container/ps.go renamed to cli/command/container/list.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ func NewPsCommand(dockerCli *command.DockerCli) *cobra.Command {
5252
return cmd
5353
}
5454

55+
func newListCommand(dockerCli *command.DockerCli) *cobra.Command {
56+
cmd := *NewPsCommand(dockerCli)
57+
cmd.Aliases = []string{"ps", "list"}
58+
cmd.Use = "ls [OPTIONS]"
59+
return &cmd
60+
}
61+
5562
type preProcessor struct {
5663
types.Container
5764
opts *types.ContainerListOptions

‎cli/command/image/cmd.go‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
package image
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/spf13/cobra"
7+
8+
"github.com/docker/docker/cli"
9+
"github.com/docker/docker/cli/command"
10+
)
11+
12+
// NewImageCommand returns a cobra command for `image` subcommands
13+
func NewImageCommand(dockerCli *command.DockerCli) *cobra.Command {
14+
cmd := &cobra.Command{
15+
Use: "image",
16+
Short: "Manage Docker images",
17+
Args: cli.NoArgs,
18+
Run: func(cmd *cobra.Command, args []string) {
19+
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())
20+
},
21+
}
22+
cmd.AddCommand(
23+
NewBuildCommand(dockerCli),
24+
NewHistoryCommand(dockerCli),
25+
NewImportCommand(dockerCli),
26+
NewLoadCommand(dockerCli),
27+
NewPullCommand(dockerCli),
28+
NewPushCommand(dockerCli),
29+
NewSaveCommand(dockerCli),
30+
NewSearchCommand(dockerCli),
31+
NewTagCommand(dockerCli),
32+
newListCommand(dockerCli),
33+
newRemoveCommand(dockerCli),
34+
newInspectCommand(dockerCli),
35+
)
36+
return cmd
37+
}

‎cli/command/image/inspect.go‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
package image
2+
3+
import (
4+
"golang.org/x/net/context"
5+
6+
"github.com/docker/docker/cli"
7+
"github.com/docker/docker/cli/command"
8+
"github.com/docker/docker/cli/command/inspect"
9+
"github.com/spf13/cobra"
10+
)
11+
12+
type inspectOptions struct {
13+
format string
14+
refs []string
15+
}
16+
17+
// newInspectCommand creates a new cobra.Command for `docker image inspect`
18+
func newInspectCommand(dockerCli *command.DockerCli) *cobra.Command {
19+
var opts inspectOptions
20+
21+
cmd := &cobra.Command{
22+
Use: "inspect [OPTIONS] IMAGE [IMAGE...]",
23+
Short: "Display detailed information on one or more images",
24+
Args: cli.RequiresMinArgs(1),
25+
RunE: func(cmd *cobra.Command, args []string) error {
26+
opts.refs = args
27+
return runInspect(dockerCli, opts)
28+
},
29+
}
30+
31+
flags := cmd.Flags()
32+
flags.StringVarP(&opts.format, "format", "f", "", "Format the output using the given go template")
33+
return cmd
34+
}
35+
36+
func runInspect(dockerCli *command.DockerCli, opts inspectOptions) error {
37+
client := dockerCli.Client()
38+
ctx := context.Background()
39+
40+
getRefFunc := func(ref string) (interface{}, []byte, error) {
41+
return client.ImageInspectWithRaw(ctx, ref)
42+
}
43+
return inspect.Inspect(dockerCli.Out(), opts.refs, opts.format, getRefFunc)
44+
}

cli/command/image/images.go renamed to cli/command/image/list.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ func NewImagesCommand(dockerCli *command.DockerCli) *cobra.Command {
5050
return cmd
5151
}
5252

53+
func newListCommand(dockerCli *command.DockerCli) *cobra.Command {
54+
cmd := *NewImagesCommand(dockerCli)
55+
cmd.Aliases = []string{"images", "list"}
56+
cmd.Use = "ls [OPTIONS] [REPOSITORY[:TAG]]"
57+
return &cmd
58+
}
59+
5360
func runImages(dockerCli *command.DockerCli, opts imagesOptions) error {
5461
ctx := context.Background()
5562

‎cli/command/image/remove.go‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ func NewRemoveCommand(dockerCli *command.DockerCli) *cobra.Command {
3838
return cmd
3939
}
4040

41+
func newRemoveCommand(dockerCli *command.DockerCli) *cobra.Command {
42+
cmd := *NewRemoveCommand(dockerCli)
43+
cmd.Aliases = []string{"rmi", "remove"}
44+
cmd.Use = "rm [OPTIONS] IMAGE [IMAGE...]"
45+
return &cmd
46+
}
47+
4148
func runRemove(dockerCli *command.DockerCli, opts removeOptions, images []string) error {
4249
client := dockerCli.Client()
4350
ctx := context.Background()

‎cli/command/stack/cmd.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ func NewStackCommand(dockerCli *command.DockerCli) *cobra.Command {
3232

3333
// NewTopLevelDeployCommand returns a command for `docker deploy`
3434
func NewTopLevelDeployCommand(dockerCli *command.DockerCli) *cobra.Command {
35-
cmd := newDeployCommand(dockerCli)
35+
cmd := *newDeployCommand(dockerCli)
3636
// Remove the aliases at the top level
3737
cmd.Aliases = []string{}
38-
return cmd
38+
return &cmd
3939
}

0 commit comments

Comments
 (0)