CLI Introduction

Emigrate comes with a CLI that you can use to manage your migrations. The CLI is a powerful tool that allows you to create, run, and manage migrations.

Installing the Emigrate CLI

npm

npm install @emigrate/cli

pnpm

pnpm add @emigrate/cli

yarn

yarn add @emigrate/cli

bun

bun add @emigrate/cli

deno

package.json

{
  "scripts": {
    "emigrate": "emigrate"
  },
  "dependencies": {
    "@emigrate/cli": "*"
  }
}

Existing commands

emigrate up The command for executing migrations, or showing pending migrations in dry run mode.

emigrate list The command for listing all migrations and their status.

emigrate new The command for creating new migration files.

emigrate remove The command for removing migrations from the migration history.