PHPackages                             smakecloud/skeema - 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. [Database & ORM](/categories/database)
4. /
5. smakecloud/skeema

ActiveLibrary[Database & ORM](/categories/database)

smakecloud/skeema
=================

Laravel Skeema Migrations

v0.0.14(1y ago)0107.2k↑56%4[2 PRs](https://github.com/smakecloud/skeema/pulls)MITPHPPHP ^8.1CI passing

Since Feb 9Pushed 1y ago6 watchersCompare

[ Source](https://github.com/smakecloud/skeema)[ Packagist](https://packagist.org/packages/smakecloud/skeema)[ Docs](https://github.com/smakecloud/skeema)[ RSS](/packages/smakecloud-skeema/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (11)Versions (20)Used By (0)

Laravel Skeema
==============

[](#laravel-skeema)

[![phpunit](https://github.com/smakecloud/skeema/actions/workflows/phpunit.yml/badge.svg)](https://github.com/smakecloud/skeema/actions/workflows/phpunit.yml)[![Latest Version on Packagist](https://camo.githubusercontent.com/925bcc22cb67a803d076d5814f5d73002085be429682b25f25ec718cca85f0a1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f736d616b65636c6f75642f736b65656d612e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/smakecloud/skeema)[![Total Downloads](https://camo.githubusercontent.com/f594a283bc29782996bc1a101e8f3fc53915bd52e7209fa17bc6cc56bc7e3251/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f736d616b65636c6f75642f736b65656d612e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/smakecloud/skeema)

This laravel package provides a set of commands to help you manage your database schema during development and CI/CD pipelines using [Skeema](https://www.skeema.io/).

> [Skeema](https://www.skeema.io/download/) is a schema management system for MySQL and MariaDB. It enables management of table definitions and schema changes in a declarative fashion using pure SQL.

✅ Avoid downtimes during migrations.
✅ Lint your schema files with customizable rulests.
✅ Diff your schema files against your database.
✅ Easy to integrate with your CI/CD pipeline.
✅ Utility commands to help you moving from laravel migrations to skeema schema files.
✅ Manage your database schema in a more declarative way.

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
    - [Dumping the Schema](#dumping-the-schema)
    - [Diffing the Schema](#diffing-the-schema)
    - [Linting the Schema](#linting-the-schema)
    - [Pushing the Schema](#pushing-the-schema)
    - [Pulling the Schema](#pulling-the-schema)
    - [Deployment Checking](#deployment-checking)
    - [Laravel Migrations to Skeema "converting"](#laravel-migrations-to-skeema-converting)
- [Quirks](#quirks)
    - [parallel-testing](#parallel-testing)
    - [larastan](#larastan)
- [Testing](#testing)
- [Roadmap](#roadmap)
- [Disclaimer](#disclaimer)
- [Credits](#credits)
- [License](#license)

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

[](#installation)

Use the install.sh script to install skeema and gh-ost.

```
$ curl -s https://raw.githubusercontent.com/smakecloud/skeema/master/install.sh | SKEEMA_VERSION=1.10.1 GH_OST_VERSION=1.1.5 bash
```

Install the package:

```
$ composer require smakecloud/skeema
```

Publish the config file:

```
$ php artisan vendor:publish --provider="Smakecloud\Skeema\ServiceProvider"
```

Configuration
-------------

[](#configuration)

The package will use the default configuration file `config/skeema.php` to run the skeema commands.

Checkout the [Skeema documentation](https://www.skeema.io/docs/) for more information about the different configuration options.

**Default skeema.php config file**```