https://github.com/floydspace/dynamodb-migrations-tool

🧨 The DynamoDB Migrations Tool Command Line Interface (dynamit-cli)
https://github.com/floydspace/dynamodb-migrations-tool

Last synced: about 1 year ago
JSON representation

🧨 The DynamoDB Migrations Tool Command Line Interface (dynamit-cli)

• Host: GitHub
• URL: https://github.com/floydspace/dynamodb-migrations-tool
• Owner: floydspace
• License: mit
• Created: 2020-03-22T10:37:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T16:46:26.000Z (over 3 years ago)
• Last Synced: 2025-04-29T22:24:23.296Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 2.41 MB
• Stars: 19
• Watchers: 2
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
🧨 dynamit-cli

==============

The DynamoDB Migrations Tool Command Line Interface (CLI).

[![Build Status](https://img.shields.io/github/workflow/status/floydspace/dynamodb-migrations-tool/release)](https://github.com/floydspace/dynamodb-migrations-tool/actions)

[![Coverage Status](https://coveralls.io/repos/github/floydspace/dynamodb-migrations-tool/badge.svg?branch=master)](https://coveralls.io/github/floydspace/dynamodb-migrations-tool?branch=master)

[![npm version](https://badge.fury.io/js/dynamit-cli.svg)](https://badge.fury.io/js/dynamit-cli)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Table of Contents

-----------------

- [Installation](#installation)

- [Documentation](#documentation)

Installation

------------

Make sure you have [AWS-SDK](https://aws.amazon.com/sdk-for-node-js/) installed and configured properly. Then install the Dynamit CLI to be used in your project with

```bash

$ npm install --save-dev dynamit-cli

```

And then you should be able to run the CLI with

```bash

$ 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](https://docs.amazonaws.cn/en_us/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.CreateTable)

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](docs/README.md)

- [Frequently Asked Questions](docs/FAQ.md)