Merge pull request #207 from WeiZhang555/provide-help

Provide more useful help information for ctr
This commit is contained in:
Michael Crosby 2016-04-18 10:52:47 -07:00
commit e49fcf514e
3 changed files with 44 additions and 23 deletions

View file

@ -14,7 +14,7 @@ The included `ctr` command-line tool allows you interact with the containerd dae
$ sudo ctr containers start redis /containers/redis $ sudo ctr containers start redis /containers/redis
$ sudo ctr containers list $ sudo ctr containers list
ID PATH STATUS PROCESSES ID PATH STATUS PROCESSES
1 /containers/redis running 14063 redis /containers/redis running 14063
``` ```
`/containers/redis` is the path to an OCI bundle. [See the docs for more information.](docs/bundle.md) `/containers/redis` is the path to an OCI bundle. [See the docs for more information.](docs/bundle.md)

View file

@ -10,14 +10,24 @@ import (
netcontext "golang.org/x/net/context" netcontext "golang.org/x/net/context"
) )
var checkpointCommand = cli.Command{ var checkpointSubCmds = []cli.Command{
Name: "checkpoints",
Usage: "list all checkpoints",
Subcommands: []cli.Command{
listCheckpointCommand, listCheckpointCommand,
createCheckpointCommand, createCheckpointCommand,
deleteCheckpointCommand, deleteCheckpointCommand,
}, }
var checkpointCommand = cli.Command{
Name: "checkpoints",
Usage: "list all checkpoints",
ArgsUsage: "COMMAND [arguments...]",
Subcommands: checkpointSubCmds,
Description: func() string {
desc := "\n COMMAND:\n"
for _, command := range checkpointSubCmds {
desc += fmt.Sprintf(" %-10.10s%s\n", command.Name, command.Usage)
}
return desc
}(),
Action: listCheckpoints, Action: listCheckpoints,
} }

View file

@ -41,10 +41,7 @@ func getClient(ctx *cli.Context) types.APIClient {
return types.NewAPIClient(conn) return types.NewAPIClient(conn)
} }
var containersCommand = cli.Command{ var contSubCmds = []cli.Command{
Name: "containers",
Usage: "interact with running containers",
Subcommands: []cli.Command{
execCommand, execCommand,
killCommand, killCommand,
listCommand, listCommand,
@ -54,7 +51,20 @@ var containersCommand = cli.Command{
statsCommand, statsCommand,
watchCommand, watchCommand,
updateCommand, updateCommand,
}, }
var containersCommand = cli.Command{
Name: "containers",
Usage: "interact with running containers",
ArgsUsage: "COMMAND [arguments...]",
Subcommands: contSubCmds,
Description: func() string {
desc := "\n COMMAND:\n"
for _, command := range contSubCmds {
desc += fmt.Sprintf(" %-10.10s%s\n", command.Name, command.Usage)
}
return desc
}(),
Action: listContainers, Action: listContainers,
} }
@ -109,6 +119,7 @@ func listContainers(context *cli.Context) {
var startCommand = cli.Command{ var startCommand = cli.Command{
Name: "start", Name: "start",
Usage: "start a container", Usage: "start a container",
ArgsUsage: "ID BundlePath",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "checkpoint,c", Name: "checkpoint,c",