cmd

Documentation

Index

• type ArgumentAndFlagCantBeUsedTogetherError
  • func (e *ArgumentAndFlagCantBeUsedTogetherError) Error() string
• type BoolFlag
  • func (f *BoolFlag) AddFlagToCommand(cmd *cobra.Command)
  • func (f *BoolFlag) ValidateFlag(cmd *cobra.Command, args []string) error
• type Command
• type CommandFlag
  • func (f *CommandFlag) GetName() string
• type DurationFlag
  • func (f *DurationFlag) AddFlagToCommand(cmd *cobra.Command)
  • func (f *DurationFlag) ValidateFlag(cmd *cobra.Command, args []string) error
• type Flag
• type FlagRequiresFlagError
  • func (e *FlagRequiresFlagError) Error() string
• type Flags
  • func (f Flags) Remove(name string) Flags
  • func (f Flags) ValidateFlags(cmd *cobra.Command, args []string) error
• type IntFlag
  • func (f *IntFlag) AddFlagToCommand(cmd *cobra.Command)
  • func (f *IntFlag) ValidateFlag(cmd *cobra.Command, args []string) error
• type OutputFlag
  • func NewOutputFlag(o *printer.Output) *OutputFlag
  • func (o *OutputFlag) Set(outputType string) error
  • func (o *OutputFlag) String() string
  • func (o *OutputFlag) Type() string
• type StringFlag
  • func (f *StringFlag) AddFlagToCommand(cmd *cobra.Command)
  • func (f *StringFlag) ValidateFlag(cmd *cobra.Command, args []string) error
• type StringSliceFlag
  • func (f *StringSliceFlag) AddFlagToCommand(cmd *cobra.Command)
  • func (f *StringSliceFlag) ValidateFlag(cmd *cobra.Command, args []string) error

Types

type ArgumentAndFlagCantBeUsedTogetherError

type ArgumentAndFlagCantBeUsedTogetherError struct {
	Arg  string
	Flag string
}

func (*ArgumentAndFlagCantBeUsedTogetherError) Error

func (e *ArgumentAndFlagCantBeUsedTogetherError) Error() string

type BoolFlag

type BoolFlag struct {
	CommandFlag
	Option *bool
}

func (*BoolFlag) AddFlagToCommand

func (f *BoolFlag) AddFlagToCommand(cmd *cobra.Command)

Boolean flag methods

func (*BoolFlag) ValidateFlag

func (f *BoolFlag) ValidateFlag(cmd *cobra.Command, args []string) error

type Command

type Command struct {
	Parent      string
	Name        string
	Description string
	Aliases     []string
	Args        []string
	CreateArgs  []string
	Hidden      bool
}

type CommandFlag

type CommandFlag struct {
	Name        string
	Description string
	Shorthand   string
	Required    bool
	Validate    func(cmd *cobra.Command, args []string) error
}

func (*CommandFlag) GetName

func (f *CommandFlag) GetName() string

Command flag methods

type DurationFlag

type DurationFlag struct {
	CommandFlag
	Option *time.Duration
}

func (*DurationFlag) AddFlagToCommand

func (f *DurationFlag) AddFlagToCommand(cmd *cobra.Command)

Duration flag methods

func (*DurationFlag) ValidateFlag

func (f *DurationFlag) ValidateFlag(cmd *cobra.Command, args []string) error

type Flag

type Flag interface {
	AddFlagToCommand(*cobra.Command)
	ValidateFlag(cmd *cobra.Command, args []string) error
	GetName() string
}

type FlagRequiresFlagError

type FlagRequiresFlagError struct {
	Flag1 string
	Flag2 string
}

func (*FlagRequiresFlagError) Error

func (e *FlagRequiresFlagError) Error() string

type Flags

type Flags []Flag

func (Flags) Remove

func (f Flags) Remove(name string) Flags

func (Flags) ValidateFlags

func (f Flags) ValidateFlags(cmd *cobra.Command, args []string) error

Flags (list of flags) methods

type IntFlag

type IntFlag struct {
	CommandFlag
	Option *int
}

func (*IntFlag) AddFlagToCommand

func (f *IntFlag) AddFlagToCommand(cmd *cobra.Command)

Int flag methods

func (*IntFlag) ValidateFlag

func (f *IntFlag) ValidateFlag(cmd *cobra.Command, args []string) error

type OutputFlag

type OutputFlag printer.Output

func NewOutputFlag

func NewOutputFlag(o *printer.Output) *OutputFlag

func (*OutputFlag) Set

func (o *OutputFlag) Set(outputType string) error

func (*OutputFlag) String

func (o *OutputFlag) String() string

func (*OutputFlag) Type

func (o *OutputFlag) Type() string

type StringFlag

type StringFlag struct {
	CommandFlag
	Choices []string
	Option  *string
}

func (*StringFlag) AddFlagToCommand

func (f *StringFlag) AddFlagToCommand(cmd *cobra.Command)

String flag methods

func (*StringFlag) ValidateFlag

func (f *StringFlag) ValidateFlag(cmd *cobra.Command, args []string) error

type StringSliceFlag

type StringSliceFlag struct {
	CommandFlag
	Choices []string
	Option  *[]string
}

func (*StringSliceFlag) AddFlagToCommand

func (f *StringSliceFlag) AddFlagToCommand(cmd *cobra.Command)

StringSlice flag methods

func (*StringSliceFlag) ValidateFlag

func (f *StringSliceFlag) ValidateFlag(cmd *cobra.Command, args []string) error