cli

Documentation

Index

• func LongHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error
• func NewResponseEmitter(stdout, stderr io.Writer, enc func(cmds.Request) func(io.Writer) cmds.Encoder, ...) (cmds.ResponseEmitter, <-chan int)
• func Parse(input []string, stdin *os.File, root *cmds.Command) (cmds.Request, *cmds.Command, []string, error)
• func ParseArgs(req cmds.Request, inputs []string, stdin *os.File, argDefs []cmdkit.Argument, ...) ([]string, []files.File, error)
• func ShortHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error
• type ErrSet
• type ResponseEmitter

Functions

func LongHelp

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

LongHelp writes a formatted CLI helptext string to a Writer for the given command

func NewResponseEmitter

func NewResponseEmitter(stdout, stderr io.Writer, enc func(cmds.Request) func(io.Writer) cmds.Encoder, req cmds.Request) (cmds.ResponseEmitter, <-chan int)

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 ParseArgs

func ParseArgs(req cmds.Request, inputs []string, stdin *os.File, argDefs []cmdkit.Argument, root *cmds.Command) ([]string, []files.File, error)

func ShortHelp

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

ShortHelp writes a formatted CLI helptext string to a Writer for the given command

Types

type ErrSet

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

type ResponseEmitter

type ResponseEmitter interface {
	cmds.ResponseEmitter

	Stdout() io.Writer
	Stderr() io.Writer
	Exit(int)
}

ResponseEmitter extends cmds.ResponseEmitter to give better control over the command line