gocmd

gocmd

A Go library for building command line applications.

Features

• Advanced command line arguments handling
  • Short and long command line arguments
  • Support for environment variables
  • Subcommand handling
  • Well formatted usage printing
• Output tables in the terminal
• Template support for config files
• No external dependency

Installation

go get github.com/devfacet/gocmd

Usage

A basic app

See basic for full code.

func main() {
	flags := struct {
		Help      bool `short:"h" long:"help" description:"Display usage" global:"true"`
		Version   bool `short:"v" long:"version" description:"Display version"`
		VersionEx bool `long:"vv" description:"Display version (extended)"`
		Echo      struct {
		} `command:"echo" description:"Print arguments"`
	}{}

	cmd, err := gocmd.New(gocmd.Options{
		Name:        "basic",
		Version:     "1.0.0",
		Description: "A basic app",
		Flags:       &flags,
		AutoHelp:    true,
		AutoVersion: true,
	})
	if err != nil {
		log.Fatal(err)
	} else if len(cmd.FlagErrors()) > 0 {
		log.Fatal(cmd.FlagErrors()[0])
	}

	// Echo
	if args, ok := cmd.LookupFlag("Echo"); ok && args != nil {
		fmt.Printf("%s\n", strings.TrimRight(strings.TrimLeft(fmt.Sprintf("%v", args[1:]), "["), "]"))
		return
	}
}

cd examples/basic/
go build .

$ ./basic
Usage: basic [options...] COMMAND [options...]

A basic app

Options:       	
  -h, --help   	Display usage             	
  -v, --version	Display version           	
      --vv     	Display version (extended)	
               	
Commands:      	
  echo         	Print arguments 

Build

go build .

Test

./test.sh

Release

git add CHANGELOG.md # update CHANGELOG.md
./release.sh v1.0.0  # replace "v1.0.0" with new version

git ls-remote --tags # check the new tag

Contributing

• Code contributions must be through pull requests
• Run tests, linting and formatting before a pull request
• Pull requests can not be merged without being reviewed
• Use "Issues" for bug reports, feature requests and discussions
• Do not refactor existing code without a discussion
• Do not add a new third party dependency without a discussion
• Use semantic versioning and git tags for versioning

License

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