https://github.com/Gosuri/uilive

uilive is a go library for updating terminal output in realtime
https://github.com/Gosuri/uilive

Last synced: 20 days ago
JSON representation

uilive is a go library for updating terminal output in realtime

• Host: GitHub
• URL: https://github.com/Gosuri/uilive
• Owner: gosuri
• License: mit
• Created: 2015-11-16T06:13:10.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-07-22T11:29:29.000Z (over 1 year ago)
• Last Synced: 2024-10-22T04:25:30.083Z (22 days ago)
• Language: Go
• Homepage:
• Size: 324 KB
• Stars: 1,693
• Watchers: 17
• Forks: 87
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# uilive [![GoDoc](https://godoc.org/github.com/gosuri/uilive?status.svg)](https://godoc.org/github.com/gosuri/uilive) [![Build Status](https://travis-ci.org/gosuri/uilive.svg?branch=master)](https://travis-ci.org/gosuri/uilive)

uilive is a go library for updating terminal output in realtime. It provides a buffered [io.Writer](https://golang.org/pkg/io/#Writer) that is flushed at a timed interval. uilive powers [uiprogress](https://github.com/gosuri/uiprogress).

## Usage Example

Calling `uilive.New()` will create a new writer. To start rendering, simply call `writer.Start()` and update the ui by writing to the `writer`. Full source for the below example is in [example/main.go](example/main.go).

```go

writer := uilive.New()

// start listening for updates and render

writer.Start()

for i := 0; i <= 100; i++ {

  fmt.Fprintf(writer, "Downloading.. (%d/%d) GB\n", i, 100)

  time.Sleep(time.Millisecond * 5)

}

fmt.Fprintln(writer, "Finished: Downloaded 100GB")

writer.Stop() // flush and stop rendering

```

The above will render

![example](doc/example.gif)

## Installation

```sh

$ go get -v github.com/gosuri/uilive

```