Install
pgloupe is one binary. Pick the channel that suits you; each channel updates the way that channel normally does.
| Channel | Install | Update |
|---|---|---|
| Installer script (Linux, macOS) | curl --proto '=https' --tlsv1.2 -LsSf https://github.com/vtrbraga/pgloupe/releases/latest/download/pgloupe-installer.sh | sh | pgloupe-update |
| Installer script (Windows) | powershell -ExecutionPolicy Bypass -c "irm https://github.com/vtrbraga/pgloupe/releases/latest/download/pgloupe-installer.ps1 | iex" | pgloupe-update |
| Homebrew | brew install vtrbraga/tap/pgloupe | brew upgrade pgloupe |
| Cargo | cargo install pgloupe (needs a C toolchain and libclang) | cargo install pgloupe again |
| Prebuilt, through cargo-binstall | cargo binstall pgloupe | the same command |
| Docker | docker run --rm -v "$PWD:/data" ghcr.io/vtrbraga/pgloupe:latest report /data/postgresql.log (or a version tag such as :0.1.0) | docker pull ghcr.io/vtrbraga/pgloupe:latest |
| Archive | download from the releases page, unpack, put pgloupe on your PATH | download again |
Linux and macOS are tested in CI. Windows builds are experimental.
The installer script puts pgloupe in ~/.local/bin. If pgloupe is not found afterwards, open a new shell or run source $HOME/.local/bin/env (the installer prints this line), so that directory is on your PATH.
Man pages and completions
The archives carry dist-assets/man/pgloupe.1 (and one page per command, such as pgloupe-report.1) and tab-completion scripts in dist-assets/completions/ for bash, zsh, fish and PowerShell. Copy them where your system looks, for example dist-assets/man/*.1 to ~/.local/share/man/man1/ and dist-assets/completions/pgloupe.bash to ~/.local/share/bash-completion/completions/pgloupe. The same text as the man pages is in the command reference.
Updating
- Installer script:
pgloupe-updateupdates the install in place. It reads the receipt the installer left and connects to the network only when you run it. Pass--tag v0.1.0to move to a specific version. - Homebrew, Cargo, Docker: use their own upgrade command (table above).
pgloupe-updateonly knows about installs made by the installer. - pgloupe never checks for a newer version on its own. Watch the releases feed and the changelog.
Pin a version
Put the version in the installer URL instead of latest:
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/vtrbraga/pgloupe/releases/download/v0.1.0/pgloupe-installer.sh | sh
Cargo takes cargo install pgloupe --version 0.1.0.
Check what you downloaded
Every archive has a .sha256 file beside it:
sha256sum --check pgloupe-x86_64-unknown-linux-gnu.tar.gz.sha256
Release archives also carry a build attestation that ties them to the workflow run that built them:
gh attestation verify pgloupe-x86_64-unknown-linux-gnu.tar.gz --repo vtrbraga/pgloupe
Uninstall
Delete the binary (which pgloupe), or use the channel’s own command (brew uninstall pgloupe, cargo uninstall pgloupe). pgloupe keeps no state outside the files you ask it to write, except a store you created with logs ingest, which is a single file you chose the path of.