flagx

Documentation

Index

• type Command
  • func NewCommand[T any](name string, description string, handle func(option *T) error) *Command
  • func (c *Command) ParseAndExecute(arguments []string)
  • func (c *Command) ParseOsArgsAndExecute()
  • func (c *Command) ShowUsage()
• type CompositeCommand
  • func NewCompositeCommand(Name string, description string) *CompositeCommand
  • func (c *CompositeCommand) AddSubCommands(commands ...*Command)
  • func (c *CompositeCommand) ParseAndExecute(arguments []string)
  • func (c *CompositeCommand) ParseOsArgsAndExecute()
  • func (c *CompositeCommand) ShowUsage()

Types

type Command

type Command struct {
	Name        string // the name of this command
	Description string // usage message
	// contains filtered or unexported fields
}

Command is a command line

func NewCommand

func NewCommand[T any](name string, description string, handle func(option *T) error) *Command

NewCommand create new command

func (*Command) ParseAndExecute

func (c *Command) ParseAndExecute(arguments []string)

ParseAndExecute parse arguments, and run handlers. If error occurred, will exit with non-zero code.

func (*Command) ParseOsArgsAndExecute

func (c *Command) ParseOsArgsAndExecute()

ParseOsArgsAndExecute parse commandline passed arguments, and run handlers.If error occurred, will exit with non-zero code.

func (*Command) ShowUsage

func (c *Command) ShowUsage()

ShowUsage print formatted usage message

type CompositeCommand

type CompositeCommand struct {
	Name        string // the command name
	Description string // the description
	// contains filtered or unexported fields
}

CompositeCommand for commands

func NewCompositeCommand

func NewCompositeCommand(Name string, description string) *CompositeCommand

NewCompositeCommand create new CompositeCommand

func (*CompositeCommand) AddSubCommands

func (c *CompositeCommand) AddSubCommands(commands ...*Command)

AddSubCommands add sub commands

func (*CompositeCommand) ParseAndExecute

func (c *CompositeCommand) ParseAndExecute(arguments []string)

ParseAndExecute parse arguments, and execute command

func (*CompositeCommand) ParseOsArgsAndExecute

func (c *CompositeCommand) ParseOsArgsAndExecute()

ParseOsArgsAndExecute parse commandline passed arguments, and execute command

func (*CompositeCommand) ShowUsage

func (c *CompositeCommand) ShowUsage()

ShowUsage show usage