Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/gizak/termui

Golang terminal dashboard
https://github.com/gizak/termui

Last synced: about 2 months ago
JSON representation

Golang terminal dashboard

Lists

README 

        
# termui



[demo cast under osx 10.10; Terminal.app; Menlo Regular 12pt.)](./_examples/demo.go)



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.



## Note



Please be aware that due to my fluctuating availability, the frequency of updates to this project may not always follow a consistent schedule. I would like to invite potential maintainers to contribute to this project. If you are interested in becoming a maintainer, please do not hesitate to reach out to me.



## Versions



termui is currently compatible with Go 1.15 (as in go.mod) and above (tracking the Debian's [oldstable](https://wiki.debian.org/DebianReleases)). Please use the version-numbered branch as stable release. The new changes will be pushed to master branch first and then merge to version branch.



## Features



- Several premade widgets for common use cases

- Easily create custom widgets

- Position widgets either in a relative grid or with absolute coordinates

- Keyboard, mouse, and terminal resizing events

- Colors and styling



## Installation



### Go modules



It is not necessary to `go get` termui, since Go will automatically manage any imported dependencies for you. Do note that you have to include `/v3` in the import statements as shown in the 'Hello World' example below.



### Dep



Add with `dep ensure -add github.com/gizak/termui`. With Dep, `/v3` should *not* be included in the import statements.



## Hello World



```go

package main



import (

	"log"



	ui "github.com/gizak/termui/v3"

	"github.com/gizak/termui/v3/widgets"

)



func main() {

	if err := ui.Init(); err != nil {

		log.Fatalf("failed to initialize termui: %v", err)

	}

	defer ui.Close()



	p := widgets.NewParagraph()

	p.Text = "Hello World!"

	p.SetRect(0, 0, 25, 5)



	ui.Render(p)



	for e := range ui.PollEvents() {

		if e.Type == ui.KeyboardEvent {

			break

		}

	}

}

```



## Widgets



- [BarChart](./_examples/barchart.go)

- [Canvas](./_examples/canvas.go) (for drawing braille dots)

- [Gauge](./_examples/gauge.go)

- [Image](./_examples/image.go)

- [List](./_examples/list.go)

- [Tree](./_examples/tree.go)

- [Paragraph](./_examples/paragraph.go)

- [PieChart](./_examples/piechart.go)

- [Plot](./_examples/plot.go) (for scatterplots and linecharts)

- [Sparkline](./_examples/sparkline.go)

- [StackedBarChart](./_examples/stacked_barchart.go)

- [Table](./_examples/table.go)

- [Tabs](./_examples/tabs.go)



Run an example with `go run _examples/{example}.go` or run each example consecutively with `make run-examples`.



## Documentation



- [wiki](https://github.com/gizak/termui/wiki)



## Uses



- [dockdash](https://github.com/byrnedo/dockdash)

- [expvarmon](https://github.com/divan/expvarmon)

- [go-ethereum/monitorcmd](https://github.com/ethereum/go-ethereum/blob/master/cmd/geth/monitorcmd.go)

- [go-jira-ui](https://github.com/mikepea/go-jira-ui)

- [gotop](https://github.com/cjbassi/gotop)

- [termeter](https://github.com/atsaki/termeter)



## Related Works



- [blessed-contrib](https://github.com/yaronn/blessed-contrib)

- [gocui](https://github.com/jroimartin/gocui)

- [termdash](https://github.com/mum4k/termdash)

- [tui-rs](https://github.com/fdehau/tui-rs)

- [tview](https://github.com/rivo/tview)



## License



[MIT](http://opensource.org/licenses/MIT)