Skip to main content

Explain Any Code Node with vg show

vg show gives the richest single-node view in Vibgrate Graph: what a node is, its callers and callees, and structural metadata. It is the starting point for deeper graph queries.

Difficulty
Beginner
Duration
15 minutes
Steps
5

When you need to understand one specific function, class, or module, vg show is the richest single-node view in Vibgrate Graph. It explains what the node is, what it calls (callees), and what calls it (callers), along with structural metadata.

Prerequisites

  • A built code graph from vg build

Steps

1. Build the graph

vg build

2. Show a node

Pass the node you want to inspect to vg show:

vg show

Provide a node identifier (such as a symbol or file path) when prompted or as the query. vg show resolves it against the graph and prints the node explanation.

3. Read callers and callees

The output separates callers (who depends on this node) from callees (what this node depends on). Use callers to gauge how widely a change ripples; use callees to understand what the node relies on.

4. Inspect structural metadata

vg show includes structural metadata for the node so you can see its place in the graph at a glance — without opening every file by hand.

5. Pivot to related queries

From a node you can pivot to deeper queries:

vg impact
vg tests

vg impact shows the blast radius of changing the node; vg tests shows which tests cover it.

Verification

Confirm vg show prints the node with both callers and callees populated. If the node is not found, rebuild with vg build and check vg status for graph freshness.

Next Steps

  • Run impact analysis with vg impact
  • Trace a dependency path with vg path
  • View the call tree with vg tree

Prerequisites

  • A built code graph (vg build)

Steps

  • 1
    Build the graph
  • 2
    Show a node
  • 3
    Read callers and callees
  • 4
    Inspect structural metadata
  • 5
    Pivot to related queries

Category

Vibgrate