Dashboard user guide

Interactive browser UI for exploring a repository after discover. This guide is for end users; engineering detail lives in dashboard-design.md.

CLI equivalents: each tab’s Query Guide panel lists matching rg-build commands.

Prerequisites

1. Index the repo:

cd /path/to/your/repo
rg-build discover . --with-dashboard          # graph + dashboard bundle
# or
rg-build discover . --with-cfg --with-security --with-taint --with-dashboard    # CFG, PDG, taint + dashboard

2. Open the dashboard over HTTP (required for WASM):

# Option A — integrated server (dashboard + query API)
rg-build serve --open

# Option B — static files only
cd .rgbuilder/dashboard && python3 -m http.server 8765
# open http://localhost:8765/

Do not open index.html via file:// — the graph worker cannot load graph_payload.bin.

Layout

Screenshot placeholders (capture with dashboard/scripts/capture-migration-screenshots.mjs pattern → docs/images/dashboard/):

• dash-overview.png — full shell with stat cards
• dash-query-guide.png — Query Guide tab

Tab guide

Search

• Natural-language and keyword search over indexed functions (default code-daemon; offline vocab or hash via CLI).
• Late fusion (on by default) blends Hamming similarity with blast score, PageRank, name overlap, and token-bloom sketches.
• Requires rg-build semantic index (choose embedder at index time) and rg-build serve (HTTP API at /api/semantic/* — not static-only hosting). Restart serve after rebuilding the index.
• Status badge shows model_id (e.g. vocab-accumulate-v1).
• CLI: semantic index [--embedder vocab], semantic query "…" (--keyword-and, --no-fusion, --expand neighbors)

Graph

• Package metagraph — zoomable WebGL view of communities / packages.
• Community names — heuristic labels (package path, dominant tokens, infrastructure hubs), not anonymous Community N when inference succeeds. Refresh with rg-build communities label --write.
• Drill-down — click a package node to expand member functions (WASM expand).
• Filters — search box, community filter, function/class type mask.
• CLI: gql --macro-name all_communities, communities list, export, metrics --communities

Functions

• Sortable table: PageRank, betweenness, harmonic, blast score.
• WASM paginated list over the full function inventory.
• CLI: gql --macro-name all_functions, metrics --pagerank

CFG

• Pick a function from the list; view control-flow blocks and dominance.
• Large repos: when per-function JSON is omitted (archive_only), a banner offers Load CFG graph — fetches one function from the CFG record pack on demand.
• CLI: inspect <symbol> cfg, inspect <symbol> dom --frontiers

Dataflow

• PDG visualization and statement list; dominator tree mode.
• Field mutations (CPG): type filter (e.g. ShoppingCart), exclude constructors, click a hit to open that function and highlight the write line. Backed by mutations_index.json from field_write.index.bin (discover --with-cfg --with-dashboard).
• CLI: inspect <symbol> pdg, cpg mutations --type ShoppingCart --exclude-ctors, slice ... --view pdg

Slice

• Enter file path, line, variable, direction; highlights affected lines.
• Requires discover --with-cfg / --with-taint and exported slice bundles.
• CLI: slice <file> --line N --variable V --function <methodName>

Blast radius

• Summary cards use full-graph blast scores from discover.
• Caller table respects the depth slider (may differ from sidebar score).
• CLI: blast-radius <symbol> --depth N

Taint

• Lists source→sink flows exported at discover time.
• CLI: slice ... --taint for on-demand trace at a line

Migration

• Tune α/β/γ weights and presets; package graph + ordered table.
• Requires discover --with-cfg --with-security --with-taint --with-dashboard --with-harmonic --export-migration-hints.
• Screenshots: design/README.md (figures under docs/images/design/).
• CLI: discover . --with-cfg --with-security --with-taint --with-dashboard --with-harmonic --export-migration-hints

Query Guide

• Scrollable CLI cookbook organized by tab (prerequisites, commands, notes).
• Validated against gbuilder: dashboard/scripts/validate-guide-cli-gbuilder.sh
• Live GQL in the browser requires rg-build serve (HTTP API).

Large repositories

Troubleshooting

See also

• Introduction — Dashboard
• User Guide
• HTTP API — rg-build serve query endpoint