commands

Documentation

Index

• type Command
  • func (command *Command) Define(flagDefiner shell.FlagDefiner)
  • func (command *Command) Execute(writer shell.ResponseWriter, request *shell.Request) error
• type HelpCommand
  • func (command *HelpCommand) Execute(writer shell.ResponseWriter, request *shell.Request) error

Types

type Command

type Command struct {
	Name        string
	Summary     string
	Description string
	Flags       shell.FlagHandlerFunction
	Function    shell.HandlerFunction
}

Command allows to define a shell handler with metadata.

func (*Command) Define

func (command *Command) Define(flagDefiner shell.FlagDefiner)

Define allows the function to define command-line

func (*Command) Execute

func (command *Command) Execute(writer shell.ResponseWriter, request *shell.Request) error

Execute will execute the command function

type HelpCommand

type HelpCommand struct {
	// The command string that should be used to call this function,
	// used in the default function output
	Usage string
}

HelpCommand allows for basic output of command metadata.

func (*HelpCommand) Execute

func (command *HelpCommand) Execute(writer shell.ResponseWriter, request *shell.Request) error

Execute will execute the help command