2018-11-29 11:15:29 +08:00
# termui
2015-03-21 09:11:58 +08:00
2019-01-24 15:09:50 +08:00
[<img src="./_assets/demo.gif" alt="demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)" width="100%"> ](./_examples/demo.go )
2015-06-24 03:11:22 +08:00
2019-01-24 15:20:48 +08:00
termui is a cross-platform and fully-customizable terminal dashboard and widget library built on top of [termbox-go ](https://github.com/nsf/termbox-go ). It is inspired by [blessed-contrib ](https://github.com/yaronn/blessed-contrib ) and [tui-rs ](https://github.com/fdehau/tui-rs ) and written purely in Go.
The core components of termui include:
- built in widget implementations for common use cases
- utilities to create custom widgets
- a Grid for relative widget positioning
- an event system for keyboard, mouse and resizing events
- colors and styling
2018-11-29 13:13:29 +08:00
2015-10-28 03:24:29 +08:00
## Installation
2015-03-16 03:56:38 +08:00
2018-11-29 13:44:42 +08:00
Installing from the master branch is recommended:
2015-03-20 20:24:48 +08:00
2018-09-07 07:55:27 +08:00
```bash
2018-11-29 11:15:29 +08:00
go get -u github.com/gizak/termui@master
2018-09-07 07:55:27 +08:00
```
2015-03-20 20:24:48 +08:00
2019-01-24 12:12:10 +08:00
**Note**: termui is currently undergoing API changes so make sure to check the changelog when upgrading.
If you upgrade and notice something is missing or don't like a change, revert the upgrade and open an issue.
2019-01-24 15:09:50 +08:00
## Widgets
2015-02-09 01:00:00 +08:00
2019-01-24 15:09:50 +08:00
- [BarChart ](./_examples/barchart.go )
- [Canvas ](./_examples/canvas.go )
- [Gauge ](./_examples/gauge.go )
- [LineChart ](./_examples/linechart.go )
- [List ](./_examples/list.go )
- [Paragraph ](./_examples/paragraph.go )
- [PieChart ](./_examples/piechart.go )
- [Sparkline ](./_examples/sparkline.go )
- [StackedBarChart ](./_examples/stacked_barchart.go )
- [Table ](./_examples/table.go )
- [Tabs ](./_examples/tabs.go )
2015-02-09 01:00:00 +08:00
2019-01-24 15:09:50 +08:00
Run an example with `go run _examples/{example}.go` or run all of them consecutively with `make run-examples` .
2018-11-29 12:12:36 +08:00
2019-01-24 15:09:50 +08:00
## Documentation
2018-11-29 11:15:29 +08:00
2019-01-24 12:12:10 +08:00
- [wiki ](https://github.com/gizak/termui/wiki )
2015-02-09 01:00:00 +08:00
2018-11-29 11:15:29 +08:00
## Uses
2015-02-09 01:00:00 +08:00
2019-01-24 12:12:10 +08:00
- [cjbassi/gotop ](https://github.com/cjbassi/gotop )
2018-11-29 11:15:29 +08:00
- [go-ethereum/monitorcmd ](https://github.com/ethereum/go-ethereum/blob/96116758d22ddbff4dbef2050d6b63a7b74502d8/cmd/geth/monitorcmd.go )
2015-03-14 01:20:17 +08:00
2018-11-29 11:15:29 +08:00
## Related Works
2015-03-14 01:20:17 +08:00
2018-11-29 11:15:29 +08:00
- [blessed-contrib ](https://github.com/yaronn/blessed-contrib )
- [tui-rs ](https://github.com/fdehau/tui-rs )
- [gocui ](https://github.com/jroimartin/gocui )
2015-10-28 03:24:29 +08:00
2015-02-09 01:00:00 +08:00
## License
2018-09-07 07:55:27 +08:00
2019-01-24 12:12:10 +08:00
[MIT ](http://opensource.org/licenses/MIT )
