Beads Viewer (bv)
The elegant, keyboard-driven terminal interface for the Beads issue tracker.
Main split view: fast list + rich details |
Kanban board (`b`) for flow at a glance |
Insights panel: PageRank, critical path, cycles |
Graph view (`g`): navigate the dependency DAG |
โก Quick Install
curl -fsSL "https://raw.githubusercontent.com/Dicklesworthstone/beads_viewer/main/install.sh?$(date +%s)" | bash
๐ก TL;DR
bv is a high-performance Terminal User Interface (TUI) for browsing and managing tasks in projects that use the Beads issue tracking system.
Why you'd care:
- Speed: Browse thousands of issues instantly with zero network latency.
- Focus: Stay in your terminal and use Vim-style keys (
j/k) to navigate. - Intelligence: It visualizes your project as a dependency graph, automatically highlighting bottlenecks, cycles, and critical paths that traditional list-based trackers miss.
- AI-Ready: It provides structured, pre-computed insights for AI coding agents, acting as a "brain" for your project's task management.
๐ The Core Experience
At its heart, bv is about viewing your work nicely.
โก Fast, Fluid Browsing
No web page loads, no heavy clients. bv starts instantly and lets you fly through your issue backlog using standard Vim keys (j/k).
- Split-View Dashboard: On wider screens, see your list on the left and full details on the right.
- Markdown Rendering: Issue descriptions, comments, and notes are beautifully rendered with syntax highlighting, headers, and lists.
- Instant Filtering: Zero-latency filtering. Press
ofor Open,cfor Closed, orrfor Ready (unblocked) tasks. - Live Reload: Watches
.beads/beads.jsonland refreshes lists, details, and insights automatically when the file changesโno restart needed.
๐ Rich Context
Don't just read the title. bv gives you the full picture:
- Comments & History: Scroll through the full conversation history of any task.
- Metadata: Instantly see Assignees, Labels, Priority badges, and creation dates.
- Search: Powerful fuzzy search (
/) finds issues by ID, title, or content instantly.
๐ฏ Focused Workflows
- Kanban Board: Press
bto switch to a columnar view (Open, In Progress, Blocked, Closed) to visualize flow. - Visual Graph: Press
gto explore the dependency tree visually. - Insights: Press
ito see graph metrics and bottlenecks. - Ultra-Wide Mode: On large monitors, the list expands to show extra columns like sparklines and label tags.
๐ ๏ธ Quick Actions
- Export: Press
Eto export all issues to a timestamped Markdown file with Mermaid diagrams. - Graph Snapshot (CLI):
bv --export-graph graph.svg(or.png) writes a static image of the current dependency graph plus a mini summary block (data hash, node/edge counts, top bottleneck). Honors recipes/workspace filters and supports spacing presets via--graph-preset compact|roomy. - Copy: Press
Cto copy the selected issue as formatted Markdown to your clipboard. - Edit: Press
Oto open the.beads/beads.jsonlfile in your preferred GUI editor. - Time-Travel: Press
tto compare against any git revision, orTfor quick HEAD~5 comparison.
๐ Automation Hooks
Configure pre- and post-export hooks in .bv/hooks.yaml to run validations, notifications, or uploads. Defaults: pre-export hooks fail fast on errors (on_error: fail), post-export hooks log and continue (on_error: continue). Empty commands are ignored with a warning for safety. Hook env includes BV_EXPORT_PATH, BV_EXPORT_FORMAT, BV_ISSUE_COUNT, BV_TIMESTAMP, plus any custom env entries.
๐ค Ready-made Blurb to Drop Into Your AGENTS.md or CLAUDE.md Files
### Using bv as an AI sidecar
bv is a fast terminal UI for Beads projects (.beads/beads.jsonl). It renders lists/details and precomputes dependency metrics (PageRank, critical path, cycles, etc.) so you instantly see blockers and execution order. For agents, itโs a graph sidecar: instead of parsing JSONL or risking hallucinated traversal, call the robot flags to get deterministic, dependency-aware outputs.
*IMPORTANT: As an agent, you must ONLY use bv with the robot flags, otherwise you'll get stuck in the interactive TUI that's intended for human usage only!*
- bv --robot-help โ shows all AI-facing commands.
- bv --robot-insights โ JSON graph metrics (PageRank, betweenness, HITS, critical path, cycles) with top-N summaries for quick triage.
- bv --robot-plan โ JSON execution plan: parallel tracks, items per track, and unblocks lists showing what each item frees up.
- bv --robot-priority โ JSON priority recommendations with reasoning and confidence.
- bv --robot-recipes โ list recipes (default, actionable, blocked, etc.); apply via bv --recipe <name> to pre-filter/sort before other flags.
- bv --robot-diff --diff-since <commit|date> โ JSON diff of issue changes, new/closed items, and cycles introduced/resolved.
Use these commands instead of hand-rolling graph logic; bv already computes the hard parts so agents can act safely and quickly.
๐ Architecture & Design
bv treats your project as a Directed Acyclic Graph (DAG), not just a list. This allows it to derive insights about what is truly important.
graph TD
%% Soft Pastel Theme โ Refined
classDef data fill:#e3f2fd,stroke:#90caf9,stroke-width:2px,color:#1565c0,rx:8
classDef logic fill:#fff8e1,stroke:#ffcc80,stroke-width:2px,color:#e65100,rx:8
classDef ui fill:#f3e5f5,stroke:#ce93d8,stroke-width:2px,color:#6a1b9a,rx:8
classDef output fill:#e8f5e9,stroke:#a5d6a7,stroke-width:2px,color:#2e7d32,rx:8
subgraph storage [" ๐ Data Layer "]
A[".beads/beads.jsonl<br/>JSONL Issue Store"]:::data
end
subgraph engine [" โ๏ธ Analysis Engine "]
B["Loader"]:::logic
C["Graph Builder"]:::logic
D["9 Metrics<br/>PageRank ยท Betweenness ยท HITS..."]:::logic
end
subgraph interface [" ๐ฅ๏ธ TUI Layer "]
E["Bubble Tea Model"]:::ui
F["List View"]:::ui
G["Graph View"]:::ui
H["Insights Dashboard"]:::ui
end
subgraph outputs [" ๐ค Outputs "]
I["--robot-insights<br/>JSON for AI Agents"]:::output
J["--export-md<br/>Markdown Report"]:::output
end
A --> B
B --> C
C --> D
D --> E
D --> I
D --> J
E --> F
E --> G
E --> H
linkStyle 0,1,2 stroke:#90caf9,stroke-width:2px
linkStyle 3,4,5 stroke:#ffcc80,stroke-width:2px
linkStyle 6,7,8 stroke:#ce93d8,stroke-width:2px
Key Metrics & Algorithms
bv computes 9 graph-theoretic metrics to surface hidden project dynamics:
| # | Metric | What It Measures | Key Insight |
|---|---|---|---|
| 1 | PageRank | Recursive dependency importance | Foundational blockers |
| 2 | Betweenness | Shortest-path traffic | Bottlenecks & bridges |
| 3 | HITS | Hub/Authority duality | Epics vs. utilities |
| 4 | Critical Path | Longest dependency chain | Keystones with zero slack |
| 5 | Eigenvector | Influence via neighbors | Strategic dependencies |
| 6 | Degree | Direct connection counts | Immediate blockers/blocked |
| 7 | Density | Edge-to-node ratio | Project coupling health |
| 8 | Cycles | Circular dependencies | Structural errors |
| 9 | Topo Sort | Valid execution order | Work queue foundation |
1. PageRank (Dependency Authority)
The Math: Originally designed to rank web pages by "importance" based on incoming links, PageRank models a "random surfer" walking the graph. In our dependency graph (u โ v implies u depends on v), we treat dependencies as "votes" of importance. $$ PR(v) = \frac{1-d}{N} + d \sum_{u \in M(v)} \frac{PR(u)}{L(u)} $$
The Intuition: If many tasks depend on Task A, or if a single very important Task B depends on Task A, then Task A implicitly becomes "heavy." A random walker following dependency links will frequently get stuck at Task A.
Pragmatic Meaning: Foundational Blocks. High PageRank tasks are the bedrock of your project. They are rarely "features" in the user-facing sense; they are often schemas, core libraries, or architectural decisions. Breaking them breaks the graph.
2. Betweenness Centrality (Bottlenecks)
The Math: Defined as the fraction of all shortest paths in the network that pass through a given node
The Intuition: Imagine information (or progress) flowing from every task to every other task along the most efficient route. "Bridge nodes" that connect otherwise isolated clusters (e.g., the Frontend cluster and the Backend cluster) will see a massive amount of traffic.
Pragmatic Meaning: Gatekeepers & Bottlenecks. A task with high Betweenness is a choke point. It might be an API contract that both the mobile app and the server team are waiting on. If this task is delayed, it doesn't just block one thread; it prevents entire sub-teams from synchronizing.
3. HITS (Hubs & Authorities)
The Math: An iterative algorithm that defines two scores for every node:
- Authority: The sum of Hub scores of nodes pointing to it.
- Hub: The sum of Authority scores of nodes it points to.
The Intuition: This models a "mutually reinforcing" relationship. Good libraries (Authorities) are used by many applications. Good applications (Hubs) use many good libraries.
Pragmatic Meaning: Epics vs. Infrastructure.
- High Hub Score: These are your Epics or Product Features. They aggregate many dependencies to deliver value.
- High Authority Score: These are your Utilities. They provide value to many consumers.
4. Critical Path (Longest Path in DAG)
The Math: In a DAG, the longest path represents the minimum time required to complete the project (assuming infinite parallelism). bv computes this recursively:
The Intuition: If you hold the graph by its "leaf" nodes (tasks with no dependencies) and let it dangle, the tasks at the very top that support the longest chains are carrying the most weight.
Pragmatic Meaning: Keystones. A Keystone task is one where any delay translates 1:1 into a delay for the final project delivery. These tasks have zero "slack."
5. Eigenvector Centrality (Influential Neighbors)
The Math: Eigenvector centrality measures a node's influence by considering not just its connections, but the importance of those connections. A node with few but highly influential neighbors can score higher than a node with many unimportant neighbors.
Where
The Intuition: It's not just how many connections you have, but who you're connected to. Being depended on by a critical task makes you more important than being depended on by many trivial tasks.
Pragmatic Meaning: Strategic Dependencies. High Eigenvector tasks are connected to the "power players" in your graph. They may not have many direct dependents, but their dependents are themselves critical.
6. Degree Centrality (Direct Connections)
The Math: The simplest centrality measureโjust count the edges.
The Intuition:
- In-Degree: How many tasks depend on me? (I am a blocker)
- Out-Degree: How many tasks do I depend on? (I am blocked)
Pragmatic Meaning: Immediate Impact.
- High In-Degree: This task is a direct blocker for many others. Completing it immediately unblocks work.
- High Out-Degree: This task has many prerequisites. It's likely to be blocked and should be scheduled later in the execution plan.
7. Graph Density (Interconnectedness)
The Math: Density measures how "connected" the graph is relative to its maximum possible connections.
Where
The Intuition: A density of 0.0 means no dependencies exist (isolated tasks). A density approaching 1.0 means everything depends on everything (pathological complexity).
Pragmatic Meaning: Project Health Indicator.
- Low Density (< 0.05): Healthy. Tasks are relatively independent and can be parallelized.
- Medium Density (0.05 - 0.15): Normal. Reasonable interconnection reflecting real-world dependencies.
- High Density (> 0.15): Warning. Overly coupled project. Consider breaking into smaller modules.
8. Cycle Detection (Circular Dependencies)
The Math: A cycle in a directed graph is a path vโ โ vโ โ โฏ โ vโ โ vโ where the start and end nodes are identical. bv uses Tarjan's algorithm variant via topo.DirectedCyclesIn to enumerate all elementary cycles.
The Intuition: If A depends on B, and B depends on A, neither can ever be completed. This is a logical impossibility that must be resolved.
Pragmatic Meaning: Structural Errors. Cycles are bugs in your project plan, not just warnings. They indicate:
- Misclassified dependencies (A doesn't really block B, or vice versa)
- Missing intermediate tasks (A and B both depend on an unstated C)
- Scope confusion (A and B should be merged into a single task)
9. Topological Sort (Execution Order)
The Math: A topological ordering of a DAG is a linear sequence of all vertices such that for every edge u โ v, vertex u appears before v in the sequence. Only acyclic graphs have valid topological orderings.
The Intuition: If you must complete tasks in dependency order, topological sort gives you a valid order (there may be many).
Pragmatic Meaning: Work Queue. The topological order is the foundation of bv's execution planning. Combined with priority weights, it generates the "what to work on next" recommendations that power --robot-plan.
๐ค The Robot Protocol (AI Interface)
bv bridges the gap between raw data and AI agents. Agents struggle with graph algorithms; bv solves this by acting as a deterministic "sidecar" that offloads the cognitive burden of graph traversal.
sequenceDiagram
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#e8f5e9', 'primaryTextColor': '#2e7d32', 'primaryBorderColor': '#81c784', 'lineColor': '#90a4ae', 'secondaryColor': '#fff8e1', 'tertiaryColor': '#fce4ec'}}}%%
participant User
participant Agent as ๐ค AI Agent
participant BV as โก bv
participant File as ๐ beads.jsonl
User->>Agent: "Fix the next blocked task"
rect rgba(232, 245, 233, 0.4)
Note over Agent, BV: Cognitive Offloading
Agent->>BV: bv --robot-plan
BV->>File: Read & Parse
BV->>BV: PageRank + Topo Sort
BV-->>Agent: { next: "TASK-123", unblocks: 5 }
end
rect rgba(255, 243, 224, 0.3)
Note over Agent: Implementation Phase
Agent->>Agent: Fix TASK-123
Agent->>BV: bv --robot-insights
BV-->>Agent: Updated graph metrics
end
The "Cognitive Offloading" Strategy
The primary design goal of the Robot Protocol is Cognitive Offloading. Large Language Models (LLMs) are probabilistic engines; they are excellent at semantic reasoning (coding, writing) but notoriously unreliable at algorithmic graph traversal (finding cycles, computing shortest paths). The two-phase analyzer returns degree/topo/density immediately and completes PageRank/Betweenness/HITS/Eigenvector/Critical Path/Cycles asynchronously with size-aware timeouts and hashed caching, so repeat robot calls stay fast when the graph hasnโt changed.
If you feed an Agent raw beads.jsonl data, you are forcing the Agent to:
- Parse thousands of lines of JSON.
- Reconstruct the dependency graph in its context window.
- "Hallucinate" a path traversal or cycle check.
bv solves this by providing a deterministic graph engine sidecar.
Why bv vs. Raw Beads?
Using beads directly gives an agent data. Using bv --robot-insights gives an agent intelligence.
| Capability | Raw Beads (JSONL) | bv Robot Mode |
|---|---|---|
| Query | "List all issues." | "List the top 5 bottlenecks blocking the release." |
| Context Cost | High (Linear with issue count). | Low (Fixed summary struct). |
| Graph Logic | Agent must infer/compute. | Pre-computed (PageRank/Brandes). |
| Safety | Agent might miss a cycle. | Cycles explicitly flagged. |
Agent Usage Patterns
Agents typically use bv in three phases:
-
Triage & Orientation: Before starting a session, the agent runs
bv --robot-insights. It receives a lightweight JSON summary of the project's structural health. It immediately knows:- "I should not work on Task C yet because it depends on Task B, which is a Bottleneck."
- "The graph has a cycle (A->B->A); I must fix this structural error before adding new features."
-
Impact Analysis: When asked to "refactor the login module," the agent checks the PageRank and Impact Scores of the relevant beads. If the scores are high, the agent knows this is a high-risk change with many downstream dependents, prompting it to run more comprehensive tests.
-
Execution Planning: Instead of guessing the order of operations, the agent uses
bv's topological sort to generate a strictly linearized plan.
JSON Output Schema (--robot-insights):
The output is designed to be strictly typed and easily parseable by tools like jq or standard JSON libraries.
{
"bottlenecks": [
{ "id": "CORE-123", "value": 0.45 }
],
"keystones": [
{ "id": "API-001", "value": 12.0 }
],
"influencers": [
{ "id": "AUTH-007", "value": 0.82 }
],
"hubs": [
{ "id": "EPIC-100", "value": 0.67 }
],
"authorities": [
{ "id": "UTIL-050", "value": 0.91 }
],
"cycles": [
["TASK-A", "TASK-B", "TASK-A"]
],
"clusterDensity": 0.045,
"stats": {
"pageRank": { "CORE-123": 0.15, "...": "..." },
"betweenness": { "CORE-123": 0.45, "...": "..." },
"eigenvector": { "AUTH-007": 0.82, "...": "..." },
"hubs": { "EPIC-100": 0.67, "...": "..." },
"authorities": { "UTIL-050": 0.91, "...": "..." },
"inDegree": { "CORE-123": 5, "...": "..." },
"outDegree": { "CORE-123": 2, "...": "..." },
"criticalPathScore": { "API-001": 12.0, "...": "..." },
"density": 0.045,
"topologicalOrder": ["CORE-123", "API-001", "..."]
}
}| Field | Metric | What It Contains |
|---|---|---|
bottlenecks |
Betweenness | Top nodes bridging graph clusters |
keystones |
Critical Path | Top nodes on longest dependency chains |
influencers |
Eigenvector | Top nodes connected to important neighbors |
hubs |
HITS Hub | Top dependency aggregators (Epics) |
authorities |
HITS Authority | Top prerequisite providers (Utilities) |
cycles |
Cycle Detection | All circular dependency paths |
clusterDensity |
Density | Overall graph interconnectedness |
stats |
All Metrics | Full raw data for custom analysis |
๐จ TUI Engineering & Craftsmanship
bv is built with the Bubble Tea framework, ensuring a glitch-free, 60fps experience. It features an adaptive layout engine that responds to terminal resize events and a custom ASCII/Unicode graph renderer.
flowchart LR
classDef core fill:#fef3e2,stroke:#f5d0a9,stroke-width:2px,color:#8b5a2b
classDef engine fill:#f0e6f6,stroke:#d4b8e0,stroke-width:2px,color:#5d3a6b
classDef ui fill:#e6f3e6,stroke:#b8d9b8,stroke-width:2px,color:#2d5a2d
classDef output fill:#e8f4f8,stroke:#b8d4e3,stroke-width:2px,color:#2c5f7c
INPUT["โจ๏ธ Input<br/>Keys ยท Mouse ยท Resize"]:::core
MODEL["๐ซ Model<br/>Issues ยท Stats ยท Focus"]:::core
GRAPH["๐งฎ Graph Engine<br/>PageRank ยท HITS ยท Cycles"]:::engine
VIEWS["๐ผ๏ธ Views<br/>List ยท Board ยท Graph ยท Insights"]:::ui
LAYOUT["๐ Layout<br/>Mobile ยท Split ยท Wide"]:::ui
TERM["๐ฅ๏ธ Terminal<br/>60fps Output"]:::output
INPUT -->|tea.Msg| MODEL
GRAPH -->|metrics| MODEL
MODEL -->|state| VIEWS
VIEWS --> LAYOUT
LAYOUT --> TERM
linkStyle 0 stroke:#f5d0a9,stroke-width:2px
linkStyle 1 stroke:#d4b8e0,stroke-width:2px
linkStyle 2 stroke:#b8d9b8,stroke-width:2px
linkStyle 3,4 stroke:#b8d4e3,stroke-width:2px
1. Adaptive Layout Engine
bv doesn't just dump text; it calculates geometry on every render cycle.
- Dynamic Resizing: The
View()function inspects the current terminal width (msg.Width) on every frame. - Breakpoint Logic:
< 100 cols: Mobile Mode. List takes 100% width.> 100 cols: Split Mode. List takes 40%, Details take 60%.> 140 cols: Ultra-Wide. List injects extra columns (Sparklines, Labels) that are normally hidden.
- Padding Awareness: The layout engine explicitly accounts for borders (2 chars) and padding (2 chars) to prevent "off-by-one" wrapping errors that plague many TUIs.
2. Zero-Latency Virtualization
Rendering 10,000 issues would choke a naive terminal app. bv implements Viewport Virtualization:
- Windowing: We only render the slice of rows currently visible in the terminal window.
- Pre-Computation: Graph metrics (PageRank, etc.) are computed once at startup in a separate goroutine, not on every frame.
- Detail Caching: The Markdown renderer is instantiated lazily and reused, avoiding expensive regex recompilation.
3. Visual Graph Engine (pkg/ui/graph.go)
We built a custom 2D ASCII/Unicode rendering engine from scratch to visualize the dependency graph.
- Canvas Abstraction: A 2D grid of
runecells andstylepointers allows us to draw "pixels" in the terminal. - Manhattan Routing: Edges are drawn using orthogonal lines with proper Unicode corner characters (
โญ,โ,โฎ,โ,โฐ,โฏ) to minimize visual noise. - Topological Layering: Nodes are arranged in layers based on their "Impact Depth," ensuring that dependencies always flow downwards.
4. Thematic Consistency
We use Lipgloss to enforce a strict design system.
- Semantic Colors: Colors are defined semantically (
Theme.Blocked,Theme.Open) rather than hardcoded hex values. This allowsbvto switch between "Dracula" (Dark) and "Light" modes seamlessly. - Status Indicators: We use Nerd Font glyphs (
๐,โจ,๐ฅ) paired with color coding to convey status instantly without reading text.
๐ Visual Data Encoding: Sparklines & Heatmaps
In dense information environments like the terminal, text is expensive. bv employs high-density data visualization techniques (pkg/ui/visuals.go) inspired by Edward Tufte to convey complex metrics in minimal space.
1. Unicode Sparklines
When viewing the list in Ultra-Wide mode, bv renders a "Graph Score" column using Unicode block characters ( , โ, โ, โ, โ
, โ, โ, โ).
- The Math:
RenderSparkline(val, width)normalizes a float value (0.0 - 1.0) against the available character width. It calculates the precise block height for each character cell to create a continuous bar chart effect. - The Utility: This allows you to scan a list of 50 issues and instantly spot the "spikes" in complexity or centrality without reading a single number.
2. Semantic Heatmaps
We don't just use random colors. pkg/ui/visuals.go implements a perceptually uniform color ramp (GetHeatmapColor) that maps metric intensity to a gradient:
0.0 - 0.2: Low (Gray/Dim)0.2 - 0.5: Mid (Blue/Cool)0.5 - 0.8: High (Purple/Warm)0.8 - 1.0: Peak (Pink/Hot) This visual encoding is applied to badges in the Insights Dashboard, allowing you to differentiate between "somewhat important" and "critically urgent" tasks at a glance.
๐ Search Architecture
In a project with thousands of issues, you cannot afford to wait for a backend query. bv implements a composite, in-memory fuzzy search that feels instantaneous.
The "Flattened Vector" Index
Instead of searching fields individually (which requires complex UI controls), bv flattens every issue into a single searchable "vector" at load time.
The FilterValue() method constructs a composite string containing:
- Core Identity: ID (
"CORE-123") and Title ("Fix login race condition") - Metadata: Status (
"open"), Type ("bug"), Priority - Context: Assignee (
"@steve") and Labels ("frontend, v1.0")
Fuzzy Subsequence Matching
When you press /, the search engine performs a fuzzy subsequence match against this composite vector.
- Example: Typing
"log fix"successfully matches"Fix login race condition". - Example: Typing
"steve bug"finds bugs assigned to Steve. - Example: Typing
"open v1.0"filters for open items in the v1.0 release.
Performance Characteristics
- Zero Allocation: The search index is built once during the initial load (
loader.LoadIssues). - Client-Side Filtering: Filtering happens entirely within the render loop. There is no database latency, no network round-trip, and no "loading" spinner.
- Stable Sort: Search results maintain the topological and priority sorting of the main list, ensuring that even filtered views reflect the project's true priorities.
๐ง Mermaid Integration: Diagrams in the Terminal?
A common question is: "How do you render complex diagrams in a text-only terminal?"
bv approaches this problem in two ways:
1. The Native Graph Visualizer (g)
For the interactive TUI, we built a specialized ASCII/Unicode Graph Engine (pkg/ui/graph.go) that replicates the core value of a Mermaid flowchart without requiring graphical protocol support (like Sixel).
- Topological Layering: Nodes are automatically sorted by their dependency depth.
- Orthogonal Routing: Connections use box-drawing characters (
โ,โ,โญ,โฏ) to draw clean, right-angled paths that avoid crossing through node text. - Adaptive Canvas: The virtual canvas expands infinitely, but the viewport (
pkg/ui/viewport.go) clips rendering to exactly what fits on your screen, panning smoothly withh/j/k/l.
2. The Export Engine (--export-md)
For external reporting, bv includes a robust Mermaid Generator (pkg/export/markdown.go).
- Sanitization: It automatically escapes unsafe characters in issue titles to prevent syntax errors in the Mermaid parser.
- Collision-Proof IDs: When sanitization would collide (e.g., symbol-only IDs), nodes get a stable hash suffix so edges never merge or disappear.
- Class-Based Styling: Nodes are assigned CSS classes (
classDef open,classDef blocked) based on their status, so the resulting diagram visually matches the TUI's color scheme when rendered on GitHub or GitLab. - Semantic Edges: Blockers are rendered with thick arrows (
==>), while loose relations use dashed lines (-.->), encoding the severity of the link into the visual syntax.
graph TD
%% Generated by bv โ Soft Pastel Theme
classDef open fill:#c8e6c9,stroke:#81c784,stroke-width:2px,color:#2e7d32
classDef blocked fill:#ffcdd2,stroke:#e57373,stroke-width:2px,color:#c62828
classDef inProgress fill:#fff3e0,stroke:#ffb74d,stroke-width:2px,color:#ef6c00
A["CORE-123<br/>Refactor Login"]:::open
B["UI-456<br/>Login Page"]:::blocked
C["API-789<br/>Auth Endpoint"]:::inProgress
A --> B
A --> C
C -.-> B
linkStyle 0 stroke:#81c784,stroke-width:2px
linkStyle 1 stroke:#81c784,stroke-width:2px
linkStyle 2 stroke:#e57373,stroke-width:1px,stroke-dasharray:5
๐ธ Graph Snapshot Export (PNG/SVG)
Need a quick, shareable picture of the dependency graph for another agent or a status deck? Run:
bv --export-graph out/graph.svg # format inferred from extension
bv --export-graph out/graph.png --graph-preset roomyFeatures:
- Self-contained summary block: embeds
data_hash, node/edge counts, and the top bottleneck so artifacts can be correlated with robot outputs. - Recipe-aware: applies the same filters you passed via
--recipe/--workspace, keeping exports scoped. - Legend + colors: status-colored nodes (open/in-progress/blocked/closed) and a concise legend so agents understand the encoding without rereading this README.
- Deterministic layout: stable ordering by critical-path level then PageRank, so two exports for the same data hash look identical.
๐ The Status Report Engine
bv isn't just for personal browsing; it's a communication tool. The --export-md flag generates a Management-Ready Status Report that converts your repo state into a polished document suitable for stakeholders.
1. The "Hybrid Document" Architecture
The exporter (pkg/export/markdown.go) constructs a document that bridges human readability and visual data:
- Summary at a Glance: Top-level statistics (Total, Open, Blocked, Closed) give immediate health context.
- Embedded Graph: It injects the full dependency graph as a Mermaid diagram right into the document. On platforms like GitHub or GitLab, this renders as an interactive chart.
- Anchor Navigation: A generated Table of Contents uses URL-friendly slugs (
#core-123-refactor-login) to link directly to specific issue details, allowing readers to jump between the high-level graph and low-level specs.
2. Semantic Formatting
We don't just dump JSON values. The exporter applies specific formatting rules to ensure the report looks professional:
- Metadata Tables: Key fields (Assignee, Priority, Status) are aligned in GFM (GitHub Flavored Markdown) tables with emoji indicators.
- Conversation threading: Comments are rendered as blockquotes (
>) with relative timestamps, preserving the flow of discussion distinct from the technical spec. - Intelligent Sorting: The report doesn't list issues ID-sequentially. It applies the same priority logic as the TUI: Open Critical issues appear first, ensuring the reader focuses on what matters now.
โณ Time-Travel: Snapshot Diffing & Git History
One of bv's most powerful capabilities is Time-Travelโthe ability to compare your project's state across any two points in git history. This transforms bv from a "viewer" into a progress tracking and regression detection system.
The Snapshot Model
bv captures the complete state of your project at any moment:
graph LR
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#e8f5e9', 'primaryTextColor': '#2e7d32', 'primaryBorderColor': '#81c784', 'lineColor': '#90a4ae'}}}%%
subgraph "Git History"
A["HEAD~10<br/><small>10 commits ago</small>"]
B["HEAD~5<br/><small>5 commits ago</small>"]
C["HEAD<br/><small>Current</small>"]
end
subgraph "Snapshots"
D["Snapshot A<br/><small>45 issues, 3 cycles</small>"]
E["Snapshot B<br/><small>52 issues, 1 cycle</small>"]
F["Snapshot C<br/><small>58 issues, 0 cycles</small>"]
end
A --> D
B --> E
C --> F
D -.->|"diff"| E
E -.->|"diff"| F
style D fill:#ffcdd2,stroke:#e57373,stroke-width:2px
style E fill:#fff3e0,stroke:#ffb74d,stroke-width:2px
style F fill:#c8e6c9,stroke:#81c784,stroke-width:2px
What Gets Tracked
The SnapshotDiff captures every meaningful change:
| Category | Tracked Changes |
|---|---|
| Issues | New, Closed, Reopened, Removed, Modified |
| Fields | Title, Status, Priority, Tags, Dependencies |
| Graph | New Cycles, Resolved Cycles |
| Metrics | ฮ PageRank, ฮ Betweenness, ฮ Density |
Git History Integration (pkg/loader/git.go)
The GitLoader enables loading issues from any git revision:
loader := NewGitLoader("/path/to/repo") // Load from various references current, _ := loader.LoadAt("HEAD") lastWeek, _ := loader.LoadAt("HEAD~7") release, _ := loader.LoadAt("v1.0.0") byDate, _ := loader.LoadAt("main@{2024-01-15}")
Cache Architecture:
- Revisions are resolved to commit SHAs for stable caching
- Thread-safe
sync.RWMutexprotects concurrent access - 5-minute TTL prevents stale data while avoiding redundant git calls
Use Cases
- Sprint Retrospectives: "How many issues did we close this sprint?"
- Regression Detection: "Did we accidentally reintroduce a dependency cycle?"
- Trend Analysis: "Is our graph density increasing? Are we creating too many dependencies?"
- Release Notes: "Generate a diff of all changes between v1.0 and v2.0"
๐ณ Recipe System: Declarative View Configuration
Instead of memorizing CLI flags or repeatedly setting filters, bv supports RecipesโYAML-based view configurations that can be saved, shared, and version-controlled.
Recipe Structure
# .beads/recipes/sprint-review.yaml name: sprint-review description: "Issues touched in the current sprint" filters: status: [open, in_progress, closed] updated_after: "14d" # Relative time: 14 days ago exclude_tags: [backlog, icebox] sort: field: updated direction: desc secondary: field: priority direction: asc view: columns: [id, title, status, priority, updated] show_metrics: true max_items: 50 export: format: markdown include_graph: true
Filter Capabilities
| Filter | Type | Examples |
|---|---|---|
status |
Array | [open, closed, blocked, in_progress] |
priority |
Array | [0, 1] (P0 and P1 only) |
tags |
Array | [frontend, urgent] |
exclude_tags |
Array | [wontfix, duplicate] |
created_after |
Relative/ISO | "7d", "2w", "2024-01-01" |
updated_before |
Relative/ISO | "30d", "1m" |
actionable |
Boolean | true = no open blockers |
has_blockers |
Boolean | true = waiting on dependencies |
id_prefix |
String | "bv-" for project filtering |
title_contains |
String | Substring search |
Built-in Recipes
bv ships with 6 pre-configured recipes:
| Recipe | Purpose |
|---|---|
default |
All open issues sorted by priority |
actionable |
Ready to work (no blockers) |
recent |
Updated in last 7 days |
blocked |
Waiting on dependencies |
high-impact |
Top PageRank scores |
stale |
Open but untouched for 30+ days |
Using Recipes
# Interactive picker (press 'R' in TUI) bv # Direct recipe invocation bv --recipe actionable bv --recipe high-impact # Custom recipe file bv --recipe .beads/recipes/sprint-review.yaml
๐ฏ Composite Impact Scoring
Traditional issue trackers sort by a single dimensionโusually priority. bv computes a multi-factor Impact Score that blends graph-theoretic metrics with temporal and priority signals.
The Scoring Formula
Component Breakdown
| Component | Weight | What It Measures |
|---|---|---|
| PageRank | 30% | Recursive dependency importance |
| Betweenness | 30% | Bottleneck/bridge position |
| BlockerRatio | 20% | Direct dependents (In-Degree) |
| Staleness | 10% | Days since last update (aging) |
| PriorityBoost | 10% | Human-assigned priority |
Why These Weights?
- 60% Graph Metrics: The structure of dependencies is the primary driver of true importance.
- 20% Blocker Ratio: Direct dependents matter for immediate unblocking.
- 10% Staleness: Old issues deserve attention; they may be forgotten blockers.
- 10% Priority: Human judgment is valuable but can be outdated or politically biased.
Score Output
{
"issue_id": "CORE-123",
"title": "Refactor auth module",
"score": 0.847,
"breakdown": {
"pagerank": 0.27,
"betweenness": 0.25,
"blocker_ratio": 0.18,
"staleness": 0.07,
"priority_boost": 0.08
}
}Priority Recommendations
bv generates actionable recommendations when the computed impact score diverges significantly from the human-assigned priority:
โ ๏ธ CORE-123 has Impact Score 0.85 but Priority P3. Reason: High PageRank (foundational dependency) + High Betweenness (bottleneck) Recommendation: Consider escalating to P1.
Priority Hints Overlay
Press p in the list view to toggle Priority Hintsโinline visual indicators showing which issues have misaligned priorities:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ OPEN CORE-123 โฌ Database schema migration P3 ๐ข โ
โ OPEN UI-456 Login page styling P2 ๐ข โ
โ BLOCKED API-789 โฌ Legacy endpoint wrapper P1 ๐ด โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โฌ = Impact suggests higher priority (red arrow)
โฌ = Impact suggests lower priority (teal arrow)
This provides at-a-glance feedback on whether your priority assignments match the computed graph importance.
๐ค๏ธ Parallel Execution Planning
When you ask "What should I work on next?", bv doesn't just pick the highest-priority item. It generates a complete execution plan that respects dependencies and identifies opportunities for parallel work.
Track-Based Planning
The planner uses Union-Find to identify connected components in the dependency graph, grouping related issues into independent "tracks" that can be worked on concurrently.
graph TD
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#e8f5e9', 'lineColor': '#90a4ae'}}}%%
subgraph track_a ["๐
ฐ๏ธ Track A: Auth System"]
A1["AUTH-001<br/>P1 ยท Unblocks 3"]:::actionable
A2["AUTH-002"]:::blocked
A3["AUTH-003"]:::blocked
end
subgraph track_b ["๐
ฑ๏ธ Track B: UI Polish"]
B1["UI-101<br/>P2 ยท Unblocks 1"]:::actionable
B2["UI-102"]:::blocked
end
subgraph track_c ["๐
ฒ Track C: Independent"]
C1["DOCS-001<br/>P3 ยท Unblocks 0"]:::actionable
end
A1 --> A2
A2 --> A3
B1 --> B2
classDef actionable fill:#c8e6c9,stroke:#81c784,stroke-width:2px,color:#2e7d32
classDef blocked fill:#ffcdd2,stroke:#e57373,stroke-width:2px,color:#c62828
linkStyle 0,1,2 stroke:#81c784,stroke-width:2px
Plan Output (--robot-plan)
{
"tracks": [
{
"track_id": "track-A",
"reason": "Independent work stream",
"items": [
{ "id": "AUTH-001", "priority": 1, "unblocks": ["AUTH-002", "AUTH-003", "API-005"] }
]
},
{
"track_id": "track-B",
"reason": "Independent work stream",
"items": [
{ "id": "UI-101", "priority": 2, "unblocks": ["UI-102"] }
]
}
],
"total_actionable": 3,
"total_blocked": 5,
"summary": {
"highest_impact": "AUTH-001",
"impact_reason": "Unblocks 3 tasks",
"unblocks_count": 3
}
}The Algorithm
- Identify Actionable Issues: Filter to non-closed issues with no open blockers.
- Compute Unblocks: For each actionable issue, calculate what becomes unblocked if it's completed.
- Find Connected Components: Use Union-Find to group issues by their dependency relationships.
- Build Tracks: Create parallel tracks from each component, sorted by priority within each track.
- Compute Summary: Identify the single highest-impact issue (most downstream unblocks).
Benefits for AI Agents
- Deterministic: Same input always produces same plan (no LLM hallucination).
- Parallelism-Aware: Multiple agents can grab different tracks without conflicts.
- Impact-Ranked: The
highest_impactfield tells agents exactly where to start.
๐ฌ Insights Dashboard: Interactive Graph Analysis
The Insights Dashboard (i) transforms abstract graph metrics into an interactive exploration interface. Instead of just showing numbers, it lets you drill into why a bead scores high and what that means for your project.
The 6-Panel Layout
โโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโ
โ ๐ง Bottlenecks โ ๐๏ธ Keystones โ ๐ Influencers โ
โ Betweenness โ Impact Depth โ Eigenvector โ
โ โโโโโโโโโโโโโโโโโ โ โโโโโโโโโโโโโโโโโ โ โโโโโโโโโโโโโโโโโ โ
โ โธ 0.45 AUTH-001 โ 12.0 CORE-123 โ 0.82 API-007 โ
โ 0.38 API-005 โ 10.0 DB-001 โ 0.71 AUTH-001 โ
โโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโ
โโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโ
โ ๐ฐ๏ธ Hubs โ ๐ Authorities โ ๐ Cycles โ
โ HITS Hub Score โ HITS Auth Score โ Circular Deps โ
โ โโโโโโโโโโโโโโโโโ โ โโโโโโโโโโโโโโโโโ โ โโโโโโโโโโโโโโโโโ โ
โ 0.67 EPIC-100 โ 0.91 UTIL-050 โ โ A โ B โ C โ A โ
โ 0.54 FEAT-200 โ 0.78 LIB-010 โ โ X โ Y โ X โ
โโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโ
Panel Descriptions
| Panel | Metric | What It Shows | Actionable Insight |
|---|---|---|---|
| ๐ง Bottlenecks | Betweenness | Beads on many shortest paths | Prioritize to unblock parallel work |
| ๐๏ธ Keystones | Impact Depth | Deep in dependency chains | Complete firstโdelays cascade |
| ๐ Influencers | Eigenvector | Connected to important beads | Review carefully before changes |
| ๐ฐ๏ธ Hubs | HITS Hub | Aggregate many dependencies | Track for milestone completion |
| ๐ Authorities | HITS Authority | Depended on by many hubs | Stabilize earlyโbreaking ripples |
| ๐ Cycles | Tarjan SCC | Circular dependency loops | Must resolveโlogical impossibility |
The Detail Panel: Calculation Proofs
When you select a bead, the right-side Detail Panel shows not just the score, but the proofโthe actual beads and values that contributed:
โโโ CALCULATION PROOF โโโ
BW(v) = ฮฃ (ฯst(v) / ฯst) for all sโ vโ t
Betweenness Score: 0.452
Beads depending on this (5):
โ UI-Login: Implement login form
โ UI-Dashboard: User dashboard
โ API-Auth: Authentication endpoint
... +2 more
This depends on (2):
โ DB-Schema: User table migration
โ CORE-Config: Environment setup
This bead lies on many shortest paths between
other beads, making it a critical junction.
Dashboard Navigation
| Key | Action |
|---|---|
Tab / Shift+Tab |
Move between panels |
j / k |
Navigate within panel |
Enter |
Focus selected bead in main view |
e |
Toggle explanations |
i |
Exit dashboard |
๐ Kanban Board: Visual Workflow State
The Kanban Board (b) provides a columnar workflow view that adapts to your project's actual stateโempty columns automatically collapse to maximize screen real estate.
Adaptive Column Layout
+------------------+------------------+------------------+------------------+
| OPEN (12) | IN PROGRESS (5) | BLOCKED (3) | CLOSED (45) |
+------------------+------------------+------------------+------------------+
| +------------+ | +------------+ | +------------+ | +------------+ |
| | BUG-123 | | | FEAT-456 | | | CRIT-789 | | | BUG-001 | |
| | P0 Critical| | | P1 High | | | P0 Critical| | | Completed | |
| | Fix crash | | | Add OAuth | | | Waiting on | | | Login fix | |
| | @alice | | | @bob v2 | | | 3 blockers | | | 3 days ago | |
| +------------+ | +------------+ | +------------+ | +------------+ |
| +------------+ | +------------+ | +------------+ | |
| | FEAT-124 | | | BUG-457 | | | FEAT-790 | | [ 1/45 ] |
| | ... | | | ... | | | ... | | |
+------------------+------------------+------------------+------------------+
Card Anatomy
Each card displays rich metadata at a glance:
| Element | Meaning |
|---|---|
| Type Icon | ๐ Bug, โจ Feature, ๐ฅ Critical, ๐ Task |
| ID Badge | Issue identifier (e.g., BUG-123) |
| Priority Flames | ๐ฅ๐ฅ๐ฅ P0, ๐ฅ๐ฅ P1, ๐ฅ P2, (none) P3+ |
| Title | Truncated to fit card width |
| Metadata Row | ๐ค Assignee, ๐ Dependency count, ๐ท๏ธ Labels |
| Age | Relative time since last update |
Board Features
- Adaptive Columns: Empty columns collapse automatically
- Priority Sorting: Cards sorted by priority (P0 first), then creation date
- Scroll Indicators:
โ 3/12shows position in long columns - Status Colors: Column headers color-coded by status
- Keyboard Navigation: Full vim-style movement
Board Navigation
| Key | Action |
|---|---|
h / l |
Move between columns |
j / k |
Move within column |
g / G |
Jump to top/bottom of column |
Ctrl+D / Ctrl+U |
Page down/up |
Enter |
Focus selected bead |
b |
Exit board view |
๐ค Complete CLI Reference
Beyond the interactive TUI, bv provides a comprehensive command-line interface for scripting, automation, and AI agent integration.
Core Commands
bv # Launch interactive TUI bv --help # Show all options bv --version # Show version
Robot Protocol Commands
These commands output structured JSON designed for programmatic consumption:
| Command | Output | Use Case |
|---|---|---|
--robot-insights |
Graph metrics + top N lists | Project health assessment |
--robot-plan |
Actionable tracks + dependencies | Work queue generation |
--robot-priority |
Priority recommendations | Automated triage |
--robot-diff |
JSON diff (with --diff-since) |
Change tracking |
--robot-recipes |
Available recipe list | Recipe discovery |
--robot-help |
Detailed AI agent documentation | Agent onboarding |
Time-Travel Commands
# View historical state bv --as-of HEAD~10 # 10 commits ago bv --as-of v1.0.0 # At release tag bv --as-of 2024-01-15 # At specific date bv --as-of main@{2024-01-15} # Branch at date # Compare changes bv --diff-since HEAD~5 # Changes in last 5 commits bv --diff-since v1.0.0 # Changes since release bv --diff-since 2024-01-01 # Changes since date # JSON diff output bv --diff-since HEAD~5 --robot-diff
Recipe Commands
# List available recipes bv --robot-recipes # Apply built-in recipes bv --recipe actionable # Ready to work bv --recipe high-impact # Top PageRank scores bv --recipe stale # Untouched 30+ days bv --recipe blocked # Waiting on dependencies bv -r recent # Short flag, updated in 7 days # Apply custom recipe bv --recipe .beads/recipes/sprint.yaml
Export Commands
# Generate Markdown report with Mermaid diagrams
bv --export-md report.mdExample: AI Agent Workflow
#!/bin/bash # agent-workflow.sh - Autonomous task selection # 1. Get the execution plan PLAN=$(bv --robot-plan) # 2. Extract highest-impact actionable task TASK=$(echo "$PLAN" | jq -r '.plan.summary.highest_impact') # 3. Get full insights for context INSIGHTS=$(bv --robot-insights) # 4. Check if completing this introduces regressions BASELINE=$(bv --diff-since HEAD~1 --robot-diff) echo "Working on: $TASK" echo "Unblocks: $(echo "$PLAN" | jq '.plan.summary.unblocks_count') tasks"
Output Examples
--robot-priority Output:
{
"generated_at": "2025-01-15T10:30:00Z",
"recommendations": [
{
"issue_id": "CORE-123",
"current_priority": 3,
"suggested_priority": 1,
"confidence": 0.87,
"direction": "increase",
"reasoning": "High PageRank (0.15) + High Betweenness (0.45) indicates foundational blocker"
}
],
"summary": {
"total_issues": 58,
"recommendations": 12,
"high_confidence": 5
}
}--robot-recipes Output:
{
"recipes": [
{ "name": "actionable", "description": "Ready to work (no blockers)", "source": "builtin" },
{ "name": "high-impact", "description": "Top PageRank scores", "source": "builtin" },
{ "name": "sprint-review", "description": "Current sprint issues", "source": "project" }
]
}๐ข Multi-Repository Workspace Support
For monorepo and multi-package architectures, bv provides workspace configuration that unifies issues across multiple repositories into a single coherent view.
Workspace Configuration (.bv/workspace.yaml)
# .bv/workspace.yaml - Multi-repo workspace definition name: my-workspace repos: - name: api path: services/api prefix: "api-" # Issues become api-AUTH-123 beads_path: .beads # Optional per-repo override (defaults to .beads) - name: web path: apps/web prefix: "web-" # Issues become web-UI-456 - name: shared path: packages/shared prefix: "lib-" # Issues become lib-UTIL-789 discovery: enabled: true patterns: - "*" # Direct children - "packages/*" # npm/pnpm workspaces - "apps/*" # Next.js/Turborepo - "services/*" # Microservices - "libs/*" # Library packages exclude: - node_modules - vendor - .git max_depth: 2 defaults: beads_path: .beads # Where to find beads.jsonl in each repo
ID Namespacing
When working across repositories, issues are automatically namespaced:
| Local ID | Repo Prefix | Namespaced ID |
|---|---|---|
AUTH-123 |
api- |
api-AUTH-123 |
UI-456 |
web- |
web-UI-456 |
UTIL-789 |
lib- |
lib-UTIL-789 |
Cross-Repository Dependencies
The workspace system enables cross-repo blocking relationships:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ web-UI-456 (apps/web) โ
โ "Implement OAuth login page" โ
โ โ
โ blocks: api-AUTH-123, lib-UTIL-789 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ โ
โผ โผ
โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ
โ api-AUTH-123 โ โ lib-UTIL-789 โ
โ (services/api) โ โ (packages/lib) โ
โ "Auth endpoint" โ โ "Token utils" โ
โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ
Filtering Within a Workspace
Use --repo to scope the view (and robot outputs) to a specific repository prefix. Matching is case-insensitive and accepts common separators (-, :, _); it also honors the source_repo field when present.
Supported Monorepo Layouts
| Layout | Pattern | Example Projects |
|---|---|---|
| npm/pnpm workspaces | packages/* |
Lerna, Turborepo |
| Next.js apps | apps/* |
Vercel monorepos |
| Microservices | services/* |
Backend platforms |
| Go modules | modules/* |
Multi-module Go |
| Flat | * |
Simple monorepos |
ID Resolution
The IDResolver handles cross-repo references intelligently:
resolver := NewIDResolver(config, "api") // From api repo context: resolver.Resolve("AUTH-123") // โ {Namespace: "api-", LocalID: "AUTH-123"} resolver.Resolve("web-UI-456") // โ {Namespace: "web-", LocalID: "UI-456"} resolver.IsCrossRepo("web-UI-456") // โ true resolver.DisplayID("api-AUTH-123") // โ "AUTH-123" (local, strip prefix) resolver.DisplayID("web-UI-456") // โ "web-UI-456" (cross-repo, keep prefix)
โฐ Interactive Time-Travel Mode
Beyond CLI diff commands, bv supports interactive time-travel within the TUI itself. This mode overlays diff badges on your issue list, letting you visually explore what changed.
Activating Time-Travel Mode
Press t in the main list view to enter time-travel mode with a custom revision prompt:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ โฑ๏ธ Time-Travel Mode โ
โ โ
โ Compare current state with a โ
โ historical revision โ
โ โ
โ โฑ๏ธ Revision: HEAD~5โ โ
โ โ
โ Examples: HEAD~5, main, v1.0.0, โ
โ 2024-01-01, abc123 โ
โ โ
โ Press Enter to compare, Esc to cancel โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
For quick access, press T (uppercase) to instantly compare against HEAD~5 without the prompt.
Diff Badges
Once activated, issues display visual badges indicating their diff status:
| Badge | Meaning | Color |
|---|---|---|
[NEW] |
Issue created since baseline | Green |
[CLOSED] |
Issue closed since baseline | Gray |
[MODIFIED] |
Issue fields changed | Yellow |
[REOPENED] |
Issue reopened since baseline | Orange |
Visual Example
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ ๐ ISSUES (since HEAD~5) 58 total โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ [NEW] โจ FEAT-789 Add dark mode toggle P2 ๐ข โ
โ [NEW] ๐ BUG-456 Fix login race condition P1 ๐ข โ
โ [MODIFIED] ๐ TASK-123 Update documentation P3 ๐ก โ
โ โจ FEAT-100 OAuth integration P1 ๐ข โ
โ [CLOSED] ๐ BUG-001 Memory leak in parser P0 โซ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Time-Travel Summary Panel
The footer shows aggregate statistics:
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ Changes: +3 new โ2 closed ~1 modified โบ0 reopened
Health: โ improving (density: -0.02, cycles: -1)
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Time-Travel Navigation
| Key | Action |
|---|---|
t |
Enter time-travel (custom revision prompt) |
T |
Quick time-travel (HEAD~5) |
t (while in time-travel) |
Exit time-travel mode |
n |
Jump to next changed issue |
N |
Jump to previous changed issue |
๐งช Quality Assurance & Robustness
Trust is earned. bv employs a rigorous testing strategy to ensure it can handle the messy reality of real-world repositories.
1. Synthetic Data Fuzzing
We don't just test on "happy path" data. The test suite (pkg/loader/synthetic_test.go) generates Synthetic Complex Graphsโlarge JSONL files with thousands of nodes, intricate dependency cycles, and edge-case UTF-8 charactersโto verify that the graph engine and rendering logic never panic under load.
2. Robustness Against Corruption
In a git-based workflow, merge conflicts and partial writes happen. The TestLoadIssuesRobustness suite explicitly injects garbage lines and corrupted JSON into the data stream.
- Result:
bvdetects corruption, logs a warning tostderr, and continues loading the valid data. It never crashes the user session due to a single bad line.
๐ The Zero-Friction Update Engine
bv includes a proactive, non-intrusive update check to ensure you never miss a feature. We believe tools should maintain themselves without interrupting your flow.
Design & Implementation
The updater (pkg/updater/updater.go) is architected for silence and safety:
- Non-Blocking Concurrency: The check runs in a detached goroutine with a strict 2-second timeout. It never delays your startup time or UI interactivity.
- Semantic Versioning: It doesn't just match strings. A custom SemVer comparator ensures you are only notified about strictly newer releases, handling complex edge cases like release candidates vs. stable builds.
- Resilience: It gracefully handles network partitions, GitHub API rate limits (403/429), and timeouts by silently failing. You will never see a crash or error log due to an update check.
- Unobtrusive Notification: When an update is found,
bvdoesn't pop a modal. It simply renders a subtle Update Available indicator (โญ) in the footer, letting you choose when to upgrade.
๐๏ธ Data Loading & Self-Healing
Reliability is key. bv doesn't assume a perfect environment; it actively handles common file system inconsistencies.
1. Intelligent Path Discovery
The loader (pkg/loader/loader.go) doesn't just blindly open .beads/beads.jsonl. It employs a priority-based discovery algorithm:
- Canonical: Checks for
beads.jsonl. - Legacy: Fallback to
issues.jsonlfor older repos. - Base: Checks
beads.base.jsonl(used bybdin daemon mode). - Validation: It skips temporary files like
*.backupordeletions.jsonlto prevent displaying corrupted state.
2. Robust Parsing
The JSONL parser is designed to be Lossy-Tolerant.
- It uses a buffered scanner (
bufio.NewScanner) with a generous 10MB line limit to handle massive description blobs. - Malformed lines (e.g., from a merge conflict) are skipped with a warning rather than crashing the application, ensuring you can still view the readable parts of your project even during a bad git merge.
๐งฉ Design Philosophy: Why Graphs?
Traditional issue trackers (Jira, GitHub Issues, Trello) model work as Buckets: "To Do", "In Progress", "Done". This is fine for simple task lists, but it fails at scale because it ignores Structure.
In complex software projects, tasks are not isolated. They are deeply interconnected. A "simple" frontend task might depend on a backend endpoint, which depends on a schema change, which depends on a migration script.
bv adopts a Graph-First philosophy:
- Structure is Reality: The dependency graph is the project. The list view is just a projection of that graph.
- Explicit Blocking: We don't just "relate" tasks; we define strict "blocks". If A blocks B, you literally cannot mark B as "Ready" in
bvuntil A is Closed. - Local-First, Text-Based: Your project data lives in your repo (
.beads/beads.jsonl), not on a remote server. It travels with your code, branches with your git, and merges with your PRs.
โก Performance Specs
bv is engineered for speed. We believe that latency is the enemy of flow.
- Startup Time: < 50ms for typical repos (< 1000 issues).
- Rendering: 60 FPS UI updates using Bubble Tea.
- Virtualization: List views and Markdown renderers are fully windowed.
bvcan handle repositories with 10,000+ issues without UI lag, consuming minimal RAM. - Graph Compute: A two-phase analyzer computes topo/degree/density instantly, then PageRank/Betweenness/HITS/Critical Path/Cycles asynchronously with size-aware timeouts.
- Caching: Repeated analyses reuse hashed results automatically, avoiding recomputation when the bead graph hasnโt changed.
Performance Benchmarking
bv includes a comprehensive benchmark suite for performance validation:
# Run all benchmarks ./scripts/benchmark.sh # Save current performance as baseline ./scripts/benchmark.sh baseline # Compare against baseline (requires benchstat) ./scripts/benchmark.sh compare # Quick benchmarks (CI mode) ./scripts/benchmark.sh quick
Benchmark Categories:
- Full Analysis: End-to-end
Analyze()pipeline at various scales - Individual Algorithms: PageRank, Betweenness, HITS, TopoSort isolation
- Pathological Graphs: Stress tests for timeout protection (many cycles, complete graphs)
- Timeout Verification: Ensures large graphs don't hang
Timeout Protection: All expensive algorithms (Betweenness, PageRank, HITS, Cycle detection) have 500ms timeouts to prevent blocking on large or pathological graphs.
Detailed Tuning Guide: For comprehensive performance documentation including troubleshooting, size-based algorithm selection, and tuning options, see docs/performance.md.
โ Troubleshooting & FAQ
Q: My icons look weird / text is misaligned.
bvrequires a terminal with TrueColor support and a Nerd Font installed.- Recommended: Nerd Fonts (e.g., "JetBrains Mono Nerd Font" or "Hack Nerd Font").
- Terminals: Windows Terminal, iTerm2, Alacritty, Kitty, WezTerm.
Q: I see "Cycles Detected" in the dashboard. What now?
A: A cycle (e.g., A โ B โ A) means your project logic is broken; no task can be finished first. Use the Insights Dashboard (i) to find the specific cycle members, then use bd to remove one of the dependency links (e.g., bd unblock A --from B).
Q: Does this work with Jira/GitHub?
A: bv is data-agnostic. The Beads data schema supports an external_ref field. If you populate your .beads/beads.jsonl file with issues from external trackers (e.g., using a custom script or sync tool), bv will render them alongside your local tasks. Future versions of the bd CLI may support native syncing, but bv is ready for that data today.
๐ฆ Installation
One-Line Install
The fastest way to get started. Detects your OS and architecture automatically.
curl -fsSL "https://raw.githubusercontent.com/Dicklesworthstone/beads_viewer/main/install.sh?$(date +%s)" | bash
Build from Source
Requires Go 1.21+.
git clone https://github.com/Dicklesworthstone/beads_viewer.git
cd beads_viewer
go install ./cmd/bv๐ Usage Guide
Navigate to any project initialized with bd init and run:
Keyboard Control Map
| Context | Key | Action |
|---|---|---|
| Global Navigation | j / k |
Next / Previous Item |
g / G |
Jump to Top / Bottom | |
Ctrl+D / Ctrl+U |
Page Down / Up | |
Tab |
Switch Focus (List โ Details) | |
Enter |
Open / Focus Selection | |
q / Esc |
Quit / Back | |
| Filters | o |
Show Open Issues |
r |
Show Ready (Unblocked) | |
c |
Show Closed Issues | |
/ |
Search (Fuzzy) | |
| Views | b |
Toggle Kanban Board |
i |
Toggle Insights Dashboard | |
g |
Toggle Graph Visualizer | |
a |
Toggle Actionable Plan | |
| Kanban Board | h / l |
Move Between Columns |
j / k |
Move Within Column | |
| Insights Dashboard | Tab |
Next Panel |
Shift+Tab |
Previous Panel | |
e |
Toggle Explanations | |
x |
Toggle Calculation Proof | |
| Graph View | H / L |
Scroll Left / Right |
Ctrl+D / Ctrl+U |
Page Down / Up | |
| Time-Travel & Analysis | t |
Time-Travel Mode (custom revision) |
T |
Quick Time-Travel (HEAD~5) | |
p |
Toggle Priority Hints Overlay | |
| Actions | E |
Export to Markdown File |
C |
Copy Issue to Clipboard | |
O |
Open in Editor | |
| Global | ? |
Toggle Help Overlay |
R |
Recipe Picker |
๐ ๏ธ Configuration
bv automatically detects your terminal capabilities to render the best possible UI. It looks for .beads/beads.jsonl in your current directory.
Visual Theme
The UI uses a visually distinct, high-contrast theme inspired by Dracula Principles to ensure readability.
- Primary:
#BD93F9(Purple) - Status Open:
#50FA7B(Green) - Status Blocked:
#FF5555(Red)
๐ License
MIT License
Copyright (c) 2025 Jeffrey Emanuel
๐ค Why Robots Love bv
- Deterministic JSON contracts: robot commands emit stable field names, stable ordering (ties broken by ID), and include
data_hash,analysis_config, andcomputed_atso multiple calls can be correlated safely. - Health flags: every expensive metric reports status (
computed,approx,timeout,skipped) plus elapsed ms and (when sampled) the sample size used. - Consistent cache: robot subcommands share the same analyzer/cache keyed by the issue data hash, avoiding divergent outputs across
--robot-insights,--robot-plan, and--robot-priority. - Instant + eventual completeness: Phase 1 metrics are available immediately; Phase 2 fills in and the status flags tell you when it is done or if it degraded.
๐งญ Data Flow at a Glance
.beads/beads.jsonl
โ tolerant loader (BOM strip, 10MB lines, skip malformed)
โ graph builder (blocking deps only)
โ analyzer (Phase 1 fast; Phase 2 centralities with timeouts)
โ cache (hash-keyed)
โ outputs: TUI | robot JSON | exports/hooks
- Hash and config travel with every robot payload so downstream consumers can verify consistency.
๐ Graph Analysis Algorithms (plain English)
- PageRank: โblocking authorityโ โ foundational tasks with many (or important) dependents.
- Betweenness: โbridgesโ โ nodes on many shortest paths; bottlenecks between clusters.
- HITS: hubs (aggregators) vs authorities (prerequisites).
- Critical-path depth: longest downstream chain length; zero slack keystones.
- Eigenvector: influence via influential neighbors.
- Density, degree, topo sort: structural backbone.
- Cycles: detected via Tarjan SCC +
DirectedCyclesIn; capped with timeouts and stored count. - Each appears in robot insights with its status flag and, when ready, per-issue scores.
โก Phase 1 vs Phase 2
- Phase 1 (instant): degree, topo sort, density; always present.
- Phase 2 (async): PageRank, Betweenness, HITS, Eigenvector, Critical Path, Cycles; 500ms defaults with size-based adjustments. Status flag reflects computed/approx/timeout/skipped.
โฑ๏ธ Timeout & Approximation Semantics
- Per-metric status:
computed(full),approx(e.g., sampled betweenness),timeout(fallback),skipped(size/density guard). - Payload example:
{ "status": { "pagerank": {"state":"computed","ms":142}, "betweenness": {"state":"approx","ms":480,"sample":120}, "cycles": {"state":"timeout","ms":500,"reason":"deadline"} } }
๐งฎ Execution Plan Logic
- Actionable set: open/in-progress issues with no open blocking dependencies.
- Unblocks: for each actionable, list of issues that would become actionable if it closed (no other open blockers).
- Tracks: undirected connected components group actionable items into parallelizable streams.
- Summary: highest-impact item = max unblocks, then priority, then ID for determinism.
๐ฏ Priority Recommendation Model
- Composite score weights: PageRank 30%, Betweenness 30%, blocker ratio 20%, staleness 10%, priority boost 10%.
- Thresholds: high PR >0.30, high BW >0.50, staleness ~14 days, min confidence 0.30 by default.
- Direction: โincreaseโ or โdecreaseโ priority derived from score vs current priority; confidence blends signal count, strength, and score delta.
๐ Diff & Time-Travel Safety Notes
- When stdout is non-TTY or
BV_ROBOT=1,--diff-sinceauto-emits JSON (or requires--robot-diffin strict setups); resolved revision is echoed in the payload. - TUI time-travel badges:
[NEW],[CLOSED],[MODIFIED],[REOPENED], matching the robot diff summary.
๐ก๏ธ Performance Guardrails
- Two-phase analysis with size-aware configs (approx betweenness on large sparse graphs, cycle caps, HITS skipped on dense XL graphs).
- 500ms default timeouts per expensive metric; results marked with status.
- Cache TTL keeps repeated robot calls fast on unchanged data; hash mismatch triggers recompute.
- Bench quick check:
./scripts/benchmark.sh quickor diagnostics viabv --profile-startup.
๐งท Robustness & Self-Healing
- Loader skips malformed lines with warnings, strips UTF-8 BOM, tolerates large lines (10MB).
- Beads file discovery order: beads.jsonl โ beads.base.jsonl โ issues.jsonl; skips backups/merge artifacts/deletions manifests.
- Live reload is debounced; update check is non-blocking with graceful failure on network issues.
๐ Integrating with CI & Agents
- Typical pipeline:
bv --robot-insights > insights.json bv --robot-plan | jq '.plan.summary' bv --robot-priority | jq '.recommendations[0]' bv --check-drift --robot-drift --diff-since HEAD~5 > drift.json
- Use
data_hashto ensure all artifacts come from the same analysis run; fail CI if hashes diverge. - Exit codes: drift check (0 ok, 1 critical, 2 warning).
๐ฉบ Troubleshooting Matrix (robot mode)
- Empty metric maps โ Phase 2 still running or timed out; check status flags.
- Large payloads โ use jq to slice top items; re-run after filtering via recipes.
- Missing cycles โ likely skipped/timeout; see
status.cycles. - Inconsistent outputs between commands โ compare
data_hash; rerun if different.
๐ Security & Privacy Notes
- Local-first: all analysis happens on your repoโs JSONL; no network required for robots.
- Hooks and exports are opt-in; update checks are silent and tolerate network failures without impacting startup.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
๐ค Robot JSON contract โ quick cheat sheet
Shared across all robots
data_hash: hash of the beads file driving the response (use to correlate multiple calls).analysis_config: exact analysis settings (timeouts, modes, cycle caps) for reproducibility.status: per-metric statecomputed|approx|timeout|skippedwith elapsed ms/reason; always check before trusting heavy metrics like PageRank/Betweenness/HITS.
Schemas in 5 seconds (jq-friendly)
bv --robot-insightsโ.status,.analysis_config, metric maps (capped byBV_INSIGHTS_MAP_LIMIT),Bottlenecks,CriticalPath,Cycles, plus advanced signals:Cores(k-core),Articulation(cut vertices),Slack(longest-path slack).bv --robot-planโ.plan.tracks[].items[].{id,unblocks}for downstream unlocks;.plan.summary.highest_impact.bv --robot-priorityโ.recommendations[].{id,current_priority,suggested_priority,confidence,reasoning}.bv --robot-diff --diff-since <ref>โ{from_data_hash,to_data_hash,diff.summary,diff.new_issues,diff.cycle_*}.bv --robot-historyโ.histories[ID].events+.commit_indexfor reverse lookup;.stats.method_distributionshows how correlations were inferred.
Copy/paste guardrails
# Ensure metrics are ready bv --robot-insights | jq '.status' # Top unblockers from plan bv --robot-plan | jq '.plan.tracks[].items[] | {id, unblocks}' # High-confidence priority fixes bv --robot-priority | jq '.recommendations[] | select(.confidence > 0.6)' # Structural strength and parallelism bv --robot-insights | jq '.full_stats.core_number | to_entries | sort_by(-.value)[:5]' bv --robot-insights | jq '.Articulation' bv --robot-insights | jq '.Slack[:5]' # Verify diff hashes match expectations bv --robot-diff --diff-since HEAD~1 | jq '{from: .from_data_hash, to: .to_data_hash}'



