completion

Documentation

Index

• func NoComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
• type ValidArgsFn
  • func ContainerNames(dockerCli command.Cli, all bool, filters ...func(types.Container) bool) ValidArgsFn
  • func ImageNames(dockerCli command.Cli) ValidArgsFn
  • func NetworkNames(dockerCli command.Cli) ValidArgsFn
  • func VolumeNames(dockerCli command.Cli) ValidArgsFn

Functions

func NoComplete

func NoComplete(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

NoComplete is used for commands where there's no relevant completion

Types

type ValidArgsFn

type ValidArgsFn func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

ValidArgsFn a function to be used by cobra command as `ValidArgsFunction` to offer command line completion

func ContainerNames

func ContainerNames(dockerCli command.Cli, all bool, filters ...func(types.Container) bool) ValidArgsFn

ContainerNames offers completion for container names and IDs By default, only names are returned. Set DOCKER_COMPLETION_SHOW_CONTAINER_IDS=yes to also complete IDs.

func ImageNames

func ImageNames(dockerCli command.Cli) ValidArgsFn

ImageNames offers completion for images present within the local store

func NetworkNames

func NetworkNames(dockerCli command.Cli) ValidArgsFn

NetworkNames offers completion for networks

func VolumeNames

func VolumeNames(dockerCli command.Cli) ValidArgsFn

VolumeNames offers completion for volumes