go-command

README

go-command

The go-command module provides several types for managing multiple commands within the same command-line application. This approach to software architecture allows a single application to perform many tasks while ensuring the various commands stay modular and respect the separation of concerns principal.

Usage

The module consists mainly of four packages:

• command: this packages defines multiple types for defining, creating, and running commands
• command/sample: this package defines sample commands useful for learning how the module works
• style: this package provides semantic types and methods for changing the style (mode and colour) of console output
• util: this packages provides simple helper functions for a verity of general use cases

The following main definition demonstrates the basic usage of the module:

func main() {
	ls := flag.Bool("ls", false, "list all commands")
	flag.Parse()

	runner := command.NewRunner(
		sample.NewHelloCommand(),
		command.NewConfigCommand[sample.SampleConfig](),
	)

	if *ls || len(os.Args) < 2 {
		runner.ListCommands()
		return
	}

	if err := runner.RunCommand(os.Args[1], os.Args[2:]); err != nil {
		style.BoldError.Print("ERROR: ")
		fmt.Println(err)
	}
}