command

Documentation

Overview

Package command is an interface for defining bot commands.

Index

• Variables
• type Command
  • func Deregister(ctx *cli.Context) Command
  • func Echo(ctx *cli.Context) Command
  • func Get(ctx *cli.Context) Command
  • func Health(ctx *cli.Context) Command
  • func Hello(ctx *cli.Context) Command
  • func List(ctx *cli.Context) Command
  • func NewCommand(name, usage, description string, exec func(args ...string) ([]byte, error)) Command
  • func Ping(ctx *cli.Context) Command
  • func Query(ctx *cli.Context) Command
  • func Register(ctx *cli.Context) Command
  • func ThreeLaws(ctx *cli.Context) Command
  • func Time(ctx *cli.Context) Command

Variables

var (
	// Commmands keyed by golang/regexp patterns
	// regexp.Match(key, input) is used to match
	Commands = map[string]Command{}
)

Types

type Command

type Command interface {
	// Executes the command with args passed in
	Exec(args ...string) ([]byte, error)
	// Usage of the command
	Usage() string
	// Description of the command
	Description() string
	// Name of the command
	String() string
}

Command is the interface for specific named commands executed via plugins or the bot.

func Deregister

func Deregister(ctx *cli.Context) Command

Deregister registers a service

func Echo

func Echo(ctx *cli.Context) Command

Echo returns the same message

func Get

func Get(ctx *cli.Context) Command

Get service returns a service

func Health

func Health(ctx *cli.Context) Command

Health returns the health of a service

func Hello

func Hello(ctx *cli.Context) Command

Hello returns a greeting

func List

func List(ctx *cli.Context) Command

List returns a list of services

func NewCommand

func NewCommand(name, usage, description string, exec func(args ...string) ([]byte, error)) Command

NewCommand helps quickly create a new command

func Ping

func Ping(ctx *cli.Context) Command

Ping returns pong

func Query

func Query(ctx *cli.Context) Command

Query returns a service query

func Register

func Register(ctx *cli.Context) Command

Register registers a service

func ThreeLaws

func ThreeLaws(ctx *cli.Context) Command

Laws of robotics

func Time

func Time(ctx *cli.Context) Command

Time returns the time