Project

erd-keeper

0.0
No commit activity in last 3 years
No release in over 3 years
ErdKeeper is a gem that outputs ER diagram by setting yaml. The output of ER diagram is realized by wrapping call of rails-erd.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0

Runtime

~> 1.1
>= 0
 Project Readme

ErdKeeper

ErdKeeper is a gem that outputs ER diagram by setting yaml.

The output of ER diagram is realized by wrapping call of rails-erd.

This gem generate a diagram based on your application's Active Record models.

Getting started

Add this line to your application's Gemfile:

gem 'erd-keeper'

And then execute:

$ bundle

Usage

Create configuration file (Write your application's Active Record models):

diagrams:
  tweet:
    - User
    - Micropost
  all:
    - User
    - Micropost
    - Relationship

And then execute:

$ bundle exec erd-keeper --input="config/erd-keeper.yml" --output="./"

Options

  • --input : Write the path of the configuration file.
  • --output : Write the path of the output ER diagram.

License

The gem is available as open source under the terms of the MIT License.