README

Auto-generating database documentation system for Laravel - always up-to-date schema docs, ERD diagrams, and relationship mapping.

Features

Auto-generated ERD diagrams (Mermaid, SVG, PNG)
Interactive web documentation server
Multiple export formats (Markdown, HTML, PDF, JSON, DBML)
Automatic relationship detection (FK constraints + Eloquent)
Schema change tracking and changelog
Table statistics and analysis
Search across entire schema
Model docblock parsing for column descriptions

Installation

You can install the package via composer:

composer require marwen-brini/smart-schema-docs --dev

You can publish the config file with:

php artisan vendor:publish --tag="smart-schema-docs-config"

Usage

Generate Documentation

# Generate all documentation
php artisan schema:generate

# Export to specific format
php artisan schema:export --format=markdown --output=docs/database

ERD Diagrams

# Generate ERD diagram
php artisan schema:diagram

# Specific tables only
php artisan schema:diagram --tables=users,posts,comments

# Different formats
php artisan schema:diagram --format=svg
php artisan schema:diagram --format=mermaid

Interactive Documentation Server

# Start documentation server
php artisan schema:serve

Analysis Commands

# Show table statistics
php artisan schema:stats users

# List all relationships
php artisan schema:relationships

# Search schema
php artisan schema:search "user_id"

# Show schema changelog
php artisan schema:changelog

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

marwen-brini / smart-schema-docs

Maintainers

Details