schemarkdown-cli

The database document generator for Laravel

MIT License

Stars
47
Committers
2

Schemarkdown CLI

The schema document generator and eloquent model generator for CLI, only.

Use the schemarkdown library.

Installation

Download the Release phar file and execute it:

chmod +x schemarkdown.phar
./schemarkdown.phar

Or move into /usr/local/bin if want globally call:

mv schemarkdown.phar /usr/local/bin/schemarkdown
schemarkdown

Usage

See schemarkdown for more information.

Example

Here is example SQL, import MySQL and run following command:

php schemarkdown.phar --config-file=tests/Fixtures/database.php --connection=examples --output-dir=examples

It will generate this Markdown documents.

Build Yourself

Clone this repository and run make command:

make

Use Box to build PHAR file:

box compile

Troubleshooting

Use -vv option to see info log.

License

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