Underbase

Underbase

  • Docs
  • Guides
  • API
  • GitHub

›Get started

Get started

  • Introduction
  • Installation
  • Configuration
  • Writting migrations
  • Module usage
  • Logging
  • Troubleshooting

Guides

  • Organizing migrations
  • Babel usage
  • Working with backups
  • Typescript usage

API

  • Module
  • Configuration API
  • Query Interface
  • Module for development
Edit

Installation

First, install the cli app using npm or yarn.

It is recommended to install the CLI tool globally :

npm install -g @underbase/cli

You can also install the package locally :

npm install -D underbase
yarn add underbase --dev

Verify installation

underbase --help
# npx underbase --help
# ./node_modules/.bin/underbase --help

It should returns the help message.

See module usage to learn how to use the library as a module.

← IntroductionConfiguration →
Underbase
Guides
Working with backupsWorking with continuous deploymentAPI Reference
Community
Stack OverflowIssues tracker
More
Release notesGitHub