PHPackages                             cleaniquecoders/laravel-db-doc - 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 &amp; Helpers](/categories/utility)
4. /
5. cleaniquecoders/laravel-db-doc

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

cleaniquecoders/laravel-db-doc
==============================

Generate Database Schema Documentation

1.5.4(9mo ago)43.5k↓50%[4 PRs](https://github.com/cleaniquecoders/laravel-db-doc/pulls)MITPHPPHP ^8.1 | ^8.2 | ^8.3 | ^8.4CI passing

Since Sep 20Pushed 1mo agoCompare

[ Source](https://github.com/cleaniquecoders/laravel-db-doc)[ Packagist](https://packagist.org/packages/cleaniquecoders/laravel-db-doc)[ Docs](https://github.com/cleaniquecoders/laravel-db-doc)[ RSS](/packages/cleaniquecoders-laravel-db-doc/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (13)Versions (25)Used By (0)

Generate Database Schema Documentation
======================================

[](#generate-database-schema-documentation)

[![Latest Version on Packagist](https://camo.githubusercontent.com/6fa07b51853366745d3937ae800555701423647b624fba40f7d83610a6e56afa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f636c65616e69717565636f646572732f6c61726176656c2d64622d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/cleaniquecoders/laravel-db-doc)[![run-tests](https://github.com/cleaniquecoders/laravel-db-doc/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cleaniquecoders/laravel-db-doc/actions/workflows/run-tests.yml)[![Fix PHP code style issues](https://github.com/cleaniquecoders/laravel-db-doc/actions/workflows/fix-styling.yml/badge.svg)](https://github.com/cleaniquecoders/laravel-db-doc/actions/workflows/fix-styling.yml)[![Total Downloads](https://camo.githubusercontent.com/7ac2cf74b88378b82c4ed3f6dbba09d7b5027d25c20d524f03a2ffd44ad36390/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636c65616e69717565636f646572732f6c61726176656c2d64622d646f632e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/cleaniquecoders/laravel-db-doc)

A package to provide you easy way to generate Markdown / JSON format of database schema. Viewable in non-production environment at your `http://domain.com/doc/db-schema`.

 [![](screenshot.png)](screenshot.png)

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

[](#installation)

You can install the package via composer:

```
composer require cleaniquecoders/laravel-db-doc
```

Add the following in your route file:

```
use CleaniqueCoders\LaravelDbDoc\LaravelDbDoc;

LaravelDbDoc::routes();
```

You can publish the config file with:

```
php artisan vendor:publish --tag="db-doc-config"
```

Optionally, you can publish the views using

```
php artisan vendor:publish --tag="laravel-db-doc-views"
```

Usage
-----

[](#usage)

To generate database schema in Markdown format:

```
php artisan db:schema
```

To generate database schema in JSON format:

```
php artisan db:schema --format=json
```

To generate database schema for specific connection:

```
php artisan db:schema --database=sqlite
```

To generate output to specific storage, add in `.env`:

```
LARAVEL_DB_DOC_MARKDOWN_DISK=s3
LARAVEL_DB_DOC_JSON_DISK=s3
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Nasrul Hazim Bin Mohamad](https://github.com/nasrulhazim)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance76

Regular maintenance activity

Popularity27

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity74

Established project with proven stability

 Bus Factor1

Top contributor holds 71.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~55 days

Recently: every ~26 days

Total

20

Last Release

280d ago

PHP version history (3 changes)1.0.0PHP ^8.1

1.4.0PHP ^8.1 | ^8.2 | ^8.3

1.5.0PHP ^8.1 | ^8.2 | ^8.3 | ^8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/b57069d0f4b634f65eccc6e5d5848990e25968d45ec2cf46d626c6a4658f944b?d=identicon)[nasrulhazim.m](/maintainers/nasrulhazim.m)

---

Top Contributors

[![nasrulhazim](https://avatars.githubusercontent.com/u/10341422?v=4)](https://github.com/nasrulhazim "nasrulhazim (82 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (18 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (15 commits)")

---

Tags

dbdocumentationlaravelschemalaravelcleaniquecoderslaravel-db-doc

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/cleaniquecoders-laravel-db-doc/health.svg)

```
[![Health](https://phpackages.com/badges/cleaniquecoders-laravel-db-doc/health.svg)](https://phpackages.com/packages/cleaniquecoders-laravel-db-doc)
```

###  Alternatives

[spatie/laravel-data

Create unified resources and data transfer objects

1.8k28.9M627](/packages/spatie-laravel-data)[hirethunk/verbs

An event sourcing package that feels nice.

513162.9k6](/packages/hirethunk-verbs)[worksome/exchange

Check Exchange Rates for any currency in Laravel.

123544.7k](/packages/worksome-exchange)[ralphjsmit/livewire-urls

Get the previous and current url in Livewire.

82270.3k4](/packages/ralphjsmit-livewire-urls)[hydrat/filament-table-layout-toggle

Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts.

6292.3k1](/packages/hydrat-filament-table-layout-toggle)[ralphjsmit/laravel-helpers

A package containing handy helpers for your Laravel-application.

13704.6k2](/packages/ralphjsmit-laravel-helpers)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
