aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: d73d848fdb3157a92d8aeee686e7f2359eac6046 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<div align="center">
  <img src="https://github.com/eugenetriguba/bolt/raw/main/docs/logo.png" width="150" />
  <h1>Bolt</h1>
</div>

Bolt is a command-line tool that helps you manage your database migrations.
It allows you to write your database migrations in plain SQL, and Bolt will
handle ensuring they are applied and executed in the correct order.

:warning: This project is in early development.

## Installation

You may install Bolt from source using the following commands:

```bash
$ git clone github.com/eugenetriguba/bolt
$ cd bolt
$ GOBIN=/usr/local/bin/ go install ./cmd/bolt/bolt.go
```

This will install a `bolt` binary under `/usr/local/bin/` that you may
then use by running `bolt` from a command-line.

## Database Compatibility

At the moment, only PostgreSQL is supported. You're welcome to contribute support for other databases.