gocli

gocli helps you implement CLI commands for your app by providing:

A common interface for your CLI commands
A handler to handle 'em all

How is that useful?

One single handler for every CLI command
No need to recreate the wheel every time you want your app to serve CLI commands
Easy debugging
Easy to use
Fast implementation of new CLI commands

Getting Started

Prerequisites

Developed with Go 1.8+ (installation instructions here)

Installing

go get -u github.com/aziule/gocli

Usage

First, create a new CLI command and make it implement the Command interface:

// RunCommand contains the variables set by SetFlags (if any)
// that will be used within Execute()
type RunCommand struct {
    configFilePath string
}

// Usage describes how our command works
func (c *RunCommand) Usage() string {
    return `run [-config=./config.json]:
    The description of what the command is doing`
}

// Execute runs the command
func (c *RunCommand) Execute(f *flag.FlagSet) error {
    // Do whatever you need here
    fmt.Println(c.configFilePath)
    
    return nil
}

// FlagSet defines what flags to set for the command
func (c *RunCommand) SetFlags(f *flag.FlagSet) {
    // This will store the flag's value to the command's structure
    f.StringVar(&c.configFilePath, "config", "config.json", "Config file path")
}

// Name returns the command's name to be invoked from the CLI
func (c *RunCommand) Name() string {
    return "run"
}

Then, create a new CliHandler and register the previous CLI command:

func main() {
    cliHandler := new gocli.CliHandler()
    cliHandler.RegisterCommand(&RunCommand{})
    err := cliHandler.Handle()
    
    if err != nil {
        // Handle the error your way
    }
}

Running the command

# From the dev environment
go run ./*.go <command> -config /path/to/config.json

# Using the binary
/path/to/myapp <command> -config /path/to/config.json

For example:

/path/to/myapp run -config /path/to/config.json
# "Here is the config: config.json"

Viewing the usage

/path/to/myapp
# COMMANDS:
# run [-config=./config.json]:
#     The description of what the command is doing

Contributing

Please feel free to report any issue or improvement suggestion.

Authors

William Claude - Developer - Github

License

This project is licensed under the MIT License - see the LICENSE file for details

aziule / gocli