Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

umzug-cli

marcbachmann767MIT3.1.1

A cli factory for umzug, a migration library

umzug, migration, cli

readme

umzug-cli

A cli factory for umzug, a migration library.
Umzug now has a built-in library. So the use of this module is discouraged.

Usage

  1. Create a executable migrate.js

    #!/usr/bin/env node
    const KnexUmzug = require('knex-umzug')
    
    require('umzug-cli')({
     storage: new KnexUmzug({
       connection: knex({})
     }),
     migrations: {
       glob: './migrations/*.js'
     }
    }).cli(process.argv.slice(2))
  2. Execute migrate.js

    $ ./migrate.js
    
    Use: umzug-cli [command]
    
    Where [command] is one of:
     up                     migrates everything up
     down                   migrates 1 migration down
     up [file-to-migrate]   migrates a specific file up
     down [file-to-migrate] migrates a specific file down
     pending                shows all pending migrations
     history                shows the migration history

Why doesn't this library offer an executable?

Because most likely each implementation has a custom config structure. This library directly uses umzug, which you can configure like documented https://www.npmjs.com/package/umzug#configuration