Function newRmCommand

cli/command/container/rm.go:27–61

newRmCommand creates a new cobra.Command for "docker container rm".

(dockerCLI command.Cli)

// newRmCommand creates a new cobra.Command for "docker container rm".
func newRmCommand(dockerCLI command.Cli) *cobra.Command {
	var opts rmOptions

	completeLinkNames := completeLinks(dockerCLI)
	completeNames := completion.ContainerNames(dockerCLI, true, func(ctr container.Summary) bool {
		return opts.force || ctr.State == container.StateExited || ctr.State == container.StateCreated
	})

	cmd := &cobra.Command{
		Use:   "rm [OPTIONS] CONTAINER [CONTAINER...]",
		Short: "Remove one or more containers",
		Args:  cli.RequiresMinArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			opts.containers = args
			return runRm(cmd.Context(), dockerCLI, &opts)
		},
		Annotations: map[string]string{
			"aliases": "docker container rm, docker container remove, docker rm",
		},
		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
			if opts.rmLink {
				// "--link" (remove link) is set; provide link names instead of container (primary) names.
				return completeLinkNames(cmd, args, toComplete)
			}
			return completeNames(cmd, args, toComplete)
		},
		DisableFlagsInUseLine: true,
	}

	flags := cmd.Flags()
	flags.BoolVarP(&opts.rmVolumes, "volumes", "v", false, "Remove anonymous volumes associated with the container")
	flags.BoolVarP(&opts.rmLink, "link", "l", false, "Remove the specified link")
	flags.BoolVarP(&opts.force, "force", "f", false, "Force the removal of a running container (uses SIGKILL)")
	return cmd
}

// newRemoveCommand adds subcommands for "docker container"; unlike the
// top-level "docker rm", it also adds a "remove" alias to support