egcmd

Package matthewdunsdon/egcmd provides you with a library to include examples for your commands in your CLI golang app.

Currently, this library is not intended for use in production, predominantly as it has been created learning golang.

The main features are:

• It defines an egcmd.Example type to describe an example CLI command, including arguments and environment variables
• It allows examples to be associated with the top level of your CLI app and with particular commands
• It provides an app.Find(...) function to find the examples that are associated a specific command, or with the top level of your application

---

• Install
• Usage
  • Adding your examples
  • Finding examples
• License

---

Install

With a correctly configured Go toolchain:

go get github.com/matthewdunsdon/egcmd

Usage

Adding your examples

To get started you should create an examples.go file in your project as the same level as package main. In this file you will want to set the correct package and import, which should look something like:

package main

import (
	"github.com/matthewdunsdon/egcmd"
)

Typically you can add your cli examples as variables, like shown below:

var (
	myAppEx = egcmd.New("myapp")
	_       = myAppEx.Example("init", "Initialise app data.")
	_       = myAppEx.Example("version --json", "Get application version details in json format.")

	initCmdEx = myAppEx.Command("init")
	_         = initCmdEx.Example("--defaults", "Initialise app data using the recommended defaults")
	_         = initCmdEx.Envs("MYAPP_PATH=~/Documents/", "", "Initialise app data to custom location using MYAPP_PATH")
)

You are by no means forced to organise your examples like this;

• You could add these to func init() or to a function of you own.
• Your examples do have to be in the main package, but you will need to link up your CLI help code with your egcmd app instance(s).

Finding examples

To find the examples that are associated a specific command, or with the top level of your application, you need to call the app.Find and supply a string that matches the application name and optionally the command name.

	// Results with examples from application top level
	results, ok := myAppEx.Find("")

	// Results with examples from `"init"` command
	results, ok = myAppEx.Find("init")

	// Results with examples from `"imports add"` command
	results, ok = myAppEx.Find("imports add")

License

MIT licensed. See the LICENSE file for details.