Skip to content
Read Flow Guides

Install

Linux (x86_64)

  • .deb (Debian/Ubuntu):

    Terminal window
    sudo apt install ./read-flow_*.deb

  • Portable tarball: extract read-flow-*-linux-x86_64.tar.gz and run the read-flow binary inside. Optionally copy the .desktop and .svg files into ~/.local/share/.

macOS (Apple Silicon)

Download read-flow-*-macos-arm64.zip, unzip it, and move Read Flow.app to /Applications.

The app is not code-signed yet, so macOS Gatekeeper blocks it on first launch. To open it: right-click Read Flow.app → Open → Open. Alternatively, from a terminal:

Terminal window
xattr -dr com.apple.quarantine "/Applications/Read Flow.app"

Verify your download

Every release publishes a SHA256SUMS file alongside the binaries:

Terminal window
shasum -a 256 -c SHA256SUMS

Build from source

Requires the Rust toolchain and, for the web app, Node.js ≥ 20.

Terminal window
cargo run -p read-flow --release

See the repository README for the full prerequisite list, including the Linux system libraries the desktop app needs.

Next step

Once installed, continue to Setup & configuration.