cli

package

v1.0.1 Latest Latest Go to latest Published: Jul 21, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func BasicHelp(app *App, ts string) func() string

BasicHelp returns a function that creates a basic help text for the application with its commands.

type App struct {
	Name string
	Help func() string
	// contains filtered or unexported fields
}

App represents an application that may consist of multiple commands.

func NewApp(name string) *App

NewApp creates a new application with a pre-registered help command.

func (app *App) Register(name string, cmd *Command)

Register adds a new command to the application.

func (app *App) Run(t Term, args ...string) int

Run the application with the given arguments. Output is sent to t.

type Command struct {
	Desc string
	Run  func(t Term, args ...string) int
}

Command represents a single command within an application.

type Term interface {
	Infof(format string, v ...interface{})
	Errorf(format string, v ...interface{})
	Out() io.Writer
	Err() io.Writer
}

Term handles an application's output.

func BasicTerm(out, err io.Writer) Term

BasicTerm returns a Term writing Infof and Errorf to err and Out to out.