terminal

Documentation

Index

• type Terminal
  • func New(in io.Reader, out io.Writer, errorOut io.Writer) Terminal
  • func (t Terminal) Confirm(prompt string) bool
  • func (t Terminal) Hidden(prompt string) (string, error)
  • func (t Terminal) Read(prompt string) (string, error)

Types

type Terminal

type Terminal struct {
	Input       io.Reader
	Output      io.Writer
	ErrorOutput io.Writer
}

Terminal represents the terminal with input, output and error output.

func New

func New(in io.Reader, out io.Writer, errorOut io.Writer) Terminal

New terminal instance.

func (Terminal) Confirm

func (t Terminal) Confirm(prompt string) bool

Confirm asks the user for confirmation. If the answer is y, yes, or sure, the used confirmed, otherwise not.

func (Terminal) Hidden

func (t Terminal) Hidden(prompt string) (string, error)

Hidden reads from Input, but typed characters are hidden. Good for passwords, tokens, or other sensitive information.

func (Terminal) Read

func (t Terminal) Read(prompt string) (string, error)

Read text from input with optional prompt.