term

Documentation

Index

• type Terminal
  • func New() *Terminal
  • func (t *Terminal) Confirm(msg string, defaultAnswer bool) (confirmed, skipped bool)
  • func (t *Terminal) IsInteractive() bool
  • func (t *Terminal) IsTTY() bool
  • func (t *Terminal) MustStyle(text string, rules ...core.Style) string
  • func (t *Terminal) Style(text string, rules ...core.Style) (string, error)
  • func (t *Terminal) SupportsUTF8() bool

Types

type Terminal

type Terminal struct {
	NoInput bool
}

Terminal offers utilities to interact with the terminal.

func New

func New() *Terminal

func (*Terminal) Confirm

func (t *Terminal) Confirm(msg string, defaultAnswer bool) (confirmed, skipped bool)

Confirm is a shortcut to prompt a yes/no question to the user.

func (*Terminal) IsInteractive

func (t *Terminal) IsInteractive() bool

IsInteractive returns whether the app is attached to an interactive terminal and can prompt the user.

func (*Terminal) IsTTY

func (t *Terminal) IsTTY() bool

IsTTY returns whether the app is attached to an interactive terminal.

func (*Terminal) MustStyle

func (t *Terminal) MustStyle(text string, rules ...core.Style) string

func (*Terminal) Style

func (t *Terminal) Style(text string, rules ...core.Style) (string, error)

Style implements core.Styler using ANSI escape codes to be used with a terminal.

func (*Terminal) SupportsUTF8

func (t *Terminal) SupportsUTF8() bool

SupportsUTF8 returns whether the computer is configured to support UTF-8.