cli

package

v1.0.20 Latest Latest Go to latest Published: Aug 9, 2018 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dms3-fs/go-fs-cmds

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func HandleHelp(appName string, req *cmds.Request, out io.Writer) error
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(ctx context.Context, input []string, stdin *os.File, root *cmds.Command) (*cmds.Request, error)
func Run(ctx context.Context, root *cmds.Command, cmdline []string, ...) error
func ShortHelp(rootName string, root *cmds.Command, path []string, out io.Writer) error
type Closer
type ErrSet
type ExitError
- func (e ExitError) Error() string
type ResponseEmitter

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoHelpRequested = errors.New("no help requested")

Functions ¶

func HandleHelp ¶ added in v1.0.0

func HandleHelp(appName string, req *cmds.Request, out io.Writer) error

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(ctx context.Context, input []string, stdin *os.File, root *cmds.Command) (*cmds.Request, error)

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

This function never returns nil, even on error.

func Run ¶ added in v1.0.0

func Run(ctx context.Context, root *cmds.Command,
	cmdline []string, stdin, stdout, stderr *os.File,
	buildEnv cmds.MakeEnvironment, makeExecutor cmds.MakeExecutor) 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 Closer ¶ added in v1.0.0

type Closer interface {
	Close()
}

Closer is a helper interface to check if the env supports closing

type ErrSet ¶

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

type ExitError ¶ added in v1.0.9

type ExitError int

ExitError is the error used when a specific exit code needs to be returned.

func (ExitError) Error ¶ added in v1.0.9

func (e ExitError) Error() string

type ResponseEmitter ¶ added in v0.3.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL