32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
|
# uilive [](https://godoc.org/github.com/gosuri/uilive) [](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
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ go get -v github.com/gosuri/uilive
|
||
|
|
```
|