riff

    Start

    Installation

    Build the desktop app from source, or install the browser version from a release.

    riff is built from source with Rust and the UI toolchain. The browser version, riff-web, also ships as release binaries.

    Requirements

    • git 2.31 or newer. PR review hands git its GitHub token through environment config, which needs 2.31.
    • A GitHub token for anything that talks to GitHub. The first-run setup asks for it. See GitHub token.
    • To build from source: a Rust toolchain, Node with pnpm, and just.

    Desktop app (macOS)

    From a checkout of the repository:

    Terminal window
    just install

    This builds Riff.app into /Applications, installs a riff shim into ~/.cargo/bin, and installs riff-diff alongside it. The shim opens the app for riff, riff <path> and riff <rev>..<rev>, and runs pr, review, prepare and article in your terminal. Then:

    Terminal window
    riff # open the repository you're in
    riff --web # serve the browser UI from the same binary instead

    just install-quick does the same with a faster build profile (no LTO, incremental), which is handy when you rebuild often.

    On Linux, just install builds the UI and installs the riff and riff-diff binaries into ~/.cargo/bin with cargo install; there is no app bundle or shim.

    Browser version

    From a release

    Releases ship riff-web for macOS (Apple silicon and Intel) and Linux (x86_64), as prereleases. Install or update it with the GitHub CLI, logged in with access to the repository:

    Terminal window
    gh api -H 'Accept: application/vnd.github.raw' \
    repos/jsnanigans/riff/contents/scripts/install-web.sh | sh
    riff-web --version

    This puts riff-web in ~/.local/bin; set RIFF_INSTALL_DIR to change that. Run the same command again to update. It also takes prepare and article, like riff does.

    From source

    Terminal window
    just install-web # installs riff-web into ~/.cargo/bin

    Run it from inside a repository:

    Terminal window
    riff-web # serves http://localhost:7433 and opens it; Ctrl+C stops it

    Outside a repository it still serves PR review.

    Command line only

    Terminal window
    just install-cli # or: cargo install --path riff-cli
    riff-diff --help

    This installs riff-diff, which also runs pr and review. prepare and article need riff or riff-web.

    Everything

    Terminal window
    just install-all # riff, riff-diff and riff-web