Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Download the latest binary for your platform from the Releases page:

PlatformFile
Linux x86_64fotobuch-linux-x86_64.tar.gz
Windows x86_64fotobuch-windows-x86_64.zip
macOS arm64 (M1 and up)fotobuch-macos-arm64.tar.gz

Each archive contains both binaries: fotobuch (CLI) and fotobuch-gui (GUI). Extract the archive and place them somewhere on your PATH.

Build from source

Requirements: Rust (stable).

git clone https://github.com/EddyXorb/fotobuch.git
cd fotobuch
cargo build --release --features gui
# binaries:
#   cli: ./target/release/fotobuch
#   gui: ./target/release/fotobuch-gui

Working with the CLI

Verify the install:

fotobuch --version

fotobuch writes a Typst source file alongside the PDF. For a live preview while you work, install VS Code with the Typst Preview extension. Open the .typ file and the preview updates every time you run fotobuch build.

Alternatively, just keep any PDF viewer open and reload after each build.

Shell completions

fotobuch completions --shell bash   >> ~/.bash_completion
fotobuch completions --shell zsh    >> ~/.zshrc
fotobuch completions --shell fish   > ~/.config/fish/completions/fotobuch.fish
fotobuch completions --shell powershell >> $PROFILE

macOS: “Apple could not verify that fotobuch is free of malware”

fotobuch is not signed with an Apple Developer ID and therefore not notarized by Apple. Anything downloaded through a browser gets the com.apple.quarantine attribute, and Gatekeeper blocks quarantined binaries that carry no notarization ticket — the dialog only offers Move to Trash and Done. The binary is fine; macOS simply cannot ask Apple whether it has been checked.

Pick whichever way you prefer:

1. Install from the terminal (recommended). curl does not set the quarantine attribute, so nothing is ever blocked:

curl -fsSL https://github.com/EddyXorb/fotobuch/releases/latest/download/fotobuch-macos-arm64.tar.gz | tar -xz
mkdir -p ~/.local/bin && mv fotobuch fotobuch-gui ~/.local/bin/
~/.local/bin/fotobuch --version

Add ~/.local/bin to your PATH if it is not there yet:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc

2. Remove the quarantine flag from an existing download:

xattr -dr com.apple.quarantine ~/Downloads/fotobuch-macos-arm64

3. Without the terminal: double-click the binary, dismiss the warning, then open System Settings → Privacy & Security, scroll to the security section and click Open Anyway next to the message about fotobuch. Confirm once per binary — fotobuch and fotobuch-gui are separate executables.

Apple Silicon only: the release contains an arm64 build. Intel Macs need a build from source.