{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "crabbuild-compass--map-unfamiliar-repository",
 "repo": "crabbuild/compass",
 "repo_url": "https://github.com/crabbuild/compass",
 "repo_slug": "crabbuild-compass",
 "title": "Map an unfamiliar repository before reading code",
 "page_title": "How to map an unfamiliar repository before reading code with Compass",
 "summary": "Build a local graph and read a generated architecture summary of communities and key nodes.",
 "who": "A developer who has just joined a project or inherited a large codebase and needs orientation before making changes.",
 "problem": "Reading files one by one is slow, and it is hard to see subsystem boundaries and the most connected parts of the code.",
 "outcome": "A compass-out folder with a graph, an architecture report, and an interactive HTML view that shows how the repository is organized.",
 "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 | sh` on macOS or Linux. (inferred, check the README)",
  "`cd your-project`",
  "`compass init`",
  "Open `compass-out/GRAPH_REPORT.md` to read the architecture and community summary.",
  "`compass export html`"
 ],
 "agent_prompt": "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.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "Compass writes its output to compass-out/ inside the project, so check that folder before committing or sharing the project.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "rust",
 "requirements": [
  "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"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/crabbuild-compass/map-unfamiliar-repository/",
 "md": "https://dedupedai.com/use-cases/crabbuild-compass/map-unfamiliar-repository/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/crabbuild-compass--map-unfamiliar-repository.json",
 "api_version": "v1"
}