@prasadrajandran/migr8

Fully customizable CLI utility to manage migrations

Usage no npm install needed!

<script type="module">
  import prasadrajandranMigr8 from 'https://cdn.skypack.dev/@prasadrajandran/migr8';
</script>

README

migr8

Migr8 is a CLI utility to manage migrations. It supports custom registry drivers which allows it to be platform agnostic as new registry drivers could be used to add support for MySQL, PostgreSQL, etc.

How Do I Use It?

Documentation

  • CLI man page.
  • Full API documentation can be found here. These are the most relevant bits:
    • Migr8Config
      • Interface of the config file.
    • Migr8
      • Migr8 class. Inherit this class if there's a need to reimplement any of its methods.
    • Registry
      • Registry driver interface. Implement this interface if there's a need to create another driver (i.e. to support MySQL, PostgreSQL, etc.).
    • FileSystemRegistry
      • Default file system driver that is included out of the box.

Installation

Locally:

npm install @prasadrajandran/migr8

npx migr8 [command]

Globally:

npm install -g @prasadrajandran/migr8

migr8 [command]