shell

Documentation

Index

• type Context
  • func (c *Context) ContainsFlag(flag string) bool
  • func (c *Context) Error(err error)
  • func (c *Context) GetFlagValue(flag string) string
  • func (c *Context) GetIntFlagValue(flag string) int64
  • func (c *Context) ShowHelpPage()
  • func (c *Context) ValidateFile(flag string) (*os.File, error)
  • func (c *Context) ValidateFilePath(path string) (*os.File, error)
• type Executor
  • func (e *Executor) AddExecutor(exec *Executor)
  • func (e *Executor) Execute(ctx *Context)
  • func (e *Executor) HelpPage(level int) string
• type Executors
• type Shell
  • func NewShell() *Shell
  • func (s *Shell) AddExecutor(exec *Executor)
  • func (s *Shell) Error(msg string)
  • func (s *Shell) GetExecutor(name string) (*Executor, bool)
  • func (s *Shell) Run()

Types

type Context

type Context struct {
	Args  []string
	Flags *flags.Flags

	Exec *Executor
}

func (*Context) ContainsFlag

func (c *Context) ContainsFlag(flag string) bool

func (*Context) Error

func (c *Context) Error(err error)

func (*Context) GetFlagValue

func (c *Context) GetFlagValue(flag string) string

func (*Context) GetIntFlagValue

func (c *Context) GetIntFlagValue(flag string) int64

func (*Context) ShowHelpPage

func (c *Context) ShowHelpPage()

func (*Context) ValidateFile

func (c *Context) ValidateFile(flag string) (*os.File, error)

func (*Context) ValidateFilePath

func (c *Context) ValidateFilePath(path string) (*os.File, error)

type Executor

type Executor struct {
	Name string
	Help string

	Aliases []string

	WithValue bool

	Flags     *flags.Flags
	CountArgs int

	SubExecs Executors

	Func func(*Context)
}

func (*Executor) AddExecutor

func (e *Executor) AddExecutor(exec *Executor)

func (*Executor) Execute

func (e *Executor) Execute(ctx *Context)

func (*Executor) HelpPage

func (e *Executor) HelpPage(level int) string

type Executors

type Executors map[string]*Executor

type Shell

type Shell struct {
	Execs Executors

	Active bool
}

func NewShell

func NewShell() *Shell

func (*Shell) AddExecutor

func (s *Shell) AddExecutor(exec *Executor)

func (*Shell) Error

func (s *Shell) Error(msg string)

func (*Shell) GetExecutor

func (s *Shell) GetExecutor(name string) (*Executor, bool)

func (*Shell) Run

func (s *Shell) Run()