liveprogress

liveprogress is a golang library allowing to print and update progress bars on a terminal. It is heavily inspired by uiprogress but redone on top of the forked liveterm library in order to take advantage of its enhancements.

In addition of the features of liveterm, it also add (or changes):

• Automatic bar length if its width is 0
• Bars characters are runes (Unicode support thru liveterm)
• Remove unecessary mutexes
  • usage of atomic operations for bar progress
  • decorators can be added only when instanciating the bar
• Custom (dynamic) lines that can be anything (not necessarly a progress bar)
• Main line concept: a bar or a custom line that will always be printed last (usefull for global progress when others lines above it indicate specific progress)
• Ability to style the bar and decorators using termenv styles

Examples

Simple

Code available here.

if err := liveprogress.Start(); err != nil {
	panic(err)
}
bar := liveprogress.AddBar(
	liveprogress.WithPrependPercent(liveprogress.BaseStyle()),
	liveprogress.WithAppendDecorator(func(bar *liveprogress.Bar) string {
		return " Remaining:"
	}),
	liveprogress.WithAppendTimeRemaining(liveprogress.BaseStyle()),
)
// By default a bar total is set to 100
for i := 0; i < liveprogress.DefaultTotal; i++ {
	// Wait a random time
	time.Sleep(time.Duration(rand.Intn(300)) * time.Millisecond)
	// Increment the bar
	bar.CurrentIncrement()
}
if err := liveprogress.Stop(true); err != nil {
	panic(err)
}
fmt.Println("By setting the Stop() bool parameter to true, the progress bar is cleared at stop.")

Advanced

See full source code here.

Installation

go get -v github.com/hekmon/liveprogress/v2