Repo brief: voormedia/rails-erd

Generated by RepoPilot · document generated 2026-09-16 · concise human review Evidence snapshot · analyzed 2026-09-16T12:21:22.099Z · commit 8ce4dd1a2e31

Verdict

Healthy — Strong maintenance signals

• Last commit 1w ago
• 12 active contributors
• MIT licensed
• CI configured
• 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against OpenSSF Scorecard

What it is

Rails ERD is a Ruby gem that automatically generates Entity-Relationship Diagrams from Rails Active Record models. It introspects your application's model associations and outputs diagrams in multiple formats: Mermaid (rendered natively on GitHub by default), Graphviz (PDF/PNG/SVG), and other formats like tbls. It serves as both a visualization tool and a domain model inspector for Rails applications. Modular architecture under lib/rails_erd: a Domain layer (domain/entity.rb, domain/relationship.rb, domain/attribute.rb) parses the model structure; multiple Diagram handlers (diagram/graphviz.rb, diagram/mermaid.rb, diagram/tbls.rb) render different outputs; a CLI (cli.rb) and generator…

Start here

Open these first:

• lib/rails_erd.rb — Primary entry point that loads the gem and integrates with Rails via railtie.
• lib/rails_erd/cli.rb — Command-line interface that parses arguments and orchestrates diagram generation.
• lib/rails_erd/domain.rb — Core domain model that introspects ActiveRecord models to build entity and relationship abstractions.
• lib/rails_erd/diagram.rb — Abstract diagram generator that routes to specific output formats (Graphviz, Mermaid, TBLS).
• lib/rails_erd/config.rb — Configuration management for diagram generation options and output settings.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

Clone and install: git clone https://github.com/voormedia/rails-erd.git && cd rails-erd && bundle install (Gemfile present). To test: bundle exec rake or bundle exec rspec (verify with repository documentation bef…

Daily commands:

Within a Rails application: bundle exec rails generate erd:install to set up, then bundle exec rake erd:generate to produce diagrams (outputs to erd.mmd and/or erd.pdf by default). Standalone: `bundle exec erd [opti…

…shortened for this brief.

Key cautions & unknowns

• Concentrated ownership — top contributor handles 76% of recent commits
• Scorecard: default branch unprotected (0/10)
• Graphviz must be installed on the system (via brew install graphviz or equivalent) to generate PDF/PNG/SVG output; Mermaid is format-only and does not require external tools. Rails app models must be loadable in the…
• Published-advisory coverage was unavailable for the captured dependencies.
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests
• OpenSSF Scorecard

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.