Skip to content
Simple and complete API for building command line applications in Go
Branch: master
Clone or download
osklyar Merge pull request #3 from ocavue/fix_readme
Fix a typo error in README
Latest commit 4ef51dc May 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Adds support for -- to pass arguments through to subprocess Dec 13, 2017
.travis.yml Adds travis build and fixes 2 docs issues May 27, 2017
LICENSE Fixes copyright Oct 29, 2017
README.md Fix a typo error in README Apr 9, 2019
app.go Moves cli to teris Oct 29, 2017
command.go Moves cli to teris Oct 29, 2017
option.go Moves cli to teris Oct 29, 2017
parse.go Adds support for -- to pass arguments through to subprocess Dec 13, 2017
parse_test.go Adds support for -- to pass arguments through to subprocess Dec 13, 2017
run_test.go
usage.go Prints subcommsnd shortcuts and aligns options with and without char Feb 22, 2018
usage_test.go Prints subcommsnd shortcuts and aligns options with and without char Feb 22, 2018

README.md

Build status Coverage GoReportCard API documentation

Simple and complete API for building command line applications in Go

Module cli provides a simple, fast and complete API for building command line applications in Go. In contrast to other libraries the emphasis is put on the definition and validation of positional arguments, handling of options from all levels in a single block as well as a minimalistic set of dependencies.

The core of the module is the command, option and argument parsing logic. After a successful parsing the command action is evaluated passing a slice of (validated) positional arguments and a map of (validated) options. No more no less.

Definition

co := cli.NewCommand("checkout", "checkout a branch or revision").
  WithShortcut("co").
  WithArg(cli.NewArg("revision", "branch or revision to checkout")).
  WithOption(cli.NewOption("branch", "Create branch if missing").WithChar('b').WithType(cli.TypeBool)).
  WithOption(cli.NewOption("upstream", "Set upstream for the branch").WithChar('u').WithType(cli.TypeBool)).
  WithAction(func(args []string, options map[string]string) int {
    // do something
    return 0
  })

add := cli.NewCommand("add", "add a remote").
  WithArg(cli.NewArg("remote", "remote to add"))

rmt := cli.NewCommand("remote", "Work with git remotes").
  WithCommand(add)

app := cli.New("git tool").
  WithOption(cli.NewOption("verbose", "Verbose execution").WithChar('v').WithType(cli.TypeBool)).
  WithCommand(co).
  WithCommand(rmt)
  // no action attached, just print usage when executed

os.Exit(app.Run(os.Args, os.Stdout))

Execution

Given the above definition for a git client, e.g. gitc, running gitc with no arguments or with -h will produce the following output (the exit code will be 1 in the former case, because the action is missing, and 0 in the latter, because help was explicitly requested):

gitc [--verbose]

Description:
    git tool

Options:
    -v, --verbose   Verbose execution

Sub-commands:
    git checkout    checkout a branch or revision
    git remote      Work with git remotes

Running gitc with arguments matching e.g. the checkout definition, gitc co -vbu dev or gitc checkout -v --branch -u dev will execute the command as expected. Running into a parsing error, e.g. by providing an unknown option gitc co -f dev, will output a parsing error and a short usage string:

fatal: unknown flag -f
usage: gitc checkout [--verbose] [--branch] [--upstream] <revision>

License and copyright

Copyright (c) 2017. Oleg Sklyar and teris.io. MIT license applies. All rights reserved.
You can’t perform that action at this time.