PHPackages                             springworks/entity-diagrams - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. springworks/entity-diagrams

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

springworks/entity-diagrams
===========================

Generate entity diagrams that show how the different parts of your Craft site relate to each other

2.0.2(1y ago)31.2k2MITPHP

Since Aug 30Pushed 1y ago1 watchersCompare

[ Source](https://github.com/steverowling/craft-entity-diagrams)[ Packagist](https://packagist.org/packages/springworks/entity-diagrams)[ RSS](/packages/springworks-entity-diagrams/feed)WikiDiscussions v4 Synced 1mo ago

READMEChangelogDependencies (1)Versions (21)Used By (0)

Entity Diagrams plugin for Craft CMS 4.x
========================================

[](#entity-diagrams-plugin-for-craft-cms-4x)

Generate entity diagrams that show how the different parts of your Craft site relate to each other

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 4.0.0 or later.

Installation
------------

[](#installation)

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

    ```
     cd /path/to/project

    ```
2. Then tell Composer to load the plugin:

    ```
     composer require springworks/entity-diagrams

    ```
3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Entity Diagrams.

Entity Diagrams Overview
------------------------

[](#entity-diagrams-overview)

Have you ever wanted to get a visual overview of how the different elements of your Craft site fit together? Entity Diagrams enables you to do just that, producing an in-browser SVG that you can zoom and scale around, or download as an SVG file to re-use as you wish.

Supporting all the native top-level Craft elements (Entries, Categories, Tags, Users, Globals and Assets), you can choose to include all or none of an element type, or create custom document groupings that describe sub-sections of your site. Commerce Products are also supported if the Craft Commerce plugin is installed.

The plugin will scan the requested element types, and generate entity diagrams showing the element type, a list of all the fields (broken down by entry type and field layout tab) and will include connections between related element types directly from the relevant relations field.

There are options to include all fields or none and whether to expand Matrix blocks to include their sub-fields.

Using the `entity-diagrams.php` config file, you can add custom author links (useful if authors for a section always come from a particular user group).

You can also create custom nodes and links. These can be useful if you have custom database tables that interact with other elements of your site.

It’s a powerful tool to get a visual overview of how a complex site is structured adn can be really useful for onboarding new developers or when taking over a site developed by someone else.

Configuring Entity Diagrams
---------------------------

[](#configuring-entity-diagrams)

Entity Diagrams is configured by creating a config file named `entity-diagrans.php` in your Craft config folder (i.e. alongside the `general.php` and `db.php` config files).

The config file should look something like this:

```