cli

Documentation

Index

• Variables
• func LongHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error
• func Parse(input []string, stdin *os.File, root *cmds.Command) (cmds.Request, *cmds.Command, []string, error)
• func ShortHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error

Variables

var ErrInvalidSubcmd = errors.New("subcommand not found")

ErrInvalidSubcmd signals when the parse error is not found

Functions

func LongHelp

func LongHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error

LongHelp returns a formatted CLI helptext string, generated for the given command

func Parse

func Parse(input []string, stdin *os.File, root *cmds.Command) (cmds.Request, *cmds.Command, []string, error)

Parse parses the input commandline string (cmd, flags, and args). returns the corresponding command Request object.

func ShortHelp

func ShortHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error

ShortHelp returns a formatted CLI helptext string, generated for the given command