$ Usage

Exec mode

Run a command directly with --:

tgdash -- terragrunt run --all plan

tgdash spawns the command, captures its output, and renders the dashboard. This is the recommended way to use tgdash.

Alternatively, pipe any Terragrunt command into tgdash:

terragrunt run --all plan 2>&1 | tgdash

Any command that produces [unit/path]-prefixed output works with either mode:

tgdash -- terragrunt run --all apply
tgdash -- terragrunt run --all validate

tgdash parses the streaming output and shows:

Unit status - Each Terragrunt unit with its current state (waiting, running, done, error)
Plan summaries - Resources to add, change, and destroy per unit
Apply results - Final resource counts after apply
Errors - Detected errors highlighted and filterable
Time estimates - Based on historical run data

Navigate with vim-style keybindings: j/k to move between units, Enter to expand/collapse details, G to jump to bottom, gg to jump to top.

tgdash has two views you can switch between with Tab:

The default view. Shows each unit with full detail including status, plan summary, output lines, and timing.

A compact overview showing all units in a table format. Good for large repos with many units where you want to see overall progress at a glance.

Press e to toggle error filtering. When active, only units with errors are shown, making it easy to find and diagnose failures in large runs.

Press / to enter search mode. Type to filter units by path. Press Escape to clear the search.