TUI#

edg includes a built-in terminal interface for monitoring workload performance in real time without external tooling. It provides live stats and QPS charts directly in your terminal.

--tui requires a Pro license.

Enabling the TUI#

Pass --tui to any command that runs a workload (run, all, perf breakpoint, or built-in workloads like workload bank run):

edg run \
  --driver pgx \
  --config workload.edg \
  --url ${DATABASE_URL} \
  --tui \
  -w 10 \
  -d 5m

You can also enable it with the EDG_TUI environment variable:

export EDG_TUI=true

--tui and --overwrite are mutually exclusive. The TUI replaces the default scrolling log output with an interactive full-screen view.

Views#

The TUI has two views you can switch between with Tab.

Stats view#

Shows a live table of query and transaction metrics, updated every second:

Queries display columns for count, errors, average latency, p50/p95/p99 latencies, and current QPS.

Transactions display columns for commits, rollbacks, errors, average latency, p50/p95/p99 latencies, and current TPS.

Chart view#

Shows a live time-series chart with one line per query or transaction:

Each series is colour-coded and numbered in the legend at the bottom of the chart.

The chart defaults to QPS but you can cycle through five metrics using the ← / → arrow keys:

• QPS (queries/transactions per second)
• Avg latency (ms)
• p50 latency (ms)
• p95 latency (ms)
• p99 latency (ms)

The active metric is shown in the status bar at the bottom of the screen. Time window, series focus, and all other controls work the same regardless of which metric is selected.

Keyboard shortcuts#