cmd

package module

v0.0.0-...-5a22cc5 Latest Latest Go to latest Published: Oct 19, 2018 License: BSD-2-Clause Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Engine is the core interface to the command interpreter.

func NewEngine() *Engine

NewEngine creates a new command interpreter.

func (e *Engine) AddCommand(name string, help string, handler Handler, userLevel int) error

AddCommand adds a command to the engine.

func (e *Engine) Exec(ctx interface{}, userLevel int, args []string) error

Exec executes a command.

func (e *Engine) ExecString(ctx interface{}, userLevel int, commandString string) error

ExecString parses the commandString and executes the command.

func (e *Engine) RemoveCommand(name string) error

RemoveCommand removes a command from the engine.

type Handler func(ctx interface{}, args []string) error

Handler is a function that gets invoked when a command is run.