Who it is forA developer who has just joined a project or inherited a large codebase and needs orientation before making changes.
The problemReading files one by one is slow, and it is hard to see subsystem boundaries and the most connected parts of the code.
The outcomeA compass-out folder with a graph, an architecture report, and an interactive HTML view that shows how the repository is organized.
What you need first
- A terminal on macOS, Linux, or Windows
- A local project folder or Git repository to analyze
- Rust 1.97.1 or newer only if you build from source
Steps
- Install the CLI with the installer for your system, for example
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/crabbuild/compass/releases/latest/download/install.sh | shon macOS or Linux. (inferred, check the README) cd your-projectcompass init- Open
compass-out/GRAPH_REPORT.mdto read the architecture and community summary. compass export html
Prompt for your agent
In the project at <project path>, run `compass init` using the crabbuild/compass CLI, then read compass-out/GRAPH_REPORT.md and list the main communities and the most connected (god) nodes. Expected output: a short architecture summary with community names and their key symbols. Verify that compass-out/graph.json exists before reporting.
Caveat. Compass writes its output to compass-out/ inside the project, so check that folder before committing or sharing the project.
Use this in your AI agent
Ask your agent
Using the Deduped MCP, get the setup steps for crabbuild/compass and "Map an unfamiliar repository before reading code"
Add Deduped to Claude Code once
claude mcp add --transport http deduped https://dedupedai.com/mcp
Every Monday: the 5 hottest repos and exactly how to use them. Free, one email a week, unsubscribe anytime.
Get them freeShare: X LinkedIn Hacker News Email Copy link
Third-party repos we don't own. AI-written use cases can be wrong. Disclaimer