Skip to main content

Map Your Codebase with vg map

Use vg map to get a structural overview of your repository — the high-level shape of your code map in one command. Learn what the overview shows and how to drill in from there.

Vibgrate Docs

Vibgrate Help

Before you optimize, refactor, or onboard, you need the lay of the land. vg map gives you a map-level overview of your codebase from the Vibgrate Graph code map — the structural shape of the system at a glance. This article explains what it shows and how to use it as the starting point for deeper exploration.

Overview

Vibgrate Graph turns your source into a graph of nodes and edges. vg map summarizes that graph: it presents the overall structure so you can orient quickly. It is the entry point to the map-level insights family — from here you branch into hubs, areas, and oddities.

Prerequisites

Build the code map first, then confirm freshness:

vg build
vg status

vg status reports node and edge counts and whether the graph is stale relative to your working tree. A fresh graph means vg map reflects your current code.

Get the overview

vg map

Use the overview to answer first-look questions: How large is the graph? What is the overall shape? Where should I look first? It frames everything that follows.

From overview to detail

The overview points you toward the focused commands:

vg hubs
vg areas
vg oddities
  • vg hubs ranks the most-depended-on nodes.
  • vg areas reveals natural code communities.
  • vg oddities flags surprising cross-area links.

To inspect a specific node you find interesting:

vg show

And to ask the map a question in natural language, returning a context block you can paste into an AI assistant:

vg ask

When to use it

Run vg map when you join a project, before a major refactor, or whenever you want a current structural read. Because it draws on the local code map, it works fully offline once the graph is built — nothing leaves your machine.

Related

  • Find hubs with vg hubs.
  • Discover areas with vg areas.
  • Detect oddities with vg oddities.
  • Check graph freshness with vg status.