terminal

package module

Go to main page

Versions in this module

v1

v1.0.7

May 5, 2024

v1.0.6

Dec 8, 2023

v1.0.5

Dec 8, 2023

v1.0.4

Jul 7, 2022

v1.0.3

Feb 22, 2022

v1.0.2

Jan 1, 2022

v1.0.1

Jan 1, 2022

v1.0.0

Dec 2, 2021

Changes in this version

+ const ErrNotATTY

+ var DefaultStdout *ConsoleOutput

+ var DiscardedOutput *Output

+ var EscapingRegexp = regexp.MustCompile("([^\\\\]?)<")

+ var FormattingRegexp = regexp.MustCompile("(?i)<((" + tagRegex + ")?|/(" + tagRegex + ")?)>")

+ var IsTTY = isattypkg.IsTerminal — darwin/amd64, js/wasm, linux/amd64

+ var LogLevels = map[int]zerolog.Level

+ var Logger zerolog.Logger

+ var MakeRaw = term.MakeRaw — darwin/amd64, js/wasm, linux/amd64

+ var Restore = term.Restore — darwin/amd64, js/wasm, linux/amd64

+ var Stderr *Output

+ var Stdin = &Input

+ var Stdout *ConsoleOutput

+ var StyleRegexp = regexp.MustCompile("(?i)([^=]+)=([^;]+)(;|$)")

+ func AskConfirmation(message string, def bool) bool

+ func AskString(message string, validator func(string) (string, bool)) string

+ func AskStringDefault(message, def string, validator func(string) (string, bool)) string

+ func Eprint(a ...interface{}) (n int, err error)

+ func Eprintf(format string, a ...interface{}) (n int, err error)

+ func Eprintfln(format string, a ...interface{}) (n int, err error)

+ func Eprintln(a ...interface{}) (n int, err error)

+ func Escape(msg []byte) []byte

+ func EscapeTrailingBackslash(msg []byte) []byte

+ func Format(msg string) string

+ func FormatBlockMessage(format string, msg string) string

+ func Formatf(msg string, a ...interface{}) string

+ func GetLogLevel() int

+ func GetSize() (width, height int)

+ func HasNativeColorSupport(stream interface{}) bool

+ func HasPosixColorSupport() bool

+ func IsCI() bool

+ func IsCygwinTTY(fd uintptr) bool

+ func IsDebug() bool

+ func IsInteractive(stream interface{}) bool

+ func IsTTY(fd uintptr) bool — windows/amd64

+ func IsTerminal(stream interface{}) bool

+ func IsVerbose() bool

+ func MakeRaw(fd int) (*term.State, error) — windows/amd64

+ func Print(a ...interface{}) (n int, err error)

+ func Printf(format string, a ...interface{}) (n int, err error)

+ func Printfln(format string, a ...interface{}) (n int, err error)

+ func Println(a ...interface{}) (n int, err error)

+ func Restore(fd int, state *term.State) error — windows/amd64

+ func Scan(a ...interface{}) (n int, err error)

+ func Scanf(format string, a ...interface{}) (n int, err error)

+ func Scanln(a ...interface{}) (n int, err error)

+ func SetLogLevel(level int) error

+ func SymfonyStyle(stdout *ConsoleOutput, stdin *Input) style

+ type Color struct

+ func NewColor(foreground, background string, options []string) (*Color, error)

+ func (c *Color) Apply(text []byte) []byte

+ func (c *Color) Set() []byte

+ func (c *Color) Unset() []byte

+ type ConsoleOutput struct

+ Stderr *Output

+ Stdout *Output

+ func NewBufferedConsoleOutput(stdout, stderr io.Writer) *ConsoleOutput

+ func RemapOutput(out, err io.Writer) *ConsoleOutput

+ func (cs ConsoleOutput) Fd() uintptr

+ func (cs ConsoleOutput) GetFormatter() *Formatter

+ func (cs ConsoleOutput) SetDecorated(decorated bool)

+ func (cs ConsoleOutput) SetFormatter(formatter *Formatter)

+ func (cs ConsoleOutput) Write(p []byte) (int, error)

+ type Cursor struct

+ Writer io.Writer

+ func NewCursor(w io.Writer) Cursor

+ func (c Cursor) ClearLine() Cursor

+ func (c Cursor) ClearLineAfter() Cursor

+ func (c Cursor) ClearOutput() Cursor

+ func (c Cursor) ClearScreen() Cursor

+ func (c Cursor) Hide() Cursor

+ func (c Cursor) MoveDown(lines int) Cursor

+ func (c Cursor) MoveLeft(columns int) Cursor

+ func (c Cursor) MoveRight(columns int) Cursor

+ func (c Cursor) MoveToColumn(column int) Cursor

+ func (c Cursor) MoveToPosition(column, row int) Cursor

+ func (c Cursor) MoveUp(lines int) Cursor

+ func (c Cursor) RestorePosition() Cursor

+ func (c Cursor) SavePosition() Cursor

+ func (c Cursor) Show() Cursor

+ type FdHolder interface

+ Fd func() uintptr

+ type FdReader interface

+ type Formatter struct

+ Decorated bool

+ SupportsAdvancedDecoration bool

+ func NewFormatter() *Formatter

+ func (formatter *Formatter) AddAlias(from, to string)

+ func (formatter *Formatter) Format(msg []byte, w io.Writer) (written int, err error)

+ func (formatter *Formatter) FormatBytes(msg []byte) ([]byte, error)

+ func (formatter *Formatter) HasStyle(name string) bool

+ func (formatter *Formatter) SetStyle(name string, style *FormatterStyle)

+ type FormatterStyle struct

+ func NewFormatterStyle(foreground, background string, options []string) *FormatterStyle

+ func (style *FormatterStyle) GetHref() string

+ func (style *FormatterStyle) SetHref(href string)

+ type Input struct

+ func NewInput(reader io.Reader) *Input

+ func (input *Input) Fd() uintptr

+ func (input *Input) IsInteractive() bool

+ func (input *Input) Read(p []byte) (int, error)

+ func (input *Input) SetInteractive(interactive bool)

+ func (input *Input) SetReader(r io.Reader)

+ type Output struct

+ func NewOutput(w io.Writer, formatter *Formatter) *Output

+ func (o Output) Close() error

+ func (o Output) Fd() uintptr

+ func (o Output) Format(message string) string

+ func (o Output) Formatf(message string, a ...interface{}) string

+ func (o Output) IsQuiet() bool

+ func (o Output) Write(message []byte) (int, error)

+ type Spinner struct

+ PrefixIndicator string

+ PrefixText string

+ SuffixIndicator string

+ SuffixText string

+ Writer io.Writer

+ func NewSpinner(w io.Writer) *Spinner

+ func (s *Spinner) Active() bool

+ func (s *Spinner) Start()

+ func (s *Spinner) Stop()

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL