cli

README

dfuse CLI Library

This is a quick and simple library containing low-level primitive to create quick and hackish CLI applications without all the fuzz required for a full production app. This library is opiniated and aims at doing CLI tool rapidly.

Note This library is experimental and the API could change without notice.

Example

The folder ./example contains example usage of the library. You can run them easily with a go run ...

• Flat - go run ./example/flat
• Nested - go run ./example/nested

Public Helpers

Method	Description
cli.NoError(err, "file not found %q", fileName)	Exit the process with exit code 1 and prints fmt.Printf("file not found %q: %w\n", fileName, err) if err != nil
cli.Ensure(x == 0, "x point should be 0, got %d", x)	Exit the process with exit code 1 and prints fmt.Printf("x point should be 0, got %d\n", x) if condition received is false
cli.Quit("current date %d is too far away", time.Now())	Exit the process with exit code 1 and prints fmt.Printf("x point should be 0, got %d\n", x)
cli.FileExists("./some/file.png")	Returns true if the file received in argument exists, false otherwise
cli.CopyFile("current date %d is too far away", time.Now())	Exit the process with exit code 1 and prints fmt.Printf("x point should be 0, got %d\n", x)
-	-

Sample Boilerplate (copy/paste ready)

package main

import (
	"fmt"
	"os"

	"github.com/dfuse-io/cli"
	"github.com/dfuse-io/logging"
	"github.com/spf13/cobra"
	"go.uber.org/zap"
)

var zlog = zap.NewNop()

func init() {
	logging.TestingOverride()
}

func main() {
	cli.Run("runner", "Some random command runner with 2 sub-commands",
		Command(generateE,
			"generate",
			"Quick command summary, without a description",
		),
		Command(compareE,
			"compare <input_file>",
			"Quick command summary, with a description, the actual usage above is descriptive, you must handle the arguments manually",
			Description(`
				Description of the command, automatically de-indented by using first line identation,
				use 'go run ./example/nested compare --help to see it in action!
			`),
		),
	)
}

func generateE(cmd *cobra.Command, args []string) error {
	_, err := os.Getwd()
	cli.NoError(err, "unable to get working directory")

	fmt.Println("Generating something")
	return nil
}

func compareE(cmd *cobra.Command, args []string) error {
	shouldContinue, wasAnswered := cli.AskConfirmation(`Do you want to continue?`)
	if wasAnswered && shouldContinue {

	} else {
		fmt.Println("Not showing diff between files, run the following command to see it manually:")
	}

	return nil
}

var Run = cli.Run
var Command = cli.Command

type Description = cli.Description

Documentation

Index

• func AskConfirmation(label string, args ...interface{}) (answeredYes bool, wasAnswered bool)
• func CopyFile(inPath, outPath string)
• func Dedent(input string) string
• func Ensure(condition bool, message string, args ...interface{})
• func FileExists(path string) bool
• func NoError(err error, message string, args ...interface{})
• func Quit(message string, args ...interface{})
• func Root(usage, short string, opts ...CommandOption) *cobra.Command
• func Run(usage, short string, opts ...CommandOption)
• type BeforeAllHook
• type CommandOption
  • func Command(execute func(cmd *cobra.Command, args []string) error, usage, short string, ...) CommandOption
• type CommandOptionFunc
• type Description
• type Execute

Functions

func AskConfirmation

func AskConfirmation(label string, args ...interface{}) (answeredYes bool, wasAnswered bool)

func CopyFile

func CopyFile(inPath, outPath string)

func Dedent

func Dedent(input string) string

func Ensure

func Ensure(condition bool, message string, args ...interface{})

func FileExists

func FileExists(path string) bool

func NoError

func NoError(err error, message string, args ...interface{})

func Quit

func Quit(message string, args ...interface{})

func Root

func Root(usage, short string, opts ...CommandOption) *cobra.Command

func Run

func Run(usage, short string, opts ...CommandOption)

Types

type BeforeAllHook

type BeforeAllHook func(cmd *cobra.Command)

type CommandOption

type CommandOption interface {
	// contains filtered or unexported methods
}

func Command

func Command(execute func(cmd *cobra.Command, args []string) error, usage, short string, opts ...CommandOption) CommandOption

type CommandOptionFunc

type CommandOptionFunc func(cmd *cobra.Command)

type Description

type Description string

type Execute

type Execute func(cmd *cobra.Command, args []string) error