Registry / devops / data-migration-cli

data-migration-cli

library2.10.2jsnpmunverified

An oclif-based CLI tool for managing AWS resource migrations. Version 2.10.2 (latest) supports up/down migration scripts, initialization, listing, and resetting. Built with oclif framework, ships TypeScript types. Differentiators include AWS resource awareness, script scoping, and configuration via TypeScript file. Release cadence is infrequent; maintained.

devops database

npm install data-migration-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DATA-MIGRATION-CLI

data-migration-cli

devopsjavascriptv2.10.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

migrate (CLI binary)

✓ npx data-migration-cli migrate

✗ npm install -g data-migration-cli && migrate-cli

The binary name is 'migrate', not 'data-migration-cli'.

Programmatic usage (API)

✓ import { Config } from 'data-migration-cli'

✗ const { Config } = require('data-migration-cli');

The package is ESM-only; use import syntax. No default export.

Initialize project, create config file, add a migration script, and run it.

mkdir my-migrations && cd my-migrations echo 'export default { client: undefined, directory: "./migrations", tableName: "migrations", stage: process.env.STAGE ?? "dev", scope: process.env.SCOPE ?? "default" };' > .dm.config.ts npx data-migration-cli migrate init npx data-migration-cli migrate new add-users-table cat > migrations/20250101_add-users-table.ts << 'EOF' import { MigrationUp, MigrationDown, Migration } from 'data-migration-cli'; export const up: MigrationUp = async (client) => { // Create DynamoDB table }; export const down: MigrationDown = async (client) => { // Delete table }; export default { up, down } as Migration; EOF npx data-migration-cli migrate up

Debug

Known issues

breakingv2.0.0 changed the configuration file format from .dmconfig.js to .dm.config.ts

fix

Rename configuration file to .dm.config.ts and update export format.

affects: >=2.0.0

breakingv2.0.0 dropped support for Node.js <8.0.0

fix

Upgrade Node.js to 8.0.0+.

affects: >=2.0.0

deprecatedThe '--awsProfile' flag is deprecated in v2.5.0, use AWS_PROFILE environment variable instead

fix

Set AWS_PROFILE environment variable instead of passing --awsProfile flag.

affects: >=2.5.0

gotchaThe 'migrate' binary may conflict with other database migration tools (e.g., db-migrate).

fix

Use npx data-migration-cli migrate to avoid global binary conflicts.

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'Oclif'

Missing oclif dependency or incorrect installation.

fix

Install dependencies: npm install oclif

Configuration file not found: ./.dm.config.ts

Configuration file missing or not in current directory.

fix

Create a .dm.config.ts file with proper export.

SyntaxError: Unexpected token 'export'

Using CommonJS require() instead of ES module import.

fix

Ensure package.json has 'type': 'module' or use .mjs extension.

Upgrade

Version history

2.10.2latest on npm

Audit

Dependencies

oclifrequiredCLI framework; core dependency for command handling

aws-sdkrequiredAWS SDK for interacting with AWS resources

Agent activity

9 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/theBenForce/data-migration ↗

packagedata-migration-cli ↗

homepagehttps://data-migration.js.org/packages/data-migration-cli ↗