HUD Getting Started¶

The HUD is a live terminal dashboard that shows your active mission, session history, pipeline state, and real-time events — all in one view. This guide walks you through launching it and finding your way around.

Prerequisites¶

Python 3.12+
raise-cli[hud] installed:

pip install raise-cli[hud]

A RaiSE project initialized (rai init)

Run from your project directory

rai hud resolves its database from the current directory. If you launch from outside the project, all panels appear empty with no error message. Always cd into your project first.

Step 1: Launch the HUD¶

cd /path/to/your-project
rai hud

A full-screen terminal dashboard opens with five tabs along the top: Missions, Sessions, Pipeline, Events, and Insights. Data refreshes automatically every few seconds.

Step 2: Navigate with the Keyboard¶

Key	Action
`1`	Missions tab
`2`	Sessions tab
`3`	Pipeline tab
`4`	Events tab
`5`	Insights tab
`r`	Force refresh
`q`	Quit

Press q to exit cleanly at any time.

Step 3: Find Your Active Mission¶

Press 1 to open the Missions tab. Your active mission appears at the top with its objectives and current progress. If the tab is empty, no mission is bound to the current project — run rai mission new or rai mission switch to bind one.

What's Next¶

Tab Reference Guide — a breakdown of every panel, field, and KPI (coming in a future release)
HUD Architecture — how data flows from raise.db through HUDDataManager to each panel (coming in a future release)