shellcommand

Documentation

Index

• Variables
• func Run()
• func SkHandlerFactory(s *shell.Shell) shell.Handler
• type Command
  • func (c *Command) Name() string
  • func (c *Command) Runnable() bool
  • func (c *Command) Usage()
• type SkHandler
  • func (h *SkHandler) HandleEof() error
  • func (h *SkHandler) HandleLine(line string) error

Variables

var Commands = []*Command{
	cmdVersion,
}

Functions

func Run

func Run()

func SkHandlerFactory

func SkHandlerFactory(s *shell.Shell) shell.Handler

Types

type Command

type Command struct {
	// Run runs the command.
	// The args are the arguments after the command name.
	Run func(cmd *Command, args []string, rw io.ReadWriter) bool

	// UsageLine is the one-line usage message.
	// The first word in the line is taken to be the command name.
	UsageLine string

	// Short is the short description shown in the 'go help' output.
	Short string

	// Long is the long message shown in the 'go help <this-command>' output.
	Long string

	// Flag is a set of flags specific to this command.
	Flag flag.FlagSet

	IsDebug *bool
}

func (*Command) Name

func (c *Command) Name() string

Name returns the command's name: the first word in the usage line.

func (*Command) Runnable

func (c *Command) Runnable() bool

Runnable reports whether the command can be run; otherwise it is a documentation pseudo-command such as importpath.

func (*Command) Usage

func (c *Command) Usage()

type SkHandler

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

func (*SkHandler) HandleEof

func (h *SkHandler) HandleEof() error

func (*SkHandler) HandleLine

func (h *SkHandler) HandleLine(line string) error