aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
index 401955a..fff1d31 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,11 @@ Bolt is a command-line tool designed to simplify and streamline your database mi
- [Configuration](#configuration)
- [Configuration File](#configuration-file)
- [Environment Variables](#environment-variables)
+ - [Commands](#commands)
+ - [`bolt new`](#bolt-new)
+ - [`bolt up`](#bolt-up)
+ - [`bolt down`](#bolt-down)
+ - [`bolt status`](#bolt-status)
- [Explanation](#explanation)
- [How Are Migration Scripts Executed?](#how-are-migration-scripts-executed)
- [How Does Bolt Know What Migrations Have Been Applied?](#how-does-bolt-know-what-migrations-have-been-applied)
@@ -263,6 +268,52 @@ All configuration file settings have corresponding environment variables.
- `BOLT_CONNECTION_DBNAME`
- `BOLT_CONNECTION_DRIVER`
+### Commands
+
+#### `bolt new`
+
+```bash
+$ bolt help new
+new [-message|-m]:
+ Create a new database migration
+ -m string
+ alias for -message (default "autogenerated")
+ -message string
+ Message to use for the migration (default "autogenerated")
+```
+
+#### `bolt up`
+
+```bash
+$ bolt help up
+up [-version|-v]:
+ Apply migrations against the database
+ -v string
+ alias for -version
+ -version string
+ The version to upgrade up and including to.
+```
+
+#### `bolt down`
+
+```bash
+$ bolt help up
+down [-version|-v]:
+ Downgrade migrations against the database.
+ -v string
+ alias for -version
+ -version string
+ The version to downgrade down and including to.
+```
+
+#### `bolt status`
+
+```bash
+$ bolt help status
+status:
+ List the database migrations and their statuses
+```
+
## Explanation
### How Are Migration Scripts Executed?