0.8.2

Install

Quick install (script)

curl -fsSL https://m.canouil.dev/oboro/install.sh | bash

# or pin this exact release
curl -fsSL https://m.canouil.dev/oboro/install.sh | bash -s -- --version 0.8.2

The script picks the archive for your machine and verifies it against SHA256SUMS. It installs into /usr/local/bin when that is writable, otherwise into ~/.local/bin.
It needs bash and curl. On a minimal distribution such as Alpine, install them first with apk add bash curl.

Add --features ner for the build that also detects names not on any list (on Linux it needs glibc 2.39+). Then fetch its model:

curl -fsSL https://m.canouil.dev/oboro/install.sh | bash -s -- --version 0.8.2 --features ner
oboro models pull   # about 348 MB, once, verified against pinned hashes

Docker

docker volume create oboro-vault
docker run --rm \
  -v oboro-vault:/vault \
  -v "$PWD":/work -w /work \
  --user "$(id -u):$(id -g)" \
  ghcr.io/mcanouil/oboro:0.8.2 clean contract.docx

The vault volume is not optional. Without it, the mapping between placeholders and real values disappears with the container. The document can never be restored.

The ghcr.io/mcanouil/oboro:0.8.2-ner tag carries the ner build with the recognition model already inside the image. It finds names with no download and no network at run time.

A prebuilt binary

Pick the archive for your machine from the table below, then:

VERSION=0.8.2
TARGET=x86_64-unknown-linux-musl   # or whichever row matches

curl -fsSLO "https://github.com/mcanouil/oboro/releases/download/${VERSION}/oboro-${VERSION}-${TARGET}.tar.gz"
curl -fsSLO "https://github.com/mcanouil/oboro/releases/download/${VERSION}/SHA256SUMS"

# Check it is what was published.
sha256sum --ignore-missing --check SHA256SUMS

tar -xzf "oboro-${VERSION}-${TARGET}.tar.gz"
install -m 0755 oboro /usr/local/bin/oboro

On macOS, shasum -a 256 --ignore-missing --check SHA256SUMS does the same job.

With Rust already installed

cargo install --git https://github.com/mcanouil/oboro --tag 0.8.2

From source, with the optional features

The default binaries read .txt, .md, .docx, .xlsx and text-based .pdf. They find structured values and anything on your denylist.
They do not find names you have not listed, and they do not read images.

For names, use a -ner archive from the table below (then run oboro models pull), the :0.8.2-ner image, or a source build.
Images need the Tesseract system libraries, so reading them stays a source build:

cargo build --release --features ner   # names and organisations, then: oboro models pull
cargo build --release --features ocr   # images and scanned pages, needs Tesseract

If names are not being redacted, a default build is almost certainly why.
oboro doctor reports what any build can do.

To build the optional features without setting up the system libraries yourself, use the devcontainer. It carries the pinned toolchain, Tesseract and the OCR libraries:

docker build -f .devcontainer/Dockerfile -t oboro-dev .devcontainer
docker run --rm -it -v "$PWD":/work -w /work -u vscode oboro-dev \
  cargo build --release --features "ner,ocr"

In Visual Studio Code or a GitHub Codespace, reopen the folder in the container instead.

Verify what you downloaded

Beyond the checksum, every archive carries build provenance. Use it to confirm the archive came from this repository's workflow, not from somewhere else:

gh attestation verify "oboro-0.8.2-x86_64-unknown-linux-musl.tar.gz" \
  --repo mcanouil/oboro

This tool checks the model it downloads against a pinned hash before using it.
It would be inconsistent to ask you to trust its own binaries on sight.

Which archive is which

Archive	For
x86_64-unknown-linux-musl	Linux on Intel or AMD. Statically linked, so any distribution, glibc version or Alpine.
aarch64-unknown-linux-musl	Linux on ARM, including most cloud instances. Statically linked.
aarch64-apple-darwin	macOS on Apple silicon.
x86_64-pc-windows-msvc	Windows on Intel or AMD.
x86_64-unknown-linux-gnu-ner	Linux on Intel or AMD, with name recognition. Needs glibc 2.39+ (Ubuntu 24.04+, Debian 13+).
aarch64-unknown-linux-gnu-ner	Linux on ARM, with name recognition. Needs glibc 2.39+.
aarch64-apple-darwin-ner	macOS on Apple silicon, with name recognition.

The -ner archives detect names once you fetch the model with oboro models pull. The others are the smaller default build.

The Windows archive is a .zip; extract it with Expand-Archive.

Documentation

https://m.canouil.dev/oboro/

---

Changes

• docs: Rewrite documentation prose in plain, direct sentences.