cli

Documentation

Index

• func AddCommandGroups(cmd *cobra.Command, groups []CommandGroup)
• func ClusterIdCommand() *cobra.Command
• func Command(ctx context.Context) *cobra.Command
• func DescribeIntercept(ii *manager.InterceptInfo, volumeMountsPrevented error, debug bool) string
• func LicenseCommand() *cobra.Command
• func LoginCommand() *cobra.Command
• func LogoutCommand() *cobra.Command
• func OnlySubcommands(cmd *cobra.Command, args []string) error
• func PerhapsLegacyCommands(cmd *cobra.Command, args []string) error
• func RunSubcommands(cmd *cobra.Command, args []string) error
• type CommandGroup
• type FlagGroup

Functions

func AddCommandGroups

func AddCommandGroups(cmd *cobra.Command, groups []CommandGroup)

AddCommandGroups adds all the groups in the given CommandGroup to the command, replaces the its standard usage template with a template that groups the commands according to that group.

func ClusterIdCommand

func ClusterIdCommand() *cobra.Command

getClusterID is a simple command that makes it easier for users to figure out what their cluster ID is. For now this is just used when people are making licenses for air-gapped environments

func Command

func Command(ctx context.Context) *cobra.Command

Command returns the top level "telepresence" CLI command

func DescribeIntercept

func DescribeIntercept(ii *manager.InterceptInfo, volumeMountsPrevented error, debug bool) string

func LicenseCommand

func LicenseCommand() *cobra.Command

func LoginCommand

func LoginCommand() *cobra.Command

func LogoutCommand

func LogoutCommand() *cobra.Command

func OnlySubcommands

func OnlySubcommands(cmd *cobra.Command, args []string) error

OnlySubcommands is a cobra.PositionalArgs that is similar to cobra.NoArgs, but prints a better error message.

func PerhapsLegacyCommands

func PerhapsLegacyCommands(cmd *cobra.Command, args []string) error

PerhapsLegacyCommands is like OnlySubcommands but performs some initial check for legacy flags

func RunSubcommands

func RunSubcommands(cmd *cobra.Command, args []string) error

RunSubcommands is for use as a cobra.Command.RunE for commands that don't do anything themselves but have subcommands. In such cases, it is important to set RunE even though there's nothing to run, because otherwise cobra will treat that as "success", and it shouldn't be "success" if the user typos a command and types something invalid.

Types

type CommandGroup

type CommandGroup struct {
	Name     string
	Commands []*cobra.Command
}

CommandGroup represents a group of commands and the name of that group

type FlagGroup

type FlagGroup struct {
	Name  string
	Flags *pflag.FlagSet
}

FlagGroup represents a group of flags and the name of that group