🧨 dynamit-cli

The DynamoDB Migrations Tool Command Line Interface (CLI).

Table of Contents

• Installation
• Documentation

Installation

Make sure you have AWS-SDK installed and configured properly. Then install the Dynamit CLI to be used in your project with

$ npm install --save-dev dynamit-cli

And then you should be able to run the CLI with

$ npx dynamit --help

Migration records are supposed to be stored in the DynamoDB table with the table-name ("migrations" by default) and primary key attribute-name ("name" by default) defined as optional cli options. The tool cannot create the table for you yet, so make sure you created it properly. See Creating a Table Developer Guide

Usage

npx dynamit [command]

Commands:
  dynamit migrate                        Run pending migrations
  dynamit migrate:status                 List the status of all migrations
  dynamit migrate:undo                   Reverts a migration
  dynamit migrate:undo:all               Revert all migrations ran
  dynamit migration:generate             Generates a new migration file       [aliases: migration:create]

Options:
  --version  Show version number                                         [boolean]
  --help     Show help                                                   [boolean]

Documentation

• CLI Options
• Frequently Asked Questions