Repolode
lyuangg

lyuangg/tui-dashboard

YAMLファイル1つでシェルコマンドのデータソースとウィジェットのグリッドを定義できる、Bubble Tea製の設定駆動型ターミナルダッシュボード。

スター
56
フォーク
4
未解決の Issue
0
最終コミット
4 日前

これは何?

tui-dashboardを使えば、Goコードを書かずにリアルタイムのターミナルダッシュボードを構築できます。1つのYAMLファイルでデータソースとレイアウトを定義します。データソースは一定間隔で実行するシェルコマンドで、レイアウトでは各ソースの出力を表示するウィジェットを行ごとに配置します。

各ソースには、text、number、array、timeseries、map、table、logsの7種類があります。ソースの種類によってスクリプト出力の解析方法と、表示に使えるウィジェットが決まります。ウィジェットはstat、gauge、chart、bar、heatmap、table、logs、textに対応しています。タイトル、ラベル、フォーマットにはGoテンプレートを使用でき、default、dracula、gruvbox、nord、lightの5つのカラーテーマが付属します。

プログラムはカレントディレクトリまたはXDG設定パスから設定ファイルを探します。--initフラグを指定すると、スクリプトとともに同梱のサンプルを既定の場所にコピーします。

主な機能

  • 01データソースとレイアウトを1つのYAMLファイルで定義できます。
  • 027種類のソースタイプによって、スクリプト出力の解析方法が決まります。
  • 03stat、gauge、chart、bar、heatmap、table、logs、textの各ウィジェットを利用できます。
  • 04タイトル、ラベル、フォーマットにはGoテンプレートを使います。
  • 055つの組み込みカラーテーマを備え、マウスホイールとキーボードでスクロールできます。

ユースケース

  • SSH経由でサーバーのCPU、メモリ、ロードを監視する。
  • CIの状態やキューの深さなど、シェルコマンドの出力をターミナルパネルに表示する。
  • 開発マシン向けに、ログやチャートを表示する個人用ステータス画面を作る。

クイックスタート

  1. 1

    リポジトリ内で一度だけスクリプトを実行可能にする

    chmod +x scripts/*.sh
  2. 2

    ダッシュボードを起動する

    go run .
  3. 3

    必要に応じて、同梱のサンプル設定ファイルをデフォルトのパスにコピーする

    go run . --init

使う前に知っておきたいこと

  • Go 1.25 以降が必要です。
  • ライセンスが指定されていないため、使用権が不明です。

トピック

よくある質問

tui-dashboard とは?
YAMLファイル1つでシェルコマンドのデータソースとウィジェットのグリッドを定義できる、Bubble Tea製の設定駆動型ターミナルダッシュボード。 tui-dashboardを使えば、Goコードを書かずにリアルタイムのターミナルダッシュボードを構築できます。1つのYAMLファイルでデータソースとレイアウトを定義します。データソースは一定間隔で実行するシェルコマンドで、レイアウトでは各ソースの出力を表示するウィジェットを行ごとに配置します。
tui-dashboard は無料で使えますか?ライセンスは?
tui-dashboard にはライセンスが明記されていません。コードは公開されていますが、ライセンスがない場合は再利用の許諾がないため、利用前に作者に確認することをおすすめします。
tui-dashboard は今もメンテナンスされていますか?
活発にメンテナンス中。tui-dashboard の最終コミットは 2026年10月16日 です。
tui-dashboard は何に使えますか?
SSH経由でサーバーのCPU、メモリ、ロードを監視する。 CIの状態やキューの深さなど、シェルコマンドの出力をターミナルパネルに表示する。 開発マシン向けに、ログやチャートを表示する個人用ステータス画面を作る。
tui-dashboard のインストール方法は?
リポジトリ内で一度だけスクリプトを実行可能にする: chmod +x scripts/*.sh ダッシュボードを起動する: go run . 必要に応じて、同梱のサンプル設定ファイルをデフォルトのパスにコピーする: go run . --init
tui-dashboard はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/lyuangg/tui-dashboard

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト