singularity-forge/docs/visualizer.md
Tom Boucher 1aebc06c46 docs: update documentation for v2.24 release features (#825)
- README: add parallel orchestration link, update loop diagram with validate-milestone phase
- architecture: add lazy provider loading, memory-extractor/store modules, update module table to v2.24
- auto-mode: add rate limit recovery section, parallel worker status in dashboard
- commands: add headless new-milestone command with --context/--context-text/--auto flags
- getting-started: add update check notification note
- troubleshooting: update rate limit recovery guidance
- visualizer: add task counts, discussion status to progress tab
2026-03-17 07:47:28 -06:00

94 lines
2.4 KiB
Markdown

# Workflow Visualizer
*Introduced in v2.19.0*
The workflow visualizer is a full-screen TUI overlay that shows project progress, dependencies, cost metrics, and execution timeline in an interactive four-tab view.
## Opening the Visualizer
```
/gsd visualize
```
Or configure automatic display after milestone completion:
```yaml
auto_visualize: true
```
## Tabs
Switch tabs with `Tab`, `1`-`4`, or arrow keys.
### 1. Progress
A tree view of milestones, slices, and tasks with completion status:
```
M001: User Management 3/6 tasks ⏳
✅ S01: Auth module 3/3 tasks
✅ T01: Core types
✅ T02: JWT middleware
✅ T03: Login flow
⏳ S02: User dashboard 1/2 tasks
✅ T01: Layout component
⬜ T02: Profile page
⬜ S03: Admin panel 0/1 tasks
```
Shows checkmarks for completed items, spinners for in-progress, and empty boxes for pending. Task counts and completion percentages are displayed at each level.
**Discussion status** is also shown when milestones have been through a discussion phase — indicates whether requirements were captured and what state the discussion left off in.
### 2. Dependencies
An ASCII dependency graph showing slice relationships:
```
S01 ──→ S02 ──→ S04
└───→ S03 ──↗
```
Visualizes the `depends:` field from the roadmap, making it easy to see which slices are blocked and which can proceed.
### 3. Metrics
Bar charts showing cost and token usage breakdowns:
- **By phase** — research, planning, execution, completion, reassessment
- **By slice** — cost per slice with running totals
- **By model** — which models consumed the most budget
Uses data from `.gsd/metrics.json`.
### 4. Timeline
Chronological execution history showing:
- Unit type and ID
- Start/end timestamps
- Duration
- Model used
- Token counts
Ordered by execution time, showing the full history of auto-mode dispatches.
## Controls
| Key | Action |
|-----|--------|
| `Tab` | Next tab |
| `Shift+Tab` | Previous tab |
| `1`-`4` | Jump to tab |
| `↑`/`↓` | Scroll within tab |
| `Escape` / `q` | Close visualizer |
## Auto-Refresh
The visualizer refreshes data from disk every 2 seconds, so it stays current if opened alongside a running auto-mode session.
## Configuration
```yaml
auto_visualize: true # show visualizer after milestone completion
```