Skip to main content

Installing command-line tools

filerepack doctor prints which binaries are on PATH and, for anything missing, OS-specific install commands (Homebrew / MacPorts on macOS, apt / dnf / pacman / zypper / apk on Linux, Chocolatey / winget / Scoop on Windows). 7zz or 7z is required for ZIP/OOXML and generic archive work; native CPIO and WARC do not use it. Other tools enable their corresponding formats. doctor exits 1 if the archiver is missing even when your intended format does not need it.

Override a tool with an environment variable (FILEREPACK_7ZZ, FILEREPACK_JPEGOPTIM, FILEREPACK_JPEGTRAN, FILEREPACK_ZOPFLIPNG, FILEREPACK_OPTIVORBIS, …) or:

# ~/.config/filerepack/config.toml
[tools]
szip = "/opt/homebrew/bin/7zz"
qpdf = "/usr/local/bin/qpdf"

Lookup order is the tool's environment override, the first successfully parsed configuration file's matching entry, then PATH. Configuration files are checked at $XDG_CONFIG_HOME/filerepack/config.toml (when set), ~/.config/filerepack/config.toml, then ~/.filerepack.toml; they are not merged. An invalid explicit executable override is reported as unavailable and does not fall back to PATH. Config keys use registry tool names such as szip and ole_compactor.

For other Linux or Windows package managers, run filerepack doctor and follow the printed commands.

What each tool is for​

ToolFormats
7zz or 7zZIP, 7z, OOXML, nested archives
zipPreferred rewrite for OOXML (docx/xlsx/pptx, …)
filerepack-oleQualified DOC/XLS/PPT/MSG/VSD/PUB/MPP/MSI/HWP CFB compaction; requires filerepack[ole] and independent preservation checks
jpegoptimJPEG entropy optimization, or -m with --jpeg-quality; required presentation metadata is retained
jpegtranLossless JPEG (-optimize -progressive; mozjpeg or libjpeg-turbo); metadata is copied when presentation fields or --keep-meta require it
oxipng / optipnglossless PNG
zopflipngextra lossless PNG pass when --ultra is set
pngquantlossy PNG (--png-quality / --lossy)
qpdfPDF structure/protection inspection; version 11+ for lossless object/stream comparison
gs / gswin64clossy PDF (--lossy / --pdf-profile; default /ebook)
gifsicleGIF
dwebp + cwebpWebP
svgo or scourSVG (XML minify is the fallback)
magick / convert, tiffcpHEIC, JPEG 2000, EXR, ICO, ICNS, DNG (tiffcp), BMP, TGA, PNM, PCX
avifenc + avifdecAVIF (ImageMagick fallback)
ffmpegMP4, MKV, WebM, MOV, M4V, WMV, AVI, ASF, 3GP, MPEG-TS, ALAC/WavPack
ffprobeRequired media stream/container inventory before publication; normally installed with ffmpeg
pigzfaster gzip
xz, bzip2, zstd, brotli, lz4, lzip, lzma, lzop, compressxz / bz2 / zst / br / lz4 / lz / lzma / lzo / .Z
cjxl + djxlJPEG XL
gdcmconv / dcmcjplsDICOM JPEG-LS (uncompressed / RLE images)
flacFLAC recompress
h5repackPreserving HDF5 encoding; the scientific extra provides native readers
netCDF4, tifffile, imagecodecs, psutilPreserving NetCDF/TIFF adapters and worker isolation (scientific extra)
macMonkey's Audio (.ape)
mp3packerlossless MP3 (FILEREPACK_MP3PACKER; not in Homebrew — see below)
optivorbisOgg Vorbis optimization (FILEREPACK_OPTIVORBIS; see below); official CLI does not provide Opus codec optimization
woff2_compress / woff2_decompressAlternative WOFF2 candidates; independent fontTools verification is still required
unrar, rarRAR extract / rewrite (rar missing → 7z)
pyarrow>=19 Python packageVerified Parquet recompression (pip install 'filerepack[parquet]')
pyarrow, fastavroORC / Feather / Arrow / Avro (pip install 'filerepack[data]')
h5py, netCDF4Preserving HDF5 / NetCDF native readers (pip install 'filerepack[scientific]')
fonttoolsWOFF / WOFF2 (pip install 'filerepack[fonts]')
mutagenCover art in MP3/FLAC/M4A/Ogg/APE (pip install 'filerepack[media]')
PillowRequired raster decoding (pip install 'filerepack[validation]')
pikepdfPDF protection-inspection fallback and lossless PDF image streams (pip install 'filerepack[pdf]'; --lossy still uses Ghostscript)

macOS (Homebrew)​

brew install p7zip zip jpegoptim jpeg pngquant oxipng zopfli
brew install qpdf ghostscript gifsicle webp imagemagick libtiff ffmpeg
brew install pigz xz zstd brotli lz4 lzip lzop jpeg-xl hdf5 netcdf flac gdcm dcmtk
npm install -g svgo # or: pip install scour
pip install 'filerepack[data]' 'filerepack[fonts]' 'filerepack[progress]' \
'filerepack[media]' 'filerepack[pdf]'

p7zip may install 7z instead of 7zz. filerepack accepts either.

mp3packer and optivorbis are not in Homebrew. Install them from the mp3packer and optivorbis GitHub releases below.

Ubuntu / Debian​

sudo apt-get update
sudo apt-get install zip p7zip-full jpegoptim pngquant optipng
sudo apt-get install qpdf ghostscript gifsicle webp imagemagick libtiff-tools ffmpeg
sudo apt-get install pigz xz-utils bzip2 zstd brotli lz4 lzip lzop ncompress flac unrar
sudo apt-get install libjxl-tools hdf5-tools netcdf-bin libgdcm-tools dcmtk
sudo apt-get install python3-scour # or: sudo npm install -g svgo
pip install 'filerepack[data]' 'filerepack[fonts]' 'filerepack[progress]' \
'filerepack[media]' 'filerepack[pdf]'

optivorbis is not in apt. Use the GitHub CLI zip.

Windows (Chocolatey)​

choco install 7zip jpegoptim pngquant qpdf ghostscript gifsicle webp imagemagick ffmpeg lz4 xz dcmtk -y
npm install -g svgo
pip install 'filerepack[data]' 'filerepack[fonts]' 'filerepack[progress]' `
'filerepack[media]' 'filerepack[pdf]'

Add C:\Program Files\7-Zip to PATH. filerepack looks for 7zz then 7z. optivorbis is not in Chocolatey; use the GitHub CLI zip.

filerepack-ole (built from source)​

From the repository checkout or extracted source distribution:

pip install 'filerepack[ole]'
cargo install --locked --path tools/ole-compactor

Use Rust 1.89+ and add Cargo's bin directory to PATH. Python wheels do not bundle the executable. Override discovery with FILEREPACK_OLE_COMPACTOR or [tools] ole_compactor = "/absolute/path/to/filerepack-ole". Production compaction does not require Office, LibreOffice, Java or .NET. See Office usage and supported profiles.

mp3packer (not packaged)​

mp3packer losslessly rearranges MP3 frames. It is not in Homebrew, MacPorts, apt, or Chocolatey. filerepack needs the original CLI: mp3packer [-z] in.mp3 out.mp3. --ultra passes -z (Huffman recompression).

Pre-built binaries for macOS, Linux, and Windows: Snesnopic/mp3packer releases.

macOS​

Apple Silicon:

curl -L -o mp3packer.zip \
https://github.com/Snesnopic/mp3packer/releases/download/v2.05-fork/mp3packer-macos-arm64.zip
unzip mp3packer.zip
chmod +x mp3packer
sudo mv mp3packer /usr/local/bin/mp3packer

Intel Mac: download mp3packer-macos-x64.zip instead. If the zip unpacks into a folder, copy the mp3packer binary from inside it. If Gatekeeper blocks it:

xattr -d com.apple.quarantine /usr/local/bin/mp3packer

Point filerepack at a custom path with FILEREPACK_MP3PACKER or:

# ~/.config/filerepack/config.toml
[tools]
mp3packer = "/path/to/mp3packer"

Build from source (optional), same fork, dune-port branch:

brew install opam
opam init
eval "$(opam env)"
opam install dune dune-configurator
git clone -b dune-port https://github.com/Snesnopic/mp3packer.git
cd mp3packer
dune build
sudo cp _build/default/mp3packer.exe /usr/local/bin/mp3packer

Linux/Windows zips from the same release: mp3packer-ubuntu-arm64.zip, mp3packer-ubuntu-x64.zip, mp3packer-windows-x64.zip.

optivorbis (not packaged)​

The official OptiVorbis CLI losslessly optimizes Ogg Vorbis audio; it does not provide Opus codec optimization. It is not in Homebrew, MacPorts, apt, or Chocolatey, and Cargo cannot install it: crates.io optivorbis is a library, and the CLI package is unpublished.

filerepack needs the official CLI: optivorbis in.ogg out.ogg. Pre-built binaries: OptiVorbis/OptiVorbis releases.

macOS​

Apple Silicon (puts the binary on the Homebrew PATH):

curl -L -o optivorbis.zip \
https://github.com/OptiVorbis/OptiVorbis/releases/download/v0.3.2/OptiVorbis.CLI.aarch64-apple-darwin.zip
unzip optivorbis.zip
chmod +x optivorbis
xattr -d com.apple.quarantine optivorbis 2>/dev/null || true
mv optivorbis "$(brew --prefix)/bin/optivorbis"

Intel Mac: download OptiVorbis.CLI.x86_64-apple-darwin.zip instead. If brew is missing, move the binary to /usr/local/bin/optivorbis. If Gatekeeper still blocks it:

xattr -d com.apple.quarantine "$(brew --prefix)/bin/optivorbis"

Point filerepack at a custom path with FILEREPACK_OPTIVORBIS or:

# ~/.config/filerepack/config.toml
[tools]
optivorbis = "/path/to/optivorbis"

Linux​

# x86_64; for ARM use OptiVorbis.CLI.aarch64-unknown-linux-musl.zip
curl -L -o optivorbis.zip \
https://github.com/OptiVorbis/OptiVorbis/releases/download/v0.3.2/OptiVorbis.CLI.x86_64-unknown-linux-musl.zip
unzip optivorbis.zip
chmod +x optivorbis
sudo mv optivorbis /usr/local/bin/optivorbis

Windows​

Download OptiVorbis.CLI.x86_64-pc-windows-gnu.zip from the same release, unzip optivorbis.exe, and put it on PATH.

Verify​

filerepack doctor