Getting started

Brume is distributed as a native CLI through the standard package managers for Debian/Ubuntu, Fedora/CentOS and macOS.

Prerequisites

PostgreSQL 14, 15, 16, 17 or 18 on the source database
A target PostgreSQL instance or a writable directory for .sql output
A read-only account on the source database (recommended for safety)

Install on Debian / Ubuntu

# 1. Configure the repo (one time only)
curl -1sLf 'https://dl.cloudsmith.io/public/brume/brume/setup.deb.sh' | sudo -E bash

# 2. Install
sudo apt-get install brume

# Updates afterwards
sudo apt-get update && sudo apt-get upgrade brume

Install on Fedora / CentOS

# 1. Configure the repo (one time only)
curl -1sLf 'https://dl.cloudsmith.io/public/brume/brume/setup.rpm.sh' | sudo -E bash

# 2. Install
sudo dnf install brume

Install on macOS

# 1. Configure the tap (one time only)
brew tap brumeorg/brume
brew trust --formula brumeorg/brume/brume

# 2. Install
brew install brume

# Updates afterwards
brew upgrade brume

Install `pg_dump`

Brume shells out to pg_dump to replicate the source schema. The binary must be on PATH and its major version must match the source’s — e.g. for Postgres 17, install postgresql-client-17.

# Debian / Ubuntu
sudo apt-get install postgresql-client-17

# Fedora / CentOS
sudo dnf install postgresql17

# macOS
brew install libpq
brew link --force libpq

Replace 17 with the major version of your source. Run brume diag after install to verify the version matches.

Verify the install

brume --help

You should see the list of available subcommands (plan, execute, dry-run, audit, diag). If the command is not found, check that your shell’s PATH was reloaded.

Next step

Now write your first configuration and run a pseudonymization end-to-end.

→ Your first pseudonymization