cmd

Documentation

Index

• Variables
• type Cli
  • func New(name, long string) *Cli
  • func (c *Cli) AddCmd(cmd Command)
  • func (c *Cli) Find(cmd string) (Command, bool)
  • func (c *Cli) Run()
• type Command

Variables

var Ttz = New("ttz", "A simple greeter program")

Types

type Cli

type Cli struct {
	// contains filtered or unexported fields
}

func New

func New(name, long string) *Cli

func (*Cli) AddCmd

func (c *Cli) AddCmd(cmd Command)

func (*Cli) Find

func (c *Cli) Find(cmd string) (Command, bool)

func (*Cli) Run

func (c *Cli) Run()

type Command

type Command struct {
	// The command name, used to match the command line argument e.g. clitool <Name>.
	Name string
	// Short is used in the list of commands message e.g. "command does xyz"
	Short string
	// Long is used in the usage message from the help command e.g.:
	// "Usage: <Name> [args]
	//
	// "<Long>"
	Long string
	// Cmd is the function that is called when the command is matched.
	Cmd func()
}