aboutsummaryrefslogtreecommitdiffstats
path: root/man/bolt.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/bolt.1')
-rw-r--r--man/bolt.170
1 files changed, 70 insertions, 0 deletions
diff --git a/man/bolt.1 b/man/bolt.1
new file mode 100644
index 0000000..4ab6d64
--- /dev/null
+++ b/man/bolt.1
@@ -0,0 +1,70 @@
+.Dd February 12, 2026
+.Dt BOLT 1
+.Os
+.Sh NAME
+.Nm bolt
+.Nd database migration tool
+.Sh SYNOPSIS
+.Nm
+.Ar command
+.Op Ar options
+.Sh DESCRIPTION
+.Nm
+is a command-line tool for database migrations.
+.Pp
+.Bl -bullet
+.It
+Schema migrations are written in plain SQL.
+.It
+Migrations can be versioned sequentially or by creation timestamp.
+.It
+All migrations run in transactions by default.
+.It
+Supports up and down migrations and jumping to any particular schema version.
+.It
+Supports PostgreSQL 13+, MySQL 5.7+, SQL Server 2017+, and SQLite3.
+.El
+.Sh COMMANDS
+.Bl -tag -width Ds
+.It Xr bolt-new 1
+Create a new database migration.
+.It Xr bolt-up 1
+Apply migrations against the database.
+.It Xr bolt-down 1
+Revert migrations against the database.
+.It Xr bolt-status 1
+List migrations and their statuses.
+.It Xr bolt-version 1
+Print the version.
+.It Xr bolt-help 1
+Show the manual for a command.
+.El
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa bolt.toml
+Configuration file. See
+.Xr bolt.toml 5 .
+.It Pa migrations/
+Default directory for migration scripts. See
+.Xr bolt-migration 5 .
+.El
+.Sh EXIT STATUS
+.Nm
+exits 0 on success, and >0 if an error occurs.
+.Sh SEE ALSO
+.Xr bolt-migration 5 ,
+.Xr bolt.toml 5 ,
+.Xr bolt-databases 7 ,
+.Xr bolt-dependencies 7 ,
+.Xr bolt-execution 7 ,
+.Xr bolt-tutorial 7
+.Sh AUTHOR
+.Nm
+is maintained by
+.An Eugene Triguba ,
+.Mt hello@eugenetriguba.com .
+.Pp
+Up-to-date sources can be found at
+.Lk https://git.sr.ht/~eugenetriguba/bolt
+and bugs/patches can be submitted by email to
+.Mt ~eugenetriguba/public-inbox@lists.sr.ht .