Merge pull request #8232 from panguicai008/flag-usage

Flag usage uses uppercase letters
This commit is contained in:
Derek McGowan 2023-03-09 10:34:32 -08:00 committed by GitHub
commit 0fe3b496d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 84 additions and 84 deletions

View File

@ -82,7 +82,7 @@ containerd CLI
}, },
cli.StringFlag{ cli.StringFlag{
Name: "address, a", Name: "address, a",
Usage: "address for containerd's GRPC server", Usage: "Address for containerd's GRPC server",
Value: defaults.DefaultAddress, Value: defaults.DefaultAddress,
EnvVar: "CONTAINERD_ADDRESS", EnvVar: "CONTAINERD_ADDRESS",
}, },
@ -96,7 +96,7 @@ containerd CLI
}, },
cli.StringFlag{ cli.StringFlag{
Name: "namespace, n", Name: "namespace, n",
Usage: "namespace to use with commands", Usage: "Namespace to use with commands",
Value: namespaces.Default, Value: namespaces.Default,
EnvVar: namespaces.NamespaceEnvVar, EnvVar: namespaces.NamespaceEnvVar,
}, },

View File

@ -32,7 +32,7 @@ var (
SnapshotterFlags = []cli.Flag{ SnapshotterFlags = []cli.Flag{
cli.StringFlag{ cli.StringFlag{
Name: "snapshotter", Name: "snapshotter",
Usage: "snapshotter name. Empty value stands for the default value.", Usage: "Snapshotter name. Empty value stands for the default value.",
EnvVar: "CONTAINERD_SNAPSHOTTER", EnvVar: "CONTAINERD_SNAPSHOTTER",
}, },
} }

View File

@ -28,7 +28,7 @@ import (
var checkpointCommand = cli.Command{ var checkpointCommand = cli.Command{
Name: "checkpoint", Name: "checkpoint",
Usage: "checkpoint a container", Usage: "Checkpoint a container",
ArgsUsage: "CONTAINER REF", ArgsUsage: "CONTAINER REF",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{

View File

@ -37,7 +37,7 @@ import (
// Command is the cli command for managing containers // Command is the cli command for managing containers
var Command = cli.Command{ var Command = cli.Command{
Name: "containers", Name: "containers",
Usage: "manage containers", Usage: "Manage containers",
Aliases: []string{"c", "container"}, Aliases: []string{"c", "container"},
Subcommands: []cli.Command{ Subcommands: []cli.Command{
createCommand, createCommand,
@ -52,7 +52,7 @@ var Command = cli.Command{
var createCommand = cli.Command{ var createCommand = cli.Command{
Name: "create", Name: "create",
Usage: "create container", Usage: "Create container",
ArgsUsage: "[flags] Image|RootFS CONTAINER [COMMAND] [ARG...]", ArgsUsage: "[flags] Image|RootFS CONTAINER [COMMAND] [ARG...]",
SkipArgReorder: true, SkipArgReorder: true,
Flags: append(append(commands.SnapshotterFlags, []cli.Flag{commands.SnapshotterLabels}...), commands.ContainerFlags...), Flags: append(append(commands.SnapshotterFlags, []cli.Flag{commands.SnapshotterLabels}...), commands.ContainerFlags...),
@ -94,7 +94,7 @@ var createCommand = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list containers", Usage: "List containers",
ArgsUsage: "[flags] [<filter>, ...]", ArgsUsage: "[flags] [<filter>, ...]",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
@ -147,7 +147,7 @@ var listCommand = cli.Command{
var deleteCommand = cli.Command{ var deleteCommand = cli.Command{
Name: "delete", Name: "delete",
Usage: "delete one or more existing containers", Usage: "Delete one or more existing containers",
ArgsUsage: "[flags] CONTAINER [CONTAINER, ...]", ArgsUsage: "[flags] CONTAINER [CONTAINER, ...]",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -208,7 +208,7 @@ func deleteContainer(ctx context.Context, client *containerd.Client, id string,
var setLabelsCommand = cli.Command{ var setLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "set and clear labels for a container", Usage: "Set and clear labels for a container",
ArgsUsage: "[flags] CONTAINER [<key>=<value>, ...]", ArgsUsage: "[flags] CONTAINER [<key>=<value>, ...]",
Description: "set and clear labels for a container", Description: "set and clear labels for a container",
Flags: []cli.Flag{}, Flags: []cli.Flag{},
@ -246,7 +246,7 @@ var setLabelsCommand = cli.Command{
var infoCommand = cli.Command{ var infoCommand = cli.Command{
Name: "info", Name: "info",
Usage: "get info about a container", Usage: "Get info about a container",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{

View File

@ -31,7 +31,7 @@ import (
var restoreCommand = cli.Command{ var restoreCommand = cli.Command{
Name: "restore", Name: "restore",
Usage: "restore a container from checkpoint", Usage: "Restore a container from checkpoint",
ArgsUsage: "CONTAINER REF", ArgsUsage: "CONTAINER REF",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{

View File

@ -61,7 +61,7 @@ var (
getCommand = cli.Command{ getCommand = cli.Command{
Name: "get", Name: "get",
Usage: "get the data for an object", Usage: "Get the data for an object",
ArgsUsage: "[<digest>, ...]", ArgsUsage: "[<digest>, ...]",
Description: "display the image object", Description: "display the image object",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
@ -90,7 +90,7 @@ var (
ingestCommand = cli.Command{ ingestCommand = cli.Command{
Name: "ingest", Name: "ingest",
Usage: "accept content into the store", Usage: "Accept content into the store",
ArgsUsage: "[flags] <key>", ArgsUsage: "[flags] <key>",
Description: "ingest objects into the local content store", Description: "ingest objects into the local content store",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -132,13 +132,13 @@ var (
activeIngestCommand = cli.Command{ activeIngestCommand = cli.Command{
Name: "active", Name: "active",
Usage: "display active transfers", Usage: "Display active transfers",
ArgsUsage: "[flags] [<regexp>]", ArgsUsage: "[flags] [<regexp>]",
Description: "display the ongoing transfers", Description: "display the ongoing transfers",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.DurationFlag{ cli.DurationFlag{
Name: "timeout, t", Name: "timeout, t",
Usage: "total timeout for fetch", Usage: "Total timeout for fetch",
EnvVar: "CONTAINERD_FETCH_TIMEOUT", EnvVar: "CONTAINERD_FETCH_TIMEOUT",
}, },
cli.StringFlag{ cli.StringFlag{
@ -175,7 +175,7 @@ var (
listCommand = cli.Command{ listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list all blobs in the store", Usage: "List all blobs in the store",
ArgsUsage: "[flags]", ArgsUsage: "[flags]",
Description: "list blobs in the content store", Description: "list blobs in the content store",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -234,7 +234,7 @@ var (
setLabelsCommand = cli.Command{ setLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "add labels to content", Usage: "Add labels to content",
ArgsUsage: "<digest> [<label>=<value> ...]", ArgsUsage: "<digest> [<label>=<value> ...]",
Description: "labels blobs in the content store", Description: "labels blobs in the content store",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
@ -288,7 +288,7 @@ var (
editCommand = cli.Command{ editCommand = cli.Command{
Name: "edit", Name: "edit",
Usage: "edit a blob and return a new digest", Usage: "Edit a blob and return a new digest",
ArgsUsage: "[flags] <digest>", ArgsUsage: "[flags] <digest>",
Description: "edit a blob and return a new digest", Description: "edit a blob and return a new digest",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -298,7 +298,7 @@ var (
}, },
cli.StringFlag{ cli.StringFlag{
Name: "editor", Name: "editor",
Usage: "select editor (vim, emacs, etc.)", Usage: "Select editor (vim, emacs, etc.)",
EnvVar: "EDITOR", EnvVar: "EDITOR",
}, },
}, },
@ -358,7 +358,7 @@ var (
deleteCommand = cli.Command{ deleteCommand = cli.Command{
Name: "delete", Name: "delete",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
Usage: "permanently delete one or more blobs", Usage: "Permanently delete one or more blobs",
ArgsUsage: "[<digest>, ...]", ArgsUsage: "[<digest>, ...]",
Description: `Delete one or more blobs permanently. Successfully deleted Description: `Delete one or more blobs permanently. Successfully deleted
blobs are printed to stdout.`, blobs are printed to stdout.`,
@ -406,7 +406,7 @@ var (
// needed. // needed.
fetchObjectCommand = cli.Command{ fetchObjectCommand = cli.Command{
Name: "fetch-object", Name: "fetch-object",
Usage: "retrieve objects from a remote", Usage: "Retrieve objects from a remote",
ArgsUsage: "[flags] <remote> <object> [<hint>, ...]", ArgsUsage: "[flags] <remote> <object> [<hint>, ...]",
Description: `Fetch objects by identifier from a remote.`, Description: `Fetch objects by identifier from a remote.`,
Flags: commands.RegistryFlags, Flags: commands.RegistryFlags,
@ -448,7 +448,7 @@ var (
fetchBlobCommand = cli.Command{ fetchBlobCommand = cli.Command{
Name: "fetch-blob", Name: "fetch-blob",
Usage: "retrieve blobs from a remote", Usage: "Retrieve blobs from a remote",
ArgsUsage: "[flags] <remote> [<digest>, ...]", ArgsUsage: "[flags] <remote> [<digest>, ...]",
Description: `Fetch blobs by digests from a remote.`, Description: `Fetch blobs by digests from a remote.`,
Flags: commands.RegistryFlags, Flags: commands.RegistryFlags,
@ -502,7 +502,7 @@ var (
pushObjectCommand = cli.Command{ pushObjectCommand = cli.Command{
Name: "push-object", Name: "push-object",
Usage: "push an object to a remote", Usage: "Push an object to a remote",
ArgsUsage: "[flags] <remote> <object> <type>", ArgsUsage: "[flags] <remote> <object> <type>",
Description: `Push objects by identifier to a remote.`, Description: `Push objects by identifier to a remote.`,
Flags: commands.RegistryFlags, Flags: commands.RegistryFlags,

View File

@ -42,10 +42,10 @@ import (
var fetchCommand = cli.Command{ var fetchCommand = cli.Command{
Name: "fetch", Name: "fetch",
Usage: "fetch all content for an image into containerd", Usage: "Fetch all content for an image into containerd",
ArgsUsage: "[flags] <remote> <object>", ArgsUsage: "[flags] <remote> <object>",
Description: `Fetch an image into containerd. Description: `Fetch an image into containerd.
This command ensures that containerd has all the necessary resources to build This command ensures that containerd has all the necessary resources to build
an image's rootfs and convert the configuration to a runtime format supported an image's rootfs and convert the configuration to a runtime format supported
by containerd. by containerd.

View File

@ -34,7 +34,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "events", Name: "events",
Aliases: []string{"event"}, Aliases: []string{"event"},
Usage: "display containerd events", Usage: "Display containerd events",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)
if err != nil { if err != nil {

View File

@ -30,7 +30,7 @@ import (
var convertCommand = cli.Command{ var convertCommand = cli.Command{
Name: "convert", Name: "convert",
Usage: "convert an image", Usage: "Convert an image",
ArgsUsage: "[flags] <source_ref> <target_ref>", ArgsUsage: "[flags] <source_ref> <target_ref>",
Description: `Convert an image format. Description: `Convert an image format.

View File

@ -35,7 +35,7 @@ import (
var exportCommand = cli.Command{ var exportCommand = cli.Command{
Name: "export", Name: "export",
Usage: "export images", Usage: "Export images",
ArgsUsage: "[flags] <out> <image> ...", ArgsUsage: "[flags] <out> <image> ...",
Description: `Export images to an OCI tar archive. Description: `Export images to an OCI tar archive.
@ -64,7 +64,7 @@ When '--all-platforms' is given all images in a manifest list must be available.
}, },
cli.BoolTFlag{ cli.BoolTFlag{
Name: "local", Name: "local",
Usage: "run export locally rather than through transfer API", Usage: "Run export locally rather than through transfer API",
}, },
}, },
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {

View File

@ -37,7 +37,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "images", Name: "images",
Aliases: []string{"image", "i"}, Aliases: []string{"image", "i"},
Usage: "manage images", Usage: "Manage images",
Subcommands: cli.Commands{ Subcommands: cli.Commands{
checkCommand, checkCommand,
exportCommand, exportCommand,
@ -59,7 +59,7 @@ var Command = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list images known to containerd", Usage: "List images known to containerd",
ArgsUsage: "[flags] [<filter>, ...]", ArgsUsage: "[flags] [<filter>, ...]",
Description: "list images registered with containerd", Description: "list images registered with containerd",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -142,7 +142,7 @@ var listCommand = cli.Command{
var setLabelsCommand = cli.Command{ var setLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "set and clear labels for an image", Usage: "Set and clear labels for an image",
ArgsUsage: "[flags] <name> [<key>=<value>, ...]", ArgsUsage: "[flags] <name> [<key>=<value>, ...]",
Description: "set and clear labels for an image", Description: "set and clear labels for an image",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -201,7 +201,7 @@ var setLabelsCommand = cli.Command{
var checkCommand = cli.Command{ var checkCommand = cli.Command{
Name: "check", Name: "check",
Usage: "check existing images to ensure all content is available locally", Usage: "Check existing images to ensure all content is available locally",
ArgsUsage: "[flags] [<filter>, ...]", ArgsUsage: "[flags] [<filter>, ...]",
Description: "check existing images to ensure all content is available locally", Description: "check existing images to ensure all content is available locally",
Flags: append([]cli.Flag{ Flags: append([]cli.Flag{
@ -315,7 +315,7 @@ var checkCommand = cli.Command{
var removeCommand = cli.Command{ var removeCommand = cli.Command{
Name: "delete", Name: "delete",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
Usage: "remove one or more images by reference", Usage: "Remove one or more images by reference",
ArgsUsage: "[flags] <ref> [<ref>, ...]", ArgsUsage: "[flags] <ref> [<ref>, ...]",
Description: "remove one or more images by reference", Description: "remove one or more images by reference",
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -37,7 +37,7 @@ import (
var importCommand = cli.Command{ var importCommand = cli.Command{
Name: "import", Name: "import",
Usage: "import images", Usage: "Import images",
ArgsUsage: "[flags] <in>", ArgsUsage: "[flags] <in>",
Description: `Import images from a tar stream. Description: `Import images from a tar stream.
Implemented formats: Implemented formats:

View File

@ -32,7 +32,7 @@ import (
var mountCommand = cli.Command{ var mountCommand = cli.Command{
Name: "mount", Name: "mount",
Usage: "mount an image to a target path", Usage: "Mount an image to a target path",
ArgsUsage: "[flags] <ref> <target>", ArgsUsage: "[flags] <ref> <target>",
Description: `Mount an image rootfs to a specified path. Description: `Mount an image rootfs to a specified path.

View File

@ -41,7 +41,7 @@ import (
var pullCommand = cli.Command{ var pullCommand = cli.Command{
Name: "pull", Name: "pull",
Usage: "pull an image from a remote", Usage: "Pull an image from a remote",
ArgsUsage: "[flags] <ref>", ArgsUsage: "[flags] <ref>",
Description: `Fetch and prepare an image for use in containerd. Description: `Fetch and prepare an image for use in containerd.

View File

@ -46,7 +46,7 @@ import (
var pushCommand = cli.Command{ var pushCommand = cli.Command{
Name: "push", Name: "push",
Usage: "push an image to a remote", Usage: "Push an image to a remote",
ArgsUsage: "[flags] <remote> [<local>]", ArgsUsage: "[flags] <remote> [<local>]",
Description: `Pushes an image reference from containerd. Description: `Pushes an image reference from containerd.

View File

@ -28,7 +28,7 @@ import (
var tagCommand = cli.Command{ var tagCommand = cli.Command{
Name: "tag", Name: "tag",
Usage: "tag an image", Usage: "Tag an image",
ArgsUsage: "[flags] <source_ref> <target_ref> [<target_ref>, ...]", ArgsUsage: "[flags] <source_ref> <target_ref> [<target_ref>, ...]",
Description: `Tag an image for use in containerd.`, Description: `Tag an image for use in containerd.`,
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -38,7 +38,7 @@ var tagCommand = cli.Command{
}, },
cli.BoolTFlag{ cli.BoolTFlag{
Name: "local", Name: "local",
Usage: "run tag locally rather than through transfer API", Usage: "Run tag locally rather than through transfer API",
}, },
}, },
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {

View File

@ -28,7 +28,7 @@ import (
var unmountCommand = cli.Command{ var unmountCommand = cli.Command{
Name: "unmount", Name: "unmount",
Usage: "unmount the image from the target", Usage: "Unmount the image from the target",
ArgsUsage: "[flags] <target>", ArgsUsage: "[flags] <target>",
Description: "Unmount the image rootfs from the specified target.", Description: "Unmount the image rootfs from the specified target.",
Flags: append(append(commands.RegistryFlags, append(commands.SnapshotterFlags, commands.LabelFlag)...), Flags: append(append(commands.RegistryFlags, append(commands.SnapshotterFlags, commands.LabelFlag)...),

View File

@ -25,7 +25,7 @@ import (
// Command to install binary packages // Command to install binary packages
var Command = cli.Command{ var Command = cli.Command{
Name: "install", Name: "install",
Usage: "install a new package", Usage: "Install a new package",
ArgsUsage: "<ref>", ArgsUsage: "<ref>",
Description: "install a new package", Description: "install a new package",
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -44,7 +44,7 @@ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list all active leases", Usage: "List all active leases",
ArgsUsage: "[flags] <filter>", ArgsUsage: "[flags] <filter>",
Description: "list active leases by containerd", Description: "list active leases by containerd",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -101,7 +101,7 @@ var listCommand = cli.Command{
var createCommand = cli.Command{ var createCommand = cli.Command{
Name: "create", Name: "create",
Usage: "create lease", Usage: "Create lease",
ArgsUsage: "[flags] <label>=<value> ...", ArgsUsage: "[flags] <label>=<value> ...",
Description: "create a new lease", Description: "create a new lease",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -155,7 +155,7 @@ var createCommand = cli.Command{
var deleteCommand = cli.Command{ var deleteCommand = cli.Command{
Name: "delete", Name: "delete",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
Usage: "delete a lease", Usage: "Delete a lease",
ArgsUsage: "[flags] <lease id> ...", ArgsUsage: "[flags] <lease id> ...",
Description: "delete a lease", Description: "delete a lease",
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -34,7 +34,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "namespaces", Name: "namespaces",
Aliases: []string{"namespace", "ns"}, Aliases: []string{"namespace", "ns"},
Usage: "manage namespaces", Usage: "Manage namespaces",
Subcommands: cli.Commands{ Subcommands: cli.Commands{
createCommand, createCommand,
listCommand, listCommand,
@ -46,7 +46,7 @@ var Command = cli.Command{
var createCommand = cli.Command{ var createCommand = cli.Command{
Name: "create", Name: "create",
Aliases: []string{"c"}, Aliases: []string{"c"},
Usage: "create a new namespace", Usage: "Create a new namespace",
ArgsUsage: "<name> [<key>=<value>]", ArgsUsage: "<name> [<key>=<value>]",
Description: "create a new namespace. it must be unique", Description: "create a new namespace. it must be unique",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
@ -66,7 +66,7 @@ var createCommand = cli.Command{
var setLabelsCommand = cli.Command{ var setLabelsCommand = cli.Command{
Name: "label", Name: "label",
Usage: "set and clear labels for a namespace", Usage: "Set and clear labels for a namespace",
ArgsUsage: "<name> [<key>=<value>, ...]", ArgsUsage: "<name> [<key>=<value>, ...]",
Description: "set and clear labels for a namespace. empty value clears the label", Description: "set and clear labels for a namespace. empty value clears the label",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
@ -92,7 +92,7 @@ var setLabelsCommand = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list namespaces", Usage: "List namespaces",
ArgsUsage: "[flags]", ArgsUsage: "[flags]",
Description: "list namespaces", Description: "list namespaces",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -144,7 +144,7 @@ var listCommand = cli.Command{
var removeCommand = cli.Command{ var removeCommand = cli.Command{
Name: "remove", Name: "remove",
Aliases: []string{"rm"}, Aliases: []string{"rm"},
Usage: "remove one or more namespaces", Usage: "Remove one or more namespaces",
ArgsUsage: "<name> [<name>, ...]", ArgsUsage: "<name> [<name>, ...]",
Description: "remove one or more namespaces. for now, the namespace must be empty", Description: "remove one or more namespaces. for now, the namespace must be empty",
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -36,7 +36,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "plugins", Name: "plugins",
Aliases: []string{"plugin"}, Aliases: []string{"plugin"},
Usage: "provides information about containerd plugins", Usage: "Provides information about containerd plugins",
Subcommands: []cli.Command{ Subcommands: []cli.Command{
listCommand, listCommand,
}, },
@ -45,7 +45,7 @@ var Command = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "lists containerd plugins", Usage: "Lists containerd plugins",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "quiet,q", Name: "quiet,q",

View File

@ -133,7 +133,7 @@ var pprofProfileCommand = cli.Command{
var pprofTraceCommand = cli.Command{ var pprofTraceCommand = cli.Command{
Name: "trace", Name: "trace",
Usage: "collect execution trace", Usage: "Collect execution trace",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.DurationFlag{ cli.DurationFlag{
Name: "seconds,s", Name: "seconds,s",
@ -164,7 +164,7 @@ var pprofTraceCommand = cli.Command{
var pprofBlockCommand = cli.Command{ var pprofBlockCommand = cli.Command{
Name: "block", Name: "block",
Usage: "goroutine blocking profile", Usage: "Goroutine blocking profile",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.UintFlag{ cli.UintFlag{
Name: "debug", Name: "debug",

View File

@ -87,7 +87,7 @@ func parseMountFlag(m string) (specs.Mount, error) {
// Command runs a container // Command runs a container
var Command = cli.Command{ var Command = cli.Command{
Name: "run", Name: "run",
Usage: "run a container", Usage: "Run a container",
ArgsUsage: "[flags] Image|RootFS ID [COMMAND] [ARG...]", ArgsUsage: "[flags] Image|RootFS ID [COMMAND] [ARG...]",
SkipArgReorder: true, SkipArgReorder: true,
Flags: append([]cli.Flag{ Flags: append([]cli.Flag{

View File

@ -36,7 +36,7 @@ import (
var platformRunFlags = []cli.Flag{ var platformRunFlags = []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "isolated", Name: "isolated",
Usage: "run the container with vm isolation", Usage: "Run the container with vm isolation",
}, },
} }

View File

@ -34,7 +34,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "sandboxes", Name: "sandboxes",
Aliases: []string{"sandbox", "sb", "s"}, Aliases: []string{"sandbox", "sb", "s"},
Usage: "manage sandboxes", Usage: "Manage sandboxes",
Subcommands: cli.Commands{ Subcommands: cli.Commands{
runCommand, runCommand,
listCommand, listCommand,
@ -45,7 +45,7 @@ var Command = cli.Command{
var runCommand = cli.Command{ var runCommand = cli.Command{
Name: "run", Name: "run",
Aliases: []string{"create", "c", "r"}, Aliases: []string{"create", "c", "r"},
Usage: "run a new sandbox", Usage: "Run a new sandbox",
ArgsUsage: "[flags] <pod-config.json> <sandbox-id>", ArgsUsage: "[flags] <pod-config.json> <sandbox-id>",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
@ -100,7 +100,7 @@ var runCommand = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list sandboxes", Usage: "List sandboxes",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringSliceFlag{ cli.StringSliceFlag{
Name: "filters", Name: "filters",
@ -147,7 +147,7 @@ var removeCommand = cli.Command{
Name: "remove", Name: "remove",
Aliases: []string{"rm"}, Aliases: []string{"rm"},
ArgsUsage: "<id> [<id>, ...]", ArgsUsage: "<id> [<id>, ...]",
Usage: "remove sandboxes", Usage: "Remove sandboxes",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
Name: "force, f", Name: "force, f",

View File

@ -44,7 +44,7 @@ import (
var Command = cli.Command{ var Command = cli.Command{
Name: "snapshots", Name: "snapshots",
Aliases: []string{"snapshot"}, Aliases: []string{"snapshot"},
Usage: "manage snapshots", Usage: "Manage snapshots",
Flags: commands.SnapshotterFlags, Flags: commands.SnapshotterFlags,
Subcommands: cli.Commands{ Subcommands: cli.Commands{
commitCommand, commitCommand,
@ -65,7 +65,7 @@ var Command = cli.Command{
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
Usage: "list snapshots", Usage: "List snapshots",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)
if err != nil { if err != nil {
@ -93,7 +93,7 @@ var listCommand = cli.Command{
var diffCommand = cli.Command{ var diffCommand = cli.Command{
Name: "diff", Name: "diff",
Usage: "get the diff of two snapshots. the default second snapshot is the first snapshot's parent.", Usage: "Get the diff of two snapshots. the default second snapshot is the first snapshot's parent.",
ArgsUsage: "[flags] <idA> [<idB>]", ArgsUsage: "[flags] <idA> [<idB>]",
Flags: append([]cli.Flag{ Flags: append([]cli.Flag{
cli.StringFlag{ cli.StringFlag{
@ -195,7 +195,7 @@ func withMounts(ctx gocontext.Context, id string, sn snapshots.Snapshotter, f fu
var usageCommand = cli.Command{ var usageCommand = cli.Command{
Name: "usage", Name: "usage",
Usage: "usage snapshots", Usage: "Usage snapshots",
ArgsUsage: "[flags] [<key>, ...]", ArgsUsage: "[flags] [<key>, ...]",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{
@ -253,7 +253,7 @@ var removeCommand = cli.Command{
Name: "delete", Name: "delete",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
ArgsUsage: "<key> [<key>, ...]", ArgsUsage: "<key> [<key>, ...]",
Usage: "remove snapshots", Usage: "Remove snapshots",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)
if err != nil { if err != nil {
@ -274,7 +274,7 @@ var removeCommand = cli.Command{
var prepareCommand = cli.Command{ var prepareCommand = cli.Command{
Name: "prepare", Name: "prepare",
Usage: "prepare a snapshot from a committed snapshot", Usage: "Prepare a snapshot from a committed snapshot",
ArgsUsage: "[flags] <key> [<parent>]", ArgsUsage: "[flags] <key> [<parent>]",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
@ -325,7 +325,7 @@ var prepareCommand = cli.Command{
var viewCommand = cli.Command{ var viewCommand = cli.Command{
Name: "view", Name: "view",
Usage: "create a read-only snapshot from a committed snapshot", Usage: "Create a read-only snapshot from a committed snapshot",
ArgsUsage: "[flags] <key> [<parent>]", ArgsUsage: "[flags] <key> [<parent>]",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{
@ -373,7 +373,7 @@ var viewCommand = cli.Command{
var mountCommand = cli.Command{ var mountCommand = cli.Command{
Name: "mounts", Name: "mounts",
Aliases: []string{"m", "mount"}, Aliases: []string{"m", "mount"},
Usage: "mount gets mount commands for the snapshots", Usage: "Mount gets mount commands for the snapshots",
ArgsUsage: "<target> <key>", ArgsUsage: "<target> <key>",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
if context.NArg() != 2 { if context.NArg() != 2 {
@ -402,7 +402,7 @@ var mountCommand = cli.Command{
var commitCommand = cli.Command{ var commitCommand = cli.Command{
Name: "commit", Name: "commit",
Usage: "commit an active snapshot into the provided name", Usage: "Commit an active snapshot into the provided name",
ArgsUsage: "<key> <active>", ArgsUsage: "<key> <active>",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
if context.NArg() != 2 { if context.NArg() != 2 {
@ -455,7 +455,7 @@ var treeCommand = cli.Command{
var infoCommand = cli.Command{ var infoCommand = cli.Command{
Name: "info", Name: "info",
Usage: "get info about a snapshot", Usage: "Get info about a snapshot",
ArgsUsage: "<key>", ArgsUsage: "<key>",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
if context.NArg() != 1 { if context.NArg() != 1 {
@ -482,7 +482,7 @@ var infoCommand = cli.Command{
var setLabelCommand = cli.Command{ var setLabelCommand = cli.Command{
Name: "label", Name: "label",
Usage: "add labels to content", Usage: "Add labels to content",
ArgsUsage: "<name> [<label>=<value> ...]", ArgsUsage: "<name> [<label>=<value> ...]",
Description: "labels snapshots in the snapshotter", Description: "labels snapshots in the snapshotter",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
@ -531,7 +531,7 @@ var setLabelCommand = cli.Command{
var unpackCommand = cli.Command{ var unpackCommand = cli.Command{
Name: "unpack", Name: "unpack",
Usage: "unpack applies layers from a manifest to a snapshot", Usage: "Unpack applies layers from a manifest to a snapshot",
ArgsUsage: "[flags] <digest>", ArgsUsage: "[flags] <digest>",
Flags: commands.SnapshotterFlags, Flags: commands.SnapshotterFlags,
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {

View File

@ -26,7 +26,7 @@ import (
var attachCommand = cli.Command{ var attachCommand = cli.Command{
Name: "attach", Name: "attach",
Usage: "attach to the IO of a running container", Usage: "Attach to the IO of a running container",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)

View File

@ -30,7 +30,7 @@ import (
var checkpointCommand = cli.Command{ var checkpointCommand = cli.Command{
Name: "checkpoint", Name: "checkpoint",
Usage: "checkpoint a container", Usage: "Checkpoint a container",
ArgsUsage: "[flags] CONTAINER", ArgsUsage: "[flags] CONTAINER",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{

View File

@ -28,7 +28,7 @@ import (
var deleteCommand = cli.Command{ var deleteCommand = cli.Command{
Name: "delete", Name: "delete",
Usage: "delete one or more tasks", Usage: "Delete one or more tasks",
ArgsUsage: "CONTAINER [CONTAINER, ...]", ArgsUsage: "CONTAINER [CONTAINER, ...]",
Aliases: []string{"del", "remove", "rm"}, Aliases: []string{"del", "remove", "rm"},
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -33,7 +33,7 @@ import (
var execCommand = cli.Command{ var execCommand = cli.Command{
Name: "exec", Name: "exec",
Usage: "execute additional processes in an existing container", Usage: "Execute additional processes in an existing container",
ArgsUsage: "[flags] CONTAINER CMD [ARG...]", ArgsUsage: "[flags] CONTAINER CMD [ARG...]",
SkipArgReorder: true, SkipArgReorder: true,
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -63,7 +63,7 @@ func RemoveCniNetworkIfExist(ctx context.Context, container containerd.Container
var killCommand = cli.Command{ var killCommand = cli.Command{
Name: "kill", Name: "kill",
Usage: "signal a container (default: SIGTERM)", Usage: "Signal a container (default: SIGTERM)",
ArgsUsage: "[flags] CONTAINER", ArgsUsage: "[flags] CONTAINER",
Flags: []cli.Flag{ Flags: []cli.Flag{
cli.StringFlag{ cli.StringFlag{

View File

@ -28,7 +28,7 @@ import (
var listCommand = cli.Command{ var listCommand = cli.Command{
Name: "list", Name: "list",
Usage: "list tasks", Usage: "List tasks",
Aliases: []string{"ls"}, Aliases: []string{"ls"},
ArgsUsage: "[flags]", ArgsUsage: "[flags]",
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -40,7 +40,7 @@ const (
var metricsCommand = cli.Command{ var metricsCommand = cli.Command{
Name: "metrics", Name: "metrics",
Usage: "get a single data point of metrics for a task with the built-in Linux runtime", Usage: "Get a single data point of metrics for a task with the built-in Linux runtime",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Aliases: []string{"metric"}, Aliases: []string{"metric"},
Flags: []cli.Flag{ Flags: []cli.Flag{

View File

@ -23,7 +23,7 @@ import (
var pauseCommand = cli.Command{ var pauseCommand = cli.Command{
Name: "pause", Name: "pause",
Usage: "pause an existing container", Usage: "Pause an existing container",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)

View File

@ -29,7 +29,7 @@ import (
var psCommand = cli.Command{ var psCommand = cli.Command{
Name: "ps", Name: "ps",
Usage: "list processes for container", Usage: "List processes for container",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
id := context.Args().First() id := context.Args().First()

View File

@ -23,7 +23,7 @@ import (
var resumeCommand = cli.Command{ var resumeCommand = cli.Command{
Name: "resume", Name: "resume",
Usage: "resume a paused container", Usage: "Resume a paused container",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Action: func(context *cli.Context) error { Action: func(context *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(context) client, ctx, cancel, err := commands.NewClient(context)

View File

@ -29,7 +29,7 @@ import (
var startCommand = cli.Command{ var startCommand = cli.Command{
Name: "start", Name: "start",
Usage: "start a container that has been created", Usage: "Start a container that has been created",
ArgsUsage: "CONTAINER", ArgsUsage: "CONTAINER",
Flags: append(platformStartFlags, []cli.Flag{ Flags: append(platformStartFlags, []cli.Flag{
cli.BoolFlag{ cli.BoolFlag{

View File

@ -29,7 +29,7 @@ type resizer interface {
// Command is the cli command for managing tasks // Command is the cli command for managing tasks
var Command = cli.Command{ var Command = cli.Command{
Name: "tasks", Name: "tasks",
Usage: "manage tasks", Usage: "Manage tasks",
Aliases: []string{"t", "task"}, Aliases: []string{"t", "task"},
Subcommands: []cli.Command{ Subcommands: []cli.Command{
attachCommand, attachCommand,