Home

Welcome to Termdash - an open-source, cross-platform customizable terminal dashboard.

This wiki is the main source of documentation for users and developers working with or contributing to the Termdash project.

Resources

• Introduction
• Release Notes
• API Documentation
• High-level design
• Developing a new widget

Getting started

Running the Termdash demo is the quickest way to start playing with Termdash. See the following paragraph for instruction on how to install Termdash and run the demo.

To explore more advanced use cases, refer to the Examples, the Tutorials and the API reference.

Installing

To install Termdash, run the following command:

go get -u github.com/mum4k/termdash
cd github.com/mum4k/termdash

Next try running the termdashdemo.go binary.

go run termdashdemo/termdashdemo.go

Supported Environments

Termdash is a higher level library that relies on libraries that expose a cell view of the terminal. Termdash currently uses tcell. This means that Termdash supports all the environment that are supported by tcell.

POSIX (Linux, FreeBSD, macOS, Solaris, etc.)

Most mainstream systems with well defined tty interface will work without any issues.

Windows

Windows applications are supported, e.g. native command prompt or power shell. Unfortunately mintty and other cygwin style application aren't supported since tcell doesn't support them.

Similar projects in Go

• clui
• gocui
• gowid
• termui
• tui-go
• tview

Projects using Termdash

• datadash: Visualize streaming or tabular data inside the terminal.
• grafterm: Metrics dashboards visualization on the terminal.
• perfstat: Analyze and show tips about possible bottlenecks in Linux systems.
• gex: Cosmos SDK explorer in-terminal.
• ali: ALI HTTP load testing tool with realtime analysis.

Questions or need help?

See the Talk to us for different ways of getting in touch.