dbmate

(β˜… 7,138)

πŸš€ A lightweight, framework-agnostic database migration tool.

  • .gitignore
  • .golangci.yml
  • .prettierrc.json
  • docker-compose.supavisor.yml
  • docker-compose.yml
  • Dockerfile
  • go.mod
  • go.sum
  • LICENSE
  • main.go
  • main_cgo.go
  • main_test.go
  • Makefile
  • README.md
  • RELEASING.md
  • tsconfig.eslint.json

# Installation Guide

1. Get the code
git clone https://github.com/amacneil/dbmate

Downloads the entire project code from GitHub to your computer.

cd dbmate

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Scoop A package manager for Windows.
brew install dbmate

Installs the pre-built package via Homebrew β€” no source build required.

scoop install dbmate

Installs directly via Scoop (Windows).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -it --network=host ghcr.io/amacneil/dbmate --help

Runs the built image as an actual container.

docker run --rm -it --network=host -v "$(pwd)/db:/db" ghcr.io/amacneil/dbmate new create_users_table

Runs the built image as an actual container.

$ make docker-all

Type this command into your terminal and run it.

$ make docker-sh

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --save-dev dbmate

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation