comm

Documentation

Index

• func Configure(noProgress, quiet, verbose, json, panic bool)
• func Debug(msg string)
• func Debugf(format string, args ...interface{})
• func Die(msg string)
• func Dief(format string, args ...interface{})
• func EndProgress()
• func GetTheme() *progressTheme
• func Log(msg string)
• func Logf(format string, args ...interface{})
• func Logl(level string, msg string)
• func Loglf(level string, format string, args ...interface{})
• func NewStateConsumer() *pwr.StateConsumer
• func Opf(format string, args ...interface{})
• func Progress(perc float64)
• func ProgressLabel(label string)
• func StartProgress()
• func Statf(format string, args ...interface{})
• func Warn(msg string)
• func Warnf(format string, args ...interface{})

Functions

func Configure

func Configure(noProgress, quiet, verbose, json, panic bool)

Configure sets all logging options in one go

func Debug

func Debug(msg string)

Debug messages are like Info messages, but printed only when verbose

func Debugf

func Debugf(format string, args ...interface{})

Debugf is a formatted variant of Debug

func Die

func Die(msg string)

Die exits with a non-zero exit code after giving a reson to the client

func Dief

func Dief(format string, args ...interface{})

Dief is a formatted variant of Die

func EndProgress

func EndProgress()

EndProgress stops refreshing the progress bar and erases it.

func GetTheme

func GetTheme() *progressTheme

GetTheme returns the theme used to show progress

func Log

func Log(msg string)

Log sends an informational message to the client

func Logf

func Logf(format string, args ...interface{})

Logf sends a formatted informational message to the client

func Logl

func Logl(level string, msg string)

Logl logs a message of a given level

func Loglf

func Loglf(level string, format string, args ...interface{})

Loglf logs a formatted message of a given level

func NewStateConsumer

func NewStateConsumer() *pwr.StateConsumer

NewStateConsumer returns an implementor of `pwr.StateConsumer` that prints directly to the console via butler's logging functions.

func Opf

func Opf(format string, args ...interface{})

Opf prints a formatted string informing the user on what operation we're doing

func Progress

func Progress(perc float64)

Progress sets the completion of a task whose progress is being printed It only has an effect if StartProgress was already called.

func ProgressLabel

func ProgressLabel(label string)

ProgressLabel sets the string printed next to the progress indicator

func StartProgress

func StartProgress()

StartProgress begins a period in which progress is regularly printed

func Statf

func Statf(format string, args ...interface{})

Statf prints a formatted string informing the user how fast the operation went

func Warn

func Warn(msg string)

Warn lets the user know about a problem that's non-critical

func Warnf

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

Warnf is a formatted variant of Warn