cli

Documentation

Overview

Package cli contains the dgo CLI (Command Line Interface)

Index

• type Command
  • func Dgo(out, err io.Writer) Command
  • func Validate(parent Command) Command

Types

type Command

type Command interface {
	// Do parses the arguments and runs the command
	Do([]string) int

	// Help prints the help for the command
	Help()

	// MissingOption prints the missing option error for the given option and returns 1
	MissingOption(string) int

	// RunWithCatch runs the given function, recovers error panics and reports them. It returns a non zero exit status
	// in case an error was recovered
	RunWithCatch(func() int) int

	// Name returns the name of the command
	Name() string

	// Err returns the error output writer
	Err() io.Writer

	// Out returns the output writer
	Out() io.Writer

	// Verbose returns the verbosity
	Verbose() bool
}

Command is the interface implemented by all dgo commands. Both global and sub commands.

func Dgo

func Dgo(out, err io.Writer) Command

Dgo creates the global dgo command

func Validate

func Validate(parent Command) Command

Validate is the Dgo sub command that reads and validates YAML input using a spec written in YAML or Dgo