cli

Documentation

Overview

Package cli provides access to commuter over the command line via Stdin, Stdout, and command line arguments.

Index

• type ArgParser
  • func NewArgParser(args []string) *ArgParser
  • func (a *ArgParser) Parse(conf *cmd.Configuration, s cmd.StorageProvider) (cmd.RunnerValidator, error)
• type Stdin
  • func NewStdin() Stdin
• type Stdout
  • func NewStdout() Stdout
  • func (s Stdout) Indicate(msg string, args ...interface{})

Types

type ArgParser

type ArgParser struct {
	Args []string
}

ArgParser parses input arguments from the command line.

func NewArgParser

func NewArgParser(args []string) *ArgParser

NewArgParser initializes and returns an ArgParser.

func (*ArgParser) Parse

func (a *ArgParser) Parse(conf *cmd.Configuration, s cmd.StorageProvider) (cmd.RunnerValidator, error)

Parse attempts to determine which command is being executed, parse its flags, and return it.

type Stdin

type Stdin struct {
	*bufio.Scanner
}

Stdin provides an input mechanism for the user via the command line.

func NewStdin

func NewStdin() Stdin

NewStdin initializes and returns a Stdin.

type Stdout

type Stdout struct {
	io.Writer
}

Stdout provides an output mechanism to notify the user via stdout.

func NewStdout

func NewStdout() Stdout

NewStdout initializes and returns a new Stdout.

func (Stdout) Indicate

func (s Stdout) Indicate(msg string, args ...interface{})

Indicate prints an indication to the user.