cli

Documentation

Index

• Variables
• type Registry
  • func New() *Registry
  • func (c *Registry) Add(e RegistryEntry)
  • func (c *Registry) Call(args []string) error
• type RegistryEntry

Variables

var ErrHelpCalled = errors.New("help called")

ErrHelpCalled is returned from the Call function if the given command is not found and the help function was executed

Types

type Registry

type Registry struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Registry contains a collection of commands to be executed

func New

func New() *Registry

New creates a new Registry

func (*Registry) Add

func (c *Registry) Add(e RegistryEntry)

Add adds a new command to the Registry

func (*Registry) Call

func (c *Registry) Call(args []string) error

Call executes the matchign command from the given arguments

type RegistryEntry

type RegistryEntry struct {
	Description string
	Name        string
	Params      []string
	Run         func([]string) error
}

Entry defines a sub-command with its parameters, description and run function to be called when this command is executed