cli

Documentation

Index

• func AddCommandGroups(cmd *cobra.Command, groups cliutil.CommandGroups)
• func AddPreviewDomain(ctx context.Context, reporter *scout.Reporter, ...) (*manager.InterceptInfo, error)
• func AddPreviewFlags(prefix string, flags *pflag.FlagSet, spec *manager.PreviewSpec)
• func ClusterIdCommand() *cobra.Command
• func Command(ctx context.Context) *cobra.Command
• func GlobalFlagGroups() []cliutil.FlagGroup
• func InterceptError(r *connector.InterceptResult) error
• func IsCommand(s string) bool
• 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 UpdateInterceptFn

Functions

func AddCommandGroups

func AddCommandGroups(cmd *cobra.Command, groups cliutil.CommandGroups)

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

func AddPreviewDomain

func AddPreviewDomain(ctx context.Context, reporter *scout.Reporter, updateInterceptFn UpdateInterceptFn, sess *manager.SessionInfo, iceptName string,
	previewSpec *manager.PreviewSpec,
) (*manager.InterceptInfo, error)

func AddPreviewFlags

func AddPreviewFlags(prefix string, flags *pflag.FlagSet, spec *manager.PreviewSpec)

AddPreviewFlags mutates 'flags', adding flags to it such that the flags set the appropriate fields in the given 'spec'. If 'prefix' is given, long-flag names are prefixed with it.

func ClusterIdCommand

func ClusterIdCommand() *cobra.Command

ClusterIdCommand 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 GlobalFlagGroups

func GlobalFlagGroups() []cliutil.FlagGroup

func InterceptError

func InterceptError(r *connector.InterceptResult) error

InterceptError inspects the .Error and .ErrorText fields in an InterceptResult and returns an appropriate error object, or nil if the InterceptResult doesn't represent an error.

func IsCommand

func IsCommand(s string) bool

IsCommand returns true if the string is encountered before a '--' or end of list. This is a best effort, and it might give us false positives.

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 UpdateInterceptFn

type UpdateInterceptFn func(context.Context, *manager.UpdateInterceptRequest) (*manager.InterceptInfo, error)