cli

Documentation

Index

• type Arg
• type Args
• type Command
  • func (c *Command) Help()
• type Flag
• type Flags
• type RootCommand
  • func (c *RootCommand) Execute()
  • func (c *RootCommand) ExecuteColon()
  • func (c *RootCommand) Init() error
  • func (c *RootCommand) InitColon() error

Types

type Arg

type Arg struct {
	Name        string
	Required    bool
	Description string
}

type Args

type Args struct {
	Args            []Arg
	AllowAdditional bool
}

type Command

type Command struct {
	Short                  string
	Args                   Args
	Flags                  Flags
	MutuallyExclusiveFlags [][]string
	RequiredFlagSet        [][]string
	PreRun                 func()
	Run                    func(args []string, flags Flags) error
	Subcommands            map[string]*Command
	// contains filtered or unexported fields
}

func (*Command) Help

func (c *Command) Help()

type Flag

type Flag interface {
	IsRequired() bool
	GetShort() string
	GetUsage() string
	Parse() func() error
	Set() bool
	AddToFlagSet(name string, fs *pflag.FlagSet)
}

type Flags

type Flags map[string]Flag

type RootCommand

type RootCommand struct {
	Name string
	*Command
}

func (*RootCommand) Execute

func (c *RootCommand) Execute()

func (*RootCommand) ExecuteColon

func (c *RootCommand) ExecuteColon()

func (*RootCommand) Init

func (c *RootCommand) Init() error

func (*RootCommand) InitColon

func (c *RootCommand) InitColon() error