# @cece_eaze/dynamit-cli

> The DynamoDB migrations tool CLI

Latest version **0.0.3-development** (published 2021-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cece_eaze/dynamit-cli
pnpm add @cece_eaze/dynamit-cli
yarn add @cece_eaze/dynamit-cli
bun add @cece_eaze/dynamit-cli
```

Provides the commands `dynamit`, `dynamit-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3-development |
| Published | 2021-04-28 |
| First published | 2021-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 31.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Victor Korzunin |
| Maintainers | cece_eaze |
| Keywords | cli, umzug, dynamodb, aws, serverless, sequelize, migrate, migration, migrations |

## Links

- npm: https://www.npmjs.com/package/@cece_eaze/dynamit-cli
- Repository: https://github.com/floydspace/dynamodb-migrations-tool
- Homepage: https://floydspace.github.io/dynamodb-migrations-tool
- Issues: https://github.com/floydspace/dynamodb-migrations-tool/issues
- npm.io page: https://npm.io/package/@cece_eaze/dynamit-cli

## Dependencies (7)

- [ramda](https://npm.io/package/ramda.md) ^0.27.1
- [umzug](https://npm.io/package/umzug.md) ^2.3.0
- [yargs](https://npm.io/package/yargs.md) ^15.3.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.673.0
- [cli-color](https://npm.io/package/cli-color.md) ^2.0.0
- [node-plop](https://npm.io/package/node-plop.md) ^0.25.0
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^6.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.3-development (latest) — 2021-04-28
- 0.0.2-development — 2021-04-28
- 0.0.1-development — 2021-04-28
- 0.0.0-development — 2021-04-28

## 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)

---
_Source: https://npm.io/package/@cece_eaze/dynamit-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._