Skip to main content

ReadMenator

image

A token-free, offline, production-grade polyglot codebase knowledge graph & architectural analyzer.

No LLMs. No tokens. No cloud costs. Pure static analysis via AST + regex.

ReadMenator builds production-grade codebase knowledge graphs and architectural health reports 100% offline. Identify structural risks, security flaws, and change impact patterns instantly across 19 languages.

Supported Languages (19)

C, C++, Python, Go, Rust, JavaScript, TypeScript, Java, C#, Shell, PHP, Dart, GDScript, Nim, Assembly, Ruby, Swift, Kotlin, Scala, Lua, Elixir.

What ReadMenator Does Better Than Graphify

Feature graphify readmenator
Extraction LLM agents (tokens) AST + regex (free)
Languages Any (LLM reads anything) 19 static parsers
Call graph edges No Yes (intra-file calls)
Inheritance edges No Yes (class, interface)
Architectural layers No Yes (5-layer detection)
Community detection Leiden/Louvain Label propagation
God nodes Yes Yes
Surprising connections Yes Yes
Suggested questions Yes Yes
Edge types 1 (imports) 4 (imports, calls, inherits, resolved_imports)
Export formats JSON, HTML, SVG, GraphML, Obsidian, Cypher/Neo4j JSON, HTML, SVG, GraphML, Obsidian
Watch mode Yes Yes (polling)
Incremental updates Cache-based SHA256 cache
Confidence-tagged edges EXTRACTED/INFERRED/AMBIGUOUS EXTRACTED
Cost Token-based Zero
Speed Minutes Seconds

Installation

pip install readmenator 

or install from path

pip install .

Usage

Generate knowledge base

python -m readmenator /path/to/project --rebuild

Creates KNOWLEDGE_BASE.md with Table of Contents, Statistics Dashboard, Architectural Layers, God Nodes, Community Analysis, Surprising Connections, Suggested Questions, Mermaid graph (internal edges + community subgraphs), and Architecture Reference.

Export formats

python -m readmenator /path/to/project --export-all     # JSON + HTML + SVG
python -m readmenator /path/to/project --json           # graph.json (GraphRAG-ready)
python -m readmenator /path/to/project --html           # graph.html (interactive vis.js)
python -m readmenator /path/to/project --svg            # graph.svg (static)
python -m readmenator /path/to/project --graphml        # graph.graphml (Gephi/yEd)
python -m readmenator /path/to/project obsidian         # Obsidian vault (wikilinks)

Query, explain, and path trace

python -m readmenator /path/to/project query "What classes handle HTTP?"
python -m readmenator /path/to/project explain Database
python -m readmenator /path/to/project path SymbolA SymbolB

Analysis

python -m readmenator /path/to/project analyze          # community + god nodes + questions
python -m readmenator /path/to/project layers           # architectural layer detection

Advanced Architectural Insights (Out of the Box)

ReadMenator goes beyond simple visualization. It runs complex graph algorithms locally to give you deep insights into your code's health:

  • Change Impact Analysis: Know exactly which files are highly coupled. ReadMenator calculates direct and transitive dependents so you can predict what will break before you refactor.
  • Hotspot Detection: Automatically ranks files by combining cognitive complexity (symbol richness) and graph centrality to pinpoint technical debt.
  • Taint Propagation Mapping: Traces how risky imports (like subprocess or OS-level sinks) propagate transitively through your codebase dependency graph.
  • Community & Layer Detection: Automatically groups files into structural layers (utility, business logic, infrastructure) and highly cohesive communities using label propagation.

Automation

python -m readmenator /path/to/project update           # incremental (SHA256 cache)
python -m readmenator /path/to/project watch            # auto-rebuild on file changes
python -m readmenator /path/to/project analyze          # Analyze the proyect

Run tests

python -m readmenator --test

Architecture

Contract File Responsibility
Config _config.py Immutable centralized configuration
Models _models.py Symbol, Node, Edge, AnalysisResult
Parsers _parsers.py 19 language parsers + factory (Strategy pattern)
Scanner _scanner.py Secure directory walking, file-level docs, progress
Resolver _resolver.py Import path resolution
Mermaid _mermaid.py Mermaid graph with internal edges and community subgraphs
Documentation _documentation.py KNOWLEDGE_BASE.md with TOC, dashboard, layers, analysis
Query _query.py Query/explain/path engine with bidirectional path finding
Analyzer _analyzer.py Communities, god nodes, surprising connections, questions
Cache _cache.py SHA256 content cache for incremental updates
Exporter _exporter.py JSON, HTML (vis.js), SVG, GraphML, Obsidian
Layers _layers.py Architectural layer detection (5-layer model)
Watcher _watcher.py Filesystem polling watcher for auto-rebuild
Application _app.py Application orchestrator
CLI __main__.py CLI entry point and argument dispatch

Security

  • Symlinks rejected
  • File size capped at 10 MB
  • Directory depth limited to 20
  • No absolute paths in source code
  • No external network calls in any module
  • All exceptions silently caught during parsing

License

image

AGPL-3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readmenator-1.0.1.tar.gz (99.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readmenator-1.0.1-py3-none-any.whl (99.7 kB view details)

Uploaded Python 3

File details

Details for the file readmenator-1.0.1.tar.gz.

File metadata

  • Download URL: readmenator-1.0.1.tar.gz
  • Upload date:
  • Size: 99.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for readmenator-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e4de1faa505fd03c5eedb4a8da0bc38465bc51a85c9d76c31c67a46d3ee460da
MD5 60bf2673d05884601ebb7c562eb27581
BLAKE2b-256 532adeab52c656fe39affc484400101703a5d028863f0a6d05556ed3073157ce

See more details on using hashes here.

File details

Details for the file readmenator-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: readmenator-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 99.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for readmenator-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e39c525c6ed3c1ead66bcfed37bebd99a155a806537671e4fe622911a8c4cf44
MD5 f91f3e746abd522b3861939ba6464845
BLAKE2b-256 805b0528b3948c7a0f92e8af1ac4028751b2ab6a1a8c4161b286a46cae687f28

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.3

2 files

1.0.2

2 files

This release

1.0.1 This release

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page