Pretty Reporter (default)

Emigrate’s default reporter. It recognizes if the current terminal is an interactive shell (or if it’s a CI environment), if that’s the case no animations will be shown.

The reporter is included by default and does not need to be installed separately.

Usage

By default, Emigrate uses the “pretty” reporter, but it can also be explicitly set by using the --reporter flag.

npm

npx emigrate <command> --reporter pretty

pnpm

pnpm emigrate <command> --reporter pretty

yarn

yarn emigrate <command> --reporter pretty

bun

bunx --bun emigrate <command> --reporter pretty

deno

package.json

{
  "scripts": {
    "emigrate": "emigrate"
  }
}

deno task emigrate <command> --reporter pretty

Or by setting it in the configuration file.

JavaScript

emigrate.config.js

/** @type {import('@emigrate/cli').EmigrateConfig} */
export default {
  reporter: 'pretty',
};

TypeScript

emigrate.config.ts

import { type EmigrateConfig } from '@emigrate/cli';

const config: EmigrateConfig = {
  reporter: 'pretty',
};

export default config;

See Reporter Configuration for more information.

Example output

Emigrate up v0.17.2 /your/working/directory (dry run)

  1 pending migrations to run

  › migration-folder/20231218135441244_create_some_table.sql (pending)

  1 pending (1 total)