Skip to main content

TUI Mode

Running scout without a subcommand launches an interactive terminal dashboard. The TUI provides a real-time view of service health, alerts, dependencies, and logs — all from your terminal.

scout TUI demo

Usage

scout
note

TUI mode requires an active authentication session. Run scout login first.

Views

The TUI has three main views, accessible via keyboard navigation.

Home

The default landing view shows a health summary dashboard with three sections (cycle with Tab):

SectionDescription
HeatmapService health visualization. Switch modes with 14: error rate, latency, alerts, dependencies
AlertsActive and firing alerts with rule names, severity, and timestamps
ServicesTable of all services with error rates, latency, last-seen timestamps, and dependency counts

In the Services section, sort by different columns:

KeySort By
eError rate
lLatency
nName
dDependencies
tStatus
oLast seen

Services

A searchable list of all discovered services. Filter by name with /, then press Enter to confirm or Esc to clear. Select a service and press L to view its logs.

Logs

A live log stream for the selected service. Shows timestamp, severity, and message body. Press Enter to expand a log entry and view trace ID, span ID, attributes, and resource metadata.

FeatureKey
Toggle autoscrolls (fetches new logs every 2 seconds)
Toggle line wrapw
Filter logs/
Expand/collapse entryEnter
Horizontal scroll (wrap off)Left / Right

Keyboard Shortcuts

Global

KeyAction
qQuit
Ctrl+CForce quit
?Toggle help overlay
rRefresh data
j / DownMove down
k / UpMove up
gJump to top
GJump to bottom

Home View

KeyAction
TabCycle sections (Heatmap, Alerts, Services)
14Switch heatmap mode (error rate, latency, alerts, dependencies)
Left / RightPage through heatmap
EnterOpen alert URL or view selected service
sSwitch to Services view

Services View

KeyAction
/Enter filter mode
LView logs for selected service
EscBack to Home

Logs View

KeyAction
sToggle autoscroll
wToggle line wrap
/Filter logs
EnterExpand/collapse log detail
Left / RightHorizontal scroll (wrap off)
Home / EndJump to start/end of line
EscClose detail or go back to Services

Auto-Refresh

The TUI refreshes data automatically in the background:

DataInterval
Services and topologyEvery 30 seconds
Health summaryEvery 30 seconds
Logs (autoscroll on)Every 2 seconds

Press r at any time to trigger an immediate refresh.

See Also

  • login — authenticate before launching the TUI
  • logs — query logs from the command line
  • service-map — view service topology from the command line
Was this page helpful?