MrLesk/groma.md

What it solves

Architecture diagrams often become outdated the moment they are drawn. This tool solves the problem of "stale documentation" by creating a live, interactive map of your software architecture that stays synchronized with your actual code as it changes.

How it works

groma.md scans your repository to generate a C4-based architecture map. It stores this map as plain Markdown files directly within your Git repository. Because the architecture is stored as code, any changes you or your coding agent make to the map are tracked in your version history. When you modify your source code, the map updates automatically to reflect the new structure, while preserving your manual curations, descriptions, and component groupings.

Who it’s for

It is for developers and teams who want to maintain accurate, up-to-date architecture documentation without the manual overhead of updating diagrams. It is particularly useful for those who use AI coding agents, as the agent can read and update the architecture documentation alongside the code.

Highlights

• Live Updates: The map refreshes automatically as you save code, ensuring your documentation reflects your current work.
• Local and Private: The tool runs entirely on your machine, requires no account, and does not send your code to any external AI services.
• Version Controlled: Since the architecture is stored as Markdown in your repository, you can review architectural changes in the same pull requests as your code.
• Interactive Browser Map: A built-in web interface allows you to zoom through systems, containers, and components, and link directly to the source code behind them.
• Extensible: Supports a wide range of programming languages through a plugin-based scanner system.