cli

Documentation

Index

• Variables
• func Fprint(w io.Writer, msg string)
• func HasColors(str string) bool
• func RmColors(str string) string
• func WordWrap(lineWidth uint, texts ...string) string
• type CLI
  • func (cli CLI) Ask(query string, args ...interface{}) (string, error)
  • func (cli CLI) Error(msg string)
  • func (cli CLI) Errorf(format string, args ...interface{})
  • func (cli CLI) Fask(w io.Writer, query string, args ...interface{}) (string, error)
  • func (cli CLI) Info(msg string)
  • func (cli CLI) Infof(format string, args ...interface{})
  • func (cli CLI) PrefixedLogger(prefix string) *Logger
  • func (cli CLI) Print(msg string)
  • func (cli CLI) Printf(msg string, args ...interface{})
  • func (cli CLI) Prompt(commands []PromptCmd) error
  • func (cli CLI) Warn(msg string)
  • func (cli CLI) Warnf(format string, args ...interface{})
• type ColWriter
  • func NewColWriter(w io.Writer, sep string) *ColWriter
  • func (cw *ColWriter) Flush() error
  • func (cw *ColWriter) Write(buf []byte) (n int, err error)
• type Color
  • func (c Color) Black(msg string) string
  • func (c Color) Blue(msg string) string
  • func (c Color) Code(attr ColorCode, args ...ColorCode) string
  • func (c Color) ColorFail() string
  • func (c Color) ColorNeutral() string
  • func (c Color) ColorReset() string
  • func (c Color) ColorSuccess() string
  • func (c Color) ColorWarn() string
  • func (c Color) Cyan(msg string) string
  • func (c Color) Fail(msg string) string
  • func (c Color) Green(msg string) string
  • func (c Color) Magenta(msg string) string
  • func (c Color) Neutral(msg string) string
  • func (c Color) Red(msg string) string
  • func (c Color) Success(msg string) string
  • func (c Color) Warn(msg string) string
  • func (c Color) White(msg string) string
  • func (c Color) Yellow(msg string) string
• type ColorCode
• type Logger
  • func (l *Logger) Error(msg string)
  • func (l *Logger) Errorf(format string, args ...interface{})
  • func (l *Logger) Fprint(w io.Writer, msg string)
  • func (l *Logger) Info(msg string)
  • func (l *Logger) Infof(format string, args ...interface{})
  • func (l *Logger) Print(msg string)
  • func (l *Logger) Warn(msg string)
  • func (l *Logger) Warnf(format string, args ...interface{})
• type PromptCmd
• type Table
  • func NewTable() *Table
  • func (t *Table) Header(cells ...string) *Table
  • func (t *Table) Render() string
  • func (t *Table) Row(cells ...string) *Table

Variables

var ErrPromptCommandIsNotKnown = errors.New("prompt command is not known")

var Input io.Reader = os.Stdin

var NoColor bool

Functions

func Fprint

func Fprint(w io.Writer, msg string)

func HasColors

func HasColors(str string) bool

func RmColors

func RmColors(str string) string

func WordWrap

func WordWrap(lineWidth uint, texts ...string) string

Types

type CLI

type CLI struct {
	Reader  io.Reader
	Writer  io.Writer
	Errorer io.Writer

	Color Color
}

func (CLI) Ask

func (cli CLI) Ask(query string, args ...interface{}) (string, error)

func (CLI) Error

func (cli CLI) Error(msg string)

func (CLI) Errorf

func (cli CLI) Errorf(format string, args ...interface{})

func (CLI) Fask

func (cli CLI) Fask(w io.Writer, query string, args ...interface{}) (string, error)

func (CLI) Info

func (cli CLI) Info(msg string)

func (CLI) Infof

func (cli CLI) Infof(format string, args ...interface{})

func (CLI) PrefixedLogger

func (cli CLI) PrefixedLogger(prefix string) *Logger

func (CLI) Print

func (cli CLI) Print(msg string)

func (CLI) Printf

func (cli CLI) Printf(msg string, args ...interface{})

func (CLI) Prompt

func (cli CLI) Prompt(commands []PromptCmd) error

func (CLI) Warn

func (cli CLI) Warn(msg string)

func (CLI) Warnf

func (cli CLI) Warnf(format string, args ...interface{})

type ColWriter

type ColWriter struct {
	PadLastColumn  bool
	SprintLineFunc func([]string, []int) string
	DecorateLine   func(string) string
	// contains filtered or unexported fields
}

func NewColWriter

func NewColWriter(w io.Writer, sep string) *ColWriter

func (*ColWriter) Flush

func (cw *ColWriter) Flush() error

func (*ColWriter) Write

func (cw *ColWriter) Write(buf []byte) (n int, err error)

type Color

type Color struct {
	Disabled bool
}

func (Color) Black

func (c Color) Black(msg string) string

func (Color) Blue

func (c Color) Blue(msg string) string

func (Color) Code

func (c Color) Code(attr ColorCode, args ...ColorCode) string

func (Color) ColorFail

func (c Color) ColorFail() string

func (Color) ColorNeutral

func (c Color) ColorNeutral() string

func (Color) ColorReset

func (c Color) ColorReset() string

func (Color) ColorSuccess

func (c Color) ColorSuccess() string

func (Color) ColorWarn

func (c Color) ColorWarn() string

func (Color) Cyan

func (c Color) Cyan(msg string) string

func (Color) Fail

func (c Color) Fail(msg string) string

func (Color) Green

func (c Color) Green(msg string) string

func (Color) Magenta

func (c Color) Magenta(msg string) string

func (Color) Neutral

func (c Color) Neutral(msg string) string

func (Color) Red

func (c Color) Red(msg string) string

func (Color) Success

func (c Color) Success(msg string) string

func (Color) Warn

func (c Color) Warn(msg string) string

func (Color) White

func (c Color) White(msg string) string

func (Color) Yellow

func (c Color) Yellow(msg string) string

type ColorCode

type ColorCode int

const (
	// Foreground colors.
	BlackFG ColorCode = iota + 30
	RedFG
	GreenFG
	YellowFG
	BlueFG
	MagentaFG
	CyanFG
	WhiteFG

	Defaultt ColorCode = 39

	Reset ColorCode = 0
	Bold  ColorCode = 1

	ResetCode = "\033[0m"
)

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func (*Logger) Error

func (l *Logger) Error(msg string)

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...interface{})

func (*Logger) Fprint

func (l *Logger) Fprint(w io.Writer, msg string)

func (*Logger) Info

func (l *Logger) Info(msg string)

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...interface{})

func (*Logger) Print

func (l *Logger) Print(msg string)

func (*Logger) Warn

func (l *Logger) Warn(msg string)

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...interface{})

type PromptCmd

type PromptCmd struct {
	TriggerInputs []string
	Description   string
	Action        func()
}

type Table

type Table struct {
	// contains filtered or unexported fields
}

Table represents data as a table.

func NewTable

func NewTable() *Table

NewTable creates a new table.

func (*Table) Header

func (t *Table) Header(cells ...string) *Table

func (*Table) Render

func (t *Table) Render() string

Render renders the table.

func (*Table) Row

func (t *Table) Row(cells ...string) *Table