console

Documentation

Index

• func Render(commands map[string]*Command)
• type Command
  • func (cmd *Command) GetCommand() string
  • func (cmd *Command) GetDescription() string
  • func (cmd *Command) GetName() string
  • func (cmd *Command) Run(c *ParsedCommand)
• type CommandGroup
• type Console
  • func New() *Console
  • func (c *Console) Add(command *Command)
  • func (c *Console) AddCommand(name string, description string, execution func(c *ParsedCommand)) *Command
  • func (c *Console) Run()
• type ParsedCommand
  • func Parse(definition string, command string) *ParsedCommand
  • func (p *ParsedCommand) GetArgument(name string) *Value
  • func (p *ParsedCommand) GetArgumentWithDefault(name string, defaultValue any) *Value
  • func (p *ParsedCommand) GetName() string
  • func (p *ParsedCommand) GetOption(name string) *Value
  • func (p *ParsedCommand) GetOptionWithDefault(name string, defaultValue any) *Value
  • func (p *ParsedCommand) GetPrefix() string
  • func (p *ParsedCommand) GetSubCommand() string
• type Value
  • func (o *Value) Bool() bool
  • func (o *Value) Integer() int
  • func (o *Value) String() string

Functions

func Render

func Render(commands map[string]*Command)

Types

type Command

type Command struct {
	Definition  string
	Description string
	Execution   func(c *ParsedCommand)
}

func (*Command) GetCommand

func (cmd *Command) GetCommand() string

func (*Command) GetDescription

func (cmd *Command) GetDescription() string

func (*Command) GetName

func (cmd *Command) GetName() string

func (*Command) Run

func (cmd *Command) Run(c *ParsedCommand)

type CommandGroup

type CommandGroup struct {
	Name        string
	Description string
	Prefix      string
	Commands    []*Command
}

type Console

type Console struct {
	Commands map[string]*Command
}

func New

func New() *Console

func (*Console) Add

func (c *Console) Add(command *Command)

func (*Console) AddCommand

func (c *Console) AddCommand(name string, description string, execution func(c *ParsedCommand)) *Command

func (*Console) Run

func (c *Console) Run()

type ParsedCommand

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

func Parse

func Parse(definition string, command string) *ParsedCommand

func (*ParsedCommand) GetArgument

func (p *ParsedCommand) GetArgument(name string) *Value

func (*ParsedCommand) GetArgumentWithDefault

func (p *ParsedCommand) GetArgumentWithDefault(name string, defaultValue any) *Value

func (*ParsedCommand) GetName

func (p *ParsedCommand) GetName() string

func (*ParsedCommand) GetOption

func (p *ParsedCommand) GetOption(name string) *Value

func (*ParsedCommand) GetOptionWithDefault

func (p *ParsedCommand) GetOptionWithDefault(name string, defaultValue any) *Value

func (*ParsedCommand) GetPrefix

func (p *ParsedCommand) GetPrefix() string

func (*ParsedCommand) GetSubCommand

func (p *ParsedCommand) GetSubCommand() string

type Value

type Value struct {
	fmt.Stringer
	Value any
}

func (*Value) Bool

func (o *Value) Bool() bool

func (*Value) Integer

func (o *Value) Integer() int

func (*Value) String

func (o *Value) String() string