cli

Documentation

Index

• func NewCmd(streams genericclioptions.IOStreams, name string) *cobra.Command
• type CommandOptions
  • func (co *CommandOptions) Complete(_ *cobra.Command, _ []string) error
  • func (co *CommandOptions) Execute() error
  • func (co *CommandOptions) Run(c *cobra.Command, args []string)
  • func (co *CommandOptions) Validate(_ *cobra.Command, args []string) error
• type Flags
  • func DefaultFlags() *Flags
  • func (f *Flags) AddFlags(flags *pflag.FlagSet)
  • func (f *Flags) Tidy() error

Functions

func NewCmd

func NewCmd(streams genericclioptions.IOStreams, name string) *cobra.Command

NewCmd returns a new initialized command.

Types

type CommandOptions

type CommandOptions struct {
	Flags         *Flags
	Client        client.Interface
	ClientFlags   *client.Flags
	Namespace     string
	ResourceNames []string

	genericclioptions.IOStreams
}

CommandOptions represents the options of the command.

func (*CommandOptions) Complete

func (co *CommandOptions) Complete(_ *cobra.Command, _ []string) error

Complete finishes the setup of the command options.

func (*CommandOptions) Execute

func (co *CommandOptions) Execute() error

Execute runs the command.

func (*CommandOptions) Run

func (co *CommandOptions) Run(c *cobra.Command, args []string)

Run is the method called by cobra to run the command.

func (*CommandOptions) Validate

func (co *CommandOptions) Validate(_ *cobra.Command, args []string) error

Validate ensure that required options to run the command are set and valid.

type Flags

type Flags struct {
	AllNamespaces      bool
	ShowNamespace      bool
	ShowKind           bool
	ShowContainers     bool
	ShowStats          bool
	NoColors           bool
	NoHeaders          bool
	SortOrder          sortOrder
	SortColumns        []string
	LabelSelector      string
	FieldSelector      string
	Output             string
	RecommendationType vpa.RecommendationType
	WarningThreshold   float64
	CriticalThreshold  float64
	// contains filtered or unexported fields
}

Flags represents the common command flags.

func DefaultFlags

func DefaultFlags() *Flags

DefaultFlags returns default command flags.

func (*Flags) AddFlags

func (f *Flags) AddFlags(flags *pflag.FlagSet)

AddFlags binds the command flags to the given pflag.FlagSet.

func (*Flags) Tidy

func (f *Flags) Tidy() error

Tidy post-processes the flags.