Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mum4k/termdash

Terminal based dashboard.
https://github.com/mum4k/termdash

dashboard golang terminal-based

Last synced: 10 days ago
JSON representation

Terminal based dashboard.

Host: GitHub
URL: https://github.com/mum4k/termdash
Owner: mum4k
License: apache-2.0
Created: 2018-03-24T12:01:49.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-09-24T12:45:02.000Z (about 2 months ago)
Last Synced: 2024-10-15T13:22:22.827Z (24 days ago)
Topics: dashboard, golang, terminal-based
Language: Go
Size: 109 MB
Stars: 2,708
Watchers: 29
Forks: 135
Open Issues: 46
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-go - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). (Command Line / Advanced Console UIs)
awesome-go - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). (Command Line / Advanced Console UIs)
go-awesome - termdash - Dashboard system based on Go Terminal (Open source library / Command Line)
awesome-go - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). Stars:`2.7K`. (Command Line / Advanced Console UIs)
awesome-go - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). (Command Line / Advanced Console UIs)
awesome-go-extra - termdash - 03-24T12:01:49Z|2022-08-22T21:07:59Z| (Build Automation / Advanced Console UIs)
fucking-awesome-go - termdash - Go terminal dashboard based on **termbox-go** and inspired by <b><code> 13193⭐</code></b> <b><code>   786🍴</code></b> [termui](https://github.com/gizak/termui)). (Command Line / Advanced Console UIs)
awesome-go-with-stars - termdash - Go terminal dashboard based on **termbox-go** and inspired by <code> 13199</code> [termui](https://github.com/gizak/termui). (Command Line / Advanced Console UIs)
awesome-go-plus - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). (Command Line / Advanced Console UIs)
awesome-go-plus - termdash - Go terminal dashboard based on **termbox-go** and inspired by [termui](https://github.com/gizak/termui). ![stars](https://img.shields.io/badge/stars-2723-blue) ![forks](https://img.shields.io/badge/forks-136-blue) (Command Line / Advanced Console UIs)

README

        [![Doc Status](https://godoc.org/github.com/mum4k/termdash?status.png)](https://godoc.org/github.com/mum4k/termdash)

[![Build Status](https://app.travis-ci.com/mum4k/termdash.svg?branch=master)](https://app.travis-ci.com/github/mum4k/termdash)

[![Coverage Status](https://coveralls.io/repos/github/mum4k/termdash/badge.svg?branch=master)](https://coveralls.io/github/mum4k/termdash?branch=master)

[![Go Report Card](https://goreportcard.com/badge/github.com/mum4k/termdash)](https://goreportcard.com/report/github.com/mum4k/termdash)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/mum4k/termdash/blob/master/LICENSE)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

# [](http://github.com/mum4k/termdash/wiki)

Termdash is a cross-platform customizable terminal based dashboard.

[](termdashdemo/termdashdemo.go)

The feature set is inspired by the

[gizak/termui](http://github.com/gizak/termui) project, which in turn was

inspired by

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

This rewrite focuses on code readability, maintainability and testability, see

the [design goals](doc/design_goals.md). It aims to achieve the following

[requirements](doc/requirements.md). See the [high-level design](doc/hld.md)

for more details.

# Public API and status

The public API surface is documented in the

[wiki](http://github.com/mum4k/termdash/wiki).

Private packages can be identified by the presence of the **/private/**

directory in their import path. Stability of the private packages isn't

guaranteed and changes won't be backward compatible.

There might still be breaking changes to the public API, at least until the

project reaches version 1.0.0. Any breaking changes will be published in the

[changelog](CHANGELOG.md).

# Current feature set

- Full support for terminal window resizing throughout the infrastructure.

- Customizable layout, widget placement, borders, margins, padding, colors, etc.

- Dynamic layout changes at runtime.

- Binary tree and Grid forms of setting up the layout.

- Focusable containers and widgets.

- Processing of keyboard and mouse events.

- Periodic and event driven screen redraw.

- A library of widgets, see below.

- UTF-8 for all text elements.

- Drawing primitives (Go functions) for widget development with character and

  sub-character resolution.

# Installation

To install this library, run the following:

```go

go get -u github.com/mum4k/termdash

cd github.com/mum4k/termdash

```

# Usage

The usage of most of these elements is demonstrated in

[termdashdemo.go](termdashdemo/termdashdemo.go). To execute the demo:

```go

go run termdashdemo/termdashdemo.go

```

# Documentation

Please refer to the [Termdash wiki](http://github.com/mum4k/termdash/wiki) for

all documentation and resources.

# Implemented Widgets

## The Button

Allows users to interact with the application, each button press runs a callback function.

Run the

[buttondemo](widgets/button/buttondemo/buttondemo.go).

```go

go run widgets/button/buttondemo/buttondemo.go

```

[](widgets/button/buttondemo/buttondemo.go)

## The TextInput

Allows users to interact with the application by entering, editing and

submitting text data. Run the

[textinputdemo](widgets/textinput/textinputdemo/textinputdemo.go).

```go

go run widgets/textinput/textinputdemo/textinputdemo.go

```

[](widgets/textinput/textinputdemo/textinputdemo.go)

Can be used to create text input forms that support keyboard navigation:

```go

go run widgets/textinput/formdemo/formdemo.go

```

[](widgets/textinput/formdemo/formdemo.go)

## The Gauge

Displays the progress of an operation. Run the

[gaugedemo](widgets/gauge/gaugedemo/gaugedemo.go).

```go

go run widgets/gauge/gaugedemo/gaugedemo.go

```

[](widgets/gauge/gaugedemo/gaugedemo.go)

## The Donut

Visualizes progress of an operation as a partial or a complete donut. Run the

[donutdemo](widgets/donut/donutdemo/donutdemo.go).

```go

go run widgets/donut/donutdemo/donutdemo.go

```

[](widgets/donut/donutdemo/donutdemo.go)

## The Text

Displays text content, supports trimming and scrolling of content. Run the

[textdemo](widgets/text/textdemo/textdemo.go).

```go

go run widgets/text/textdemo/textdemo.go

```

[](widgets/text/textdemo/textdemo.go)

## The SparkLine

Draws a graph showing a series of values as vertical bars. The bars can have

sub-cell height. Run the

[sparklinedemo](widgets/sparkline/sparklinedemo/sparklinedemo.go).

```go

go run widgets/sparkline/sparklinedemo/sparklinedemo.go

```

[](widgets/sparkline/sparklinedemo/sparklinedemo.go)

## The BarChart

Displays multiple bars showing relative ratios of values. Run the

[barchartdemo](widgets/barchart/barchartdemo/barchartdemo.go).

```go

go run widgets/barchart/barchartdemo/barchartdemo.go

```

[](widgets/barchart/barchartdemo/barchartdemo.go)

## The LineChart

Displays series of values on a line chart, supports zoom triggered by mouse

events. Run the

[linechartdemo](widgets/linechart/linechartdemo/linechartdemo.go).

```go

go run widgets/linechart/linechartdemo/linechartdemo.go

```

[](widgets/linechart/linechartdemo/linechartdemo.go)

## The SegmentDisplay

Displays text by simulating a 16-segment display. Run the

[segmentdisplaydemo](widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go).

```go

go run widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go

```

[](widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go)

# Contributing

If you are willing to contribute, improve the infrastructure or develop a

widget, first of all Thank You! Your help is appreciated.

Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines related

to the Google's CLA, and code review requirements.

As stated above the primary goal of this project is to develop readable, well

designed code, the functionality and efficiency come second. This is achieved

through detailed code reviews, design discussions and following of the [design

guidelines](doc/design_guidelines.md). Please familiarize yourself with these

before contributing.

If you're developing a new widget, please see the [widget

development](doc/widget_development.md) section.

Termdash uses [this branching model](https://nvie.com/posts/a-successful-git-branching-model/). When you fork the repository, base your changes off the [devel](https://github.com/mum4k/termdash/tree/devel) branch and the pull request should merge it back to the devel branch. Commits to the master branch are limited to releases, major bug fixes and documentation updates.

# Similar projects in Go

- [clui](https://github.com/VladimirMarkelov/clui)

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

- [gowid](https://github.com/gcla/gowid)

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

- [tui-go](https://github.com/marcusolsson/tui-go)

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

# Projects using Termdash

- [datadash](https://github.com/keithknott26/datadash): Visualize streaming or tabular data inside the terminal.

- [grafterm](https://github.com/slok/grafterm): Metrics dashboards visualization on the terminal.

- [perfstat](https://github.com/flaviostutz/perfstat): Analyze and show tips about possible bottlenecks in Linux systems.

- [gex](https://github.com/Tosch110/gex): Cosmos SDK explorer in-terminal.

- [ali](https://github.com/nakabonne/ali): ALI HTTP load testing tool with realtime analysis.

- [suimon](https://github.com/bartosian/suimon): SUI blockchain explorer and monitor. 

# Disclaimer

This is not an official Google product.