cmd

Documentation

Index

• Variables
• func AddSubCommands(cmd *cobra.Command)
• func BasicGetStatusInfo(ctx context.Context) (ioutil.WriterTos, error)
• func MergeSubCommands(ctx context.Context, commands ...*cobra.Command) context.Context
• func OnlySubcommands(cmd *cobra.Command, args []string) error
• func RunSubcommands(cmd *cobra.Command, args []string) error
• func Telepresence(ctx context.Context) *cobra.Command
• func TelepresenceDaemon(ctx context.Context) *cobra.Command
• func WithSubCommands(ctx context.Context) context.Context
• type HelmCommand
  • func (ha *HelmCommand) Type() connector.HelmRequest_Type
• type StatusInfo
  • func (s *StatusInfo) WriterTos() []io.WriterTo
• type StatusInfoEmbedded
  • func (s *StatusInfoEmbedded) WriteTo(out io.Writer) (int64, error)
  • func (s *StatusInfoEmbedded) WriterTos() []io.WriterTo

Variables

var (
	HelmInstallExtendFlagsFunc func(*pflag.FlagSet)                                      //nolint:gochecknoglobals // extension point
	HelmExtendFlagsFunc        func(*pflag.FlagSet)                                      //nolint:gochecknoglobals // extension point
	HelmInstallPrologFunc      func(context.Context, *pflag.FlagSet, *HelmCommand) error //nolint:gochecknoglobals // extension point
)

var GetStatusInfo = BasicGetStatusInfo //nolint:gochecknoglobals // extension point

GetStatusInfo may return an extended struct, based on the one returned by the BasicGetStatusInfo.

Functions

func AddSubCommands

func AddSubCommands(cmd *cobra.Command)

AddSubCommands adds subcommands to the given command, including the default help, the commands in the CommandGroups found in the given command's context, and the completion command. It also replaces the standard usage template with a custom template.

func BasicGetStatusInfo

func BasicGetStatusInfo(ctx context.Context) (ioutil.WriterTos, error)

func MergeSubCommands

func MergeSubCommands(ctx context.Context, commands ...*cobra.Command) context.Context

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 RunSubcommands

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

RunSubcommands is for use as a cobra.interceptCmd.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.

func Telepresence

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

Telepresence returns the top level "telepresence" CLI command.

func TelepresenceDaemon

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

TelepresenceDaemon returns the top level "telepresence" CLI limited to the subcommands [kubeauth|connector|daemon]-foreground.

func WithSubCommands

func WithSubCommands(ctx context.Context) context.Context

Types

type HelmCommand

type HelmCommand struct {
	values.Options
	AllValues   map[string]any
	Request     *daemon.Request
	RequestType connector.HelmRequest_Type
	ReuseValues bool
	ResetValues bool
	CRDs        bool
}

func (*HelmCommand) Type

func (ha *HelmCommand) Type() connector.HelmRequest_Type

type StatusInfo

type StatusInfo struct {
	RootDaemon io.WriterTo `json:"root_daemon" yaml:"root_daemon"`
	UserDaemon io.WriterTo `json:"user_daemon" yaml:"user_daemon"`
}

func (*StatusInfo) WriterTos

func (s *StatusInfo) WriterTos() []io.WriterTo

type StatusInfoEmbedded

type StatusInfoEmbedded struct {
	RootDaemon io.WriterTo `json:"root_daemon" yaml:"root_daemon"`
	UserDaemon io.WriterTo `json:"user_daemon" yaml:"user_daemon"`
}

func (*StatusInfoEmbedded) WriteTo

func (s *StatusInfoEmbedded) WriteTo(out io.Writer) (int64, error)

func (*StatusInfoEmbedded) WriterTos

func (s *StatusInfoEmbedded) WriterTos() []io.WriterTo