subflags

Documentation

Index

• func MakeCommandFlagSet(cmd *Command) *flag.FlagSet
• func MakeUsage(cmds ...*Command) func()
• type Command
• type CommandFunc
  • func Parse(cmds ...*Command) CommandFunc

Functions

func MakeCommandFlagSet

func MakeCommandFlagSet(cmd *Command) *flag.FlagSet

MakeCommandFlagSet creates flag set for given command.

func MakeUsage

func MakeUsage(cmds ...*Command) func()

MakeUsage creates usage description function for given set of commands.

Types

type Command

type Command struct {
	// Name is command name and command line identifier.
	Name string
	// Desc is a description of the command.
	Desc string
	// Parser gets rest of command line arguments and returns a function which
	// executes the command.
	Parser func(args []string) (CommandFunc, error)
}

Command defines CLI command.

type CommandFunc

type CommandFunc func(*global.Config) error

CommandFunc is a prototype of a function which executes command.

func Parse

func Parse(cmds ...*Command) CommandFunc

Parse dispatches and run parser for a command from given set.