root

Documentation

Overview

Package root defines the root configuration for the CLI.

Index

• type Config
  • func New(stdin io.Reader, stdout, stderr io.Writer) *Config
• type ExitError
  • func (e ExitError) Error() string

Types

type Config

type Config struct {
	Stdin   io.Reader
	Stdout  io.Writer
	Stderr  io.Writer
	Flags   *ff.FlagSet
	Command *ff.Command
}

Config holds shared I/O writers and the root ff.Command. All subcommand configs embed *Config to inherit these.

func New

func New(stdin io.Reader, stdout, stderr io.Writer) *Config

New returns a new root Config with the given I/O writers.

type ExitError

type ExitError int

ExitError is returned by commands that want a specific non-zero exit code without printing an additional error message. run() in main.go checks for ExitError with errors.As and calls os.Exit(int(e)) directly, bypassing the default "error: ..." printer.

func (ExitError) Error

func (e ExitError) Error() string