CodeBoarding
Review the change, not the diff.
See what a pull request does to your system before you merge it. CodeBoarding turns code into interactive architecture maps so you can explore components, follow their dependencies, and review analyzed pull requests alongside code diffs.
This repository contains the open-source analysis engine and CLI. Static analysis extracts code relationships; language models help name and describe the components. Use the resulting map in the web platform, your editor, CI, or generated documentation.
Discord · VS Code extension · Open VSX extension · Web platform · Website · Getting started
The website's illustrative animation (plays once, about 18 seconds). View the static map or replay the interactive story on the website.
The example starts with a large pull-request diff, then shows the six components it touches. Identity and Payments have changed: a new dependency means a Google sign-in outage can block card payments.
Explore the system. Review the change
- Explore: start with the architecture map, expand components, and navigate to the source behind them. Open prepared public repositories without signing in.
- Review: see changed components and dependencies, read changes grouped by component, and inspect code diffs. PR review requires an available analysis from the GitHub Action; architecture comparisons also need a baseline.
- Bring your own analysis: open an
analysis.json or compare two local analysis files. Files are parsed and compared in your browser.
- Share context: use component descriptions and diagrams in documentation, reviews, and your coding agent's next prompt.
What CodeBoarding generates
- An
analysis.json containing the architecture, component descriptions, relationships, and source references.
- Nested component diagrams for exploring subsystems.
- Markdown with Mermaid diagrams, HTML, MDX, or reStructuredText documentation when you request rendering.
- Incremental updates against a previous analysis, or updates to a selected component.
How it works
- Analyze the code. The engine scans the repository and extracts symbols and relationships with static analysis.
- Build the map. It groups code into components and uses your configured model provider to describe their responsibilities. Analysis can send code excerpts to that provider.
- Explore or review. Load the analysis in the web platform or editor, render it as documentation, or use the GitHub Action to publish architecture changes on pull requests.
The engine's top-level architecture, generated from the committed analysis dated September 21, 2026:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
