ArchGraph
What is ArchGraph?
ArchGraph converts a plain-text description of a codebase's architecture into an interactive dependency graph that highlights architecture and layer violations, working in a language-agnostic way.
Key Capabilities
- Plain-Text Modeling: Reads a layer hierarchy (JSON) and prose unit descriptions (Markdown) that declare dependencies inline using backtick-at notation (@submodule.UnitName).
- Dependency Validation: Resolves declared dependencies and validates them against the layer hierarchy, flagging upward or sideways references as violations.
- Dual Visualization: Renders two views: a box graph showing submodule contents, and a Sonargraph-inspired pearl graph showing dependency flow with green (valid) and red (violation) arcs.
- Codebase Auto-Generation: Generates unit descriptions from a codebase using tree-sitter for per-language parsing.
- Language Agnosticism: Operates on descriptions rather than parsed code, so it also visualizes design documents.
Audience & Use Cases
- Audience: Software architects and senior developers reviewing or documenting codebase structure.
- Use Case: Visualizing module dependencies, enforcing layering rules, and reviewing architecture during design or refactoring.
Technical Specifications
- Language: Python, with a browser-rendered frontend.
- License: Open source (no bundled license file at the repository root).
- Deployment: Local scripts (prepare.py, archgraph.py) that produce a result.json consumed by the frontend.
Categories & Use Cases
Technical Details
| Mobile Application | No |
|---|
FAQs
What is ArchGraph?
ArchGraph converts a plain-text description of a codebase's architecture into an interactive dependency graph that highlights architecture and layer violations, working in a language-agnostic way.