Repolode
Submit
lyuangg

lyuangg/tui-dashboard

A config-driven terminal dashboard built on Bubble Tea, where one YAML file defines shell-command data sources and a grid of widgets.

View on GitHub
Stars
56
Forks
4
Open issues
0
Last commit
4 days ago

What is it?

tui-dashboard lets you build a live terminal dashboard without writing Go code. A single YAML file declares the data sources, which are shell commands run on a set interval, and the layout, which arranges widgets in rows that display each source's output.

Each source has one of seven types: text, number, array, timeseries, map, table, or logs. The type determines how the script's output is parsed and which widgets can display it. Widgets include stat, gauge, chart, bar, heatmap, table, logs, and text. Titles, labels and formats are Go templates, and five color themes are included: default, dracula, gruvbox, nord, and light.

The program looks for a config file in the current directory or in the XDG config path, and a --init flag copies a bundled example with its scripts to the default location.

Key features

  • 01Defines data sources and layout in a single YAML file.
  • 02Seven source types control how script output is parsed.
  • 03Widgets include stat, gauge, chart, bar, heatmap, table, logs and text.
  • 04Titles, labels and formats are Go templates.
  • 05Five built-in color themes, with mouse wheel and keyboard scrolling.

Use cases

  • Watching CPU, memory and load on a server over SSH.
  • Showing custom shell command output, such as CI status or queue depth, in a terminal panel.
  • Building a personal status screen with logs and charts for a development machine.

Quick start

  1. 1

    Make the scripts executable (run once in the repo)

    chmod +x scripts/*.sh
  2. 2

    Run the dashboard

    go run .
  3. 3

    Optionally copy the bundled example config to the default path

    go run . --init

Things to know

  • Requires Go 1.25 or newer.
  • No license is specified, so usage rights are unclear.

Topics

#terminal#tui#dashboard#bubble-tea#golang#yaml#monitoring#config-driven

FAQ

What is tui-dashboard?
A config-driven terminal dashboard built on Bubble Tea, where one YAML file defines shell-command data sources and a grid of widgets. tui-dashboard lets you build a live terminal dashboard without writing Go code. A single YAML file declares the data sources, which are shell commands run on a set interval, and the layout, which arranges widgets in rows that display each source's output.
Is tui-dashboard free to use? What license does it have?
tui-dashboard has no declared license. Its code is public, but without a license you have no explicit permission to reuse it; ask the author before relying on it.
Is tui-dashboard still maintained?
Actively maintained. The last commit to tui-dashboard was on Oct 16, 2026.
What can I use tui-dashboard for?
Watching CPU, memory and load on a server over SSH. Showing custom shell command output, such as CI status or queue depth, in a terminal panel. Building a personal status screen with logs and charts for a development machine.
How do I install tui-dashboard?
Make the scripts executable (run once in the repo): chmod +x scripts/*.sh Run the dashboard: go run . Optionally copy the bundled example config to the default path: go run . --init
Where can I get tui-dashboard?
The source code and installation instructions are on GitHub: https://github.com/lyuangg/tui-dashboard

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects