gocmd

A Go library for building command line applications.

Features

• Advanced command line arguments handling
  • Subcommand handling
  • Short and long command line arguments
  • Multiple arguments (repeated or delimited)
  • Support for environment variables
  • Well formatted usage printing
  • Auto usage and version printing
  • Unknown argument handling
• Output tables in the terminal
• Template support for config files
• No external dependency

Installation

go get github.com/devfacet/gocmd/v3

Usage

A basic app

For the full code click here.

funcmain() {
flags:=struct {
Helpbool`short:"h" long:"help" description:"Display usage" global:"true"`Versionbool`short:"v" long:"version" description:"Display version"`VersionExbool`long:"vv" description:"Display version (extended)"`Echostruct {
Settingsbool`settings:"true" allow-unknown-arg:"true"`
} `command:"echo" description:"Print arguments"`Mathstruct {
Sqrtstruct {
Numberfloat64`short:"n" long:"number" required:"true" description:"Number"`
} `command:"sqrt" description:"Calculate square root"`Powstruct {
Basefloat64`short:"b" long:"base" required:"true" description:"Base"`Exponentfloat64`short:"e" long:"exponent" required:"true" description:"Exponent"`
} `command:"pow" description:"Calculate base exponential"`
} `command:"math" description:"Math functions" nonempty:"true"`
}{}
// Echo commandgocmd.HandleFlag("Echo", func(cmd*gocmd.Cmd, args []string) error {
fmt.Printf("%s\n", strings.Join(cmd.FlagArgs("Echo")[1:], " "))
returnnil
})
// Math commandsgocmd.HandleFlag("Math.Sqrt", func(cmd*gocmd.Cmd, args []string) error {
fmt.Println(math.Sqrt(flags.Math.Sqrt.Number))
returnnil
})
gocmd.HandleFlag("Math.Pow", func(cmd*gocmd.Cmd, args []string) error {
fmt.Println(math.Pow(flags.Math.Pow.Base, flags.Math.Pow.Exponent))
returnnil
})
// Init the appgocmd.New(gocmd.Options{
Name: "basic",
Description: "A basic app",
Version: fmt.Sprintf("%s (%s)", version, gitCommit),
Flags: &flags,
ConfigType: gocmd.ConfigTypeAuto,
})
}

Test

# Run tests
make test# Continuous testing
make test-ui
# Benchmarks
make test-benchmarks

Contributing

See CONTRIBUTING.md

License

Licensed under The MIT License (MIT)
For the full copyright and license information, please view the LICENSE.txt file.