cli

Documentation

Index

• func DefaultCommands(c *CLI) error
• type Binding
• type CLI
  • func NewCLI(bindings ...Binding) (*CLI, error)
  • func (c *CLI) AddCommands(cms ...*Command) error
  • func (c *CLI) Admin()
• type Command
• type CommandFunc
• type Response

Functions

func DefaultCommands

func DefaultCommands(c *CLI) error

Types

type Binding

type Binding func(*CLI) error

Binding is a function for setting up new Commands from other packages.

type CLI

type CLI struct {
	Commands map[string]*Command

	Rl *readline.Instance
	// contains filtered or unexported fields
}

CLI is a set of Commands and their aliases.

func NewCLI

func NewCLI(bindings ...Binding) (*CLI, error)

func (*CLI) AddCommands

func (c *CLI) AddCommands(cms ...*Command) error

func (*CLI) Admin

func (c *CLI) Admin()

Admin reads commands from stdin and executes them.

type Command

type Command struct {
	Name, Description string
	Aliases           []string
	Fn                CommandFunc
}

Command is a CLI command which runs a given function Fn when the command is issued.

type CommandFunc

type CommandFunc func(...string) (Response, error)

CommandFunc is the type which a Command's Fn must be.

type Response

type Response string

Response is the type that returns from a Command.