Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

command

package

Go to main page

Versions in this module

v0

v0.1.0

Mar 31, 2026

Changes in this version

+ func CheckInputType(value string, inputType InputType) bool

+ func GetBool(value string) bool

+ func GetFloat(value string) float64

+ func GetInt(value string) int

+ func RegisterInputType(typeName InputType, checker *regexp.Regexp)

type Context

+ Arguments []string

+ Commands []string

+ KvArgs map[string]string

+ func (ctx *Context) AppendArg(value string) error

+ func (ctx *Context) Clone() *Context

type FormatBuilder

+ func (f *FormatBuilder) Argument(name string, inputType InputType, required bool, help string) *FormatBuilder

+ func (f *FormatBuilder) Description(desc string) *FormatBuilder

+ type Handler = func(ctx *Context) error

+ type InputType string

+ const Boolean

+ const Number

+ const String

+ type ParsedArguments = []string

+ type ParsedOptions = map[string]string

type Registry

+ Aliases []alias

+ Handler Handler

+ Name string

+ Schema Schema

+ SubRegistries []Registry

+ type Schema struct

+ Arguments []SchemaArgument

+ Description string

+ Name string

+ Options []SchemaOption

+ SubCommandSchemas []Schema

+ func NewSchema(name string) *Schema

+ func (s *Schema) AddArgument(name string, inputType InputType, help string) *Schema

+ func (s *Schema) AddOption(short string, name string, inputType InputType, help string) *Schema

+ func (s *Schema) AddSubCommandSchema(schema Schema) *Schema

+ func (s *Schema) Match(token string) bool

+ type SchemaArgument struct

+ Help string

+ Name string

+ Required bool

+ Type InputType

+ type SchemaOption struct

+ Default string

+ Help string

+ Name string

+ Required bool

+ ShortName string

+ Type InputType

type System

+ func (s *System) CheckAliases(ctx *Context)

+ func (s *System) GetSchemas() []Schema

v0.0.7

Jan 25, 2025

v0.0.6

Jan 23, 2025

v0.0.5

Jan 23, 2025

Changes in this version

+ var ArgumentRegFormat = regexp.MustCompile(...)

+ var OptionRegFormat = regexp.MustCompile(...)

+ var RegFormat = regexp.MustCompile(`^(?P<name>\w+?)(?P<args>(?: [<\[]\w+?(?::\w+?)?[>\]](?:=\w+?)? ?)*)$`)

+ func ParseCommand(test string) (name, last string)

+ type Alias map[string]map[string]string

+ type ArgType int

+ const StringArg

+ const TextArg

+ func ParseArgType(s string) (ArgType, error)

+ type Argument struct

+ Default string

+ Name string

+ Required bool

+ Type ArgType

+ type Context struct

+ Args map[string]string

+ ArgumentString string

+ Command string

+ Options map[string]string

+ Tokens []string

+ func NewCommandContext(msg botc.MessageContext, text string) *Context

+ type FormatBuilder struct

+ func NewCommandFormatBuilder(format string, callback func(Inst) func()) *FormatBuilder

+ func (b *FormatBuilder) Action(handler func(ctx *Context)) *FormatBuilder

+ func (b *FormatBuilder) Alias(reg string, option map[string]string) *FormatBuilder

+ func (b *FormatBuilder) Arguments(args string) *FormatBuilder

+ func (b *FormatBuilder) Build() (func(), error)

+ func (b *FormatBuilder) Option(opt string) *FormatBuilder

+ func (b *FormatBuilder) SubCommand(format string) *FormatBuilder

+ type Inst struct

+ Alias map[string]map[string]string

+ Arguments []Argument

+ Name string

+ Options []Option

+ Subs map[string]Inst

+ func (i Inst) CheckAlias(cmdCtx *Context) error

+ func (i Inst) Emit(cmdCtx *Context) error

+ type Option struct

+ Default string

+ Name string

+ Short string

+ Type ArgType

+ type Registry struct

+ func NewCommandRegistry(cmd Inst) *Registry

+ func (r *Registry) CheckAlias(cmdCtx *Context)

+ func (r *Registry) Emit(cmdCtx *Context)

+ type System struct

+ Commands map[string]*Registry

+ func NewCommandSystem() *System

+ func (s *System) Emit(cmdCtx *Context)

+ func (s *System) Register(cmd Inst) func()