Install
bocal is a single static binary. macOS and Linux are supported (WSL2 works on Windows; native Windows is not supported).
Homebrew
brew install hefgi/tap/bocal
Cargo
cargo install bocal
Requires a Rust toolchain (edition 2021, Rust ≥ 1.89).
npm
A thin wrapper that downloads the prebuilt binary:
npm install -g bocal
Verify
bocal --version
Runtime dependencies
bocal shells out to the standard client tools for the built-in engines — install whichever you use:
| Engine | Tools needed on PATH |
|---|---|
postgres | pg_dump, pg_restore, psql |
mysql (incl. Dolt) | mysql, mysqldump |
custom | whatever your save/restore commands invoke |
Compression for the mysql engine is handled in-process (no external gzip/gunzip needed). Cloud credentials for the registry come from the standard AWS chain — see Configuration.
Tip: keep your Postgres client tools' major version ≥ the server you restore into. bocal's preflight blocks a client older than the target and warns when it's much newer (a newer
pg_dumpcan emit settings an older server rejects).