cmd

Documentation

Index

• Variables
• func PrintUsage()
• type ArgNotFoundError
  • func (e ArgNotFoundError) Error() string
• type ArgParser
• type Command
  • func Parse(args []string) (Command, error)
• type UsagePrinter

Variables

var (
	ErrHelpful = errors.New("user needs help")
	ErrNoArgs  = errors.New("no arguments found")
)

Functions

func PrintUsage

func PrintUsage()

Types

type ArgNotFoundError

type ArgNotFoundError string

func (ArgNotFoundError) Error

func (e ArgNotFoundError) Error() string

type ArgParser

type ArgParser func([]string) (Command, error)

type Command

type Command interface {
	Setup() error

	// Run and block until context cancel
	Run(context.Context) error

	// Help by printing a usage string. Currently not used anywhere.
	Help() string

	// Describe the command shortly
	Describe() string

	// Flagset which defines the flags for the command
	Flagset() *flag.FlagSet
}

func Parse

func Parse(args []string) (Command, error)

type UsagePrinter

type UsagePrinter func()