Getting Started

Installation

The terminal app (er) is a single binary you can install in seconds. The desktop app ships as a prebuilt macOS .dmg and can also be built from source. Both need git; everything else is optional.

Requirements

DependencyNeeded forNotes
gitEverythingRequired. er shells out to git for all diff operations.
gh (GitHub CLI)Pull request featuresOptional. Used for PR metadata and two-way comment sync. Install from cli.github.com and run gh auth login. No API token to manage.
An AI coding toolAI reviewOptional. e.g. Claude Code, Codex, or Cursor. You bring your own tool and credentials.
Rust 1.88+Building from sourceNot needed if you use the install script. The workspace uses the 2021 edition; er-mcp needs 1.88 for rmcp 3.
BunBuilding the desktopThe desktop frontend is built with bun; ./scripts/tauri-dev.sh and ./scripts/tauri-build.sh run bun install for you on first run. Not needed for the terminal app.
Node 18+npx easy-review-mcpOnly for the npm launcher for the MCP server, if you use it instead of the Rust binary.

Terminal app (er) terminal

Quick install — macOS & Linux

The install script downloads a pre-built binary into ~/.local/bin/:

curl -fsSL https://raw.githubusercontent.com/VilfredSikker/easy-review/main/install.sh | bash

Install to a different directory, or pin a version:

# custom install directory
curl -fsSL https://raw.githubusercontent.com/VilfredSikker/easy-review/main/install.sh | bash -s -- --dir /usr/local/bin

# a specific released version
curl -fsSL https://raw.githubusercontent.com/VilfredSikker/easy-review/main/install.sh | bash -s -- --version v0.6.5
◆

Make sure your install directory is on your PATH. For ~/.local/bin, add export PATH="$HOME/.local/bin:$PATH" to your shell profile if it is not already there.

From source with Cargo

git clone https://github.com/VilfredSikker/easy-review.git
cd easy-review
cargo install --path crates/er-tui

Or install directly from the repository without cloning:

cargo install --git https://github.com/VilfredSikker/easy-review er-tui

This produces a single er binary with no runtime dependencies beyond git.

Verify the install

er --help
cd ~/some/git/repo
er

Desktop app desktop

◆

Releases carry a prebuilt, signed and notarized .dmg for Apple Silicon Macs. For Intel Macs, Linux, and Windows, build from source (below). The install script and cargo install only cover the er terminal binary.

Direct download macOS

Take the .dmg from the Releases page, open it, and drag Easy Review into Applications. If a release has no .dmg yet, use the previous release or build from source (next section). Intel Macs, Linux, and Windows are not packaged as prebuilt downloads — build those from source as well.

Install from source

Clone the repo and run the desktop app in development, or build a release bundle for your machine:

Run in development

git clone https://github.com/VilfredSikker/easy-review.git
cd easy-review
./scripts/tauri-dev.sh

This launches the Tauri dev shell with the Svelte frontend and hot reload.

Build a release bundle

./scripts/tauri-build.sh

On macOS this produces Easy Review.app under target/desktop/release/bundle/macos/ and copies it to /Applications (set ER_SKIP_DMG=0 to also produce a .dmg, or ER_SKIP_INSTALL=1 to skip the copy). Building requires Rust, the Tauri CLI (cargo install tauri-cli --locked), bun for the frontend, and the platform WebView dependencies (WebKit/GTK on Linux).

✦

The terminal and desktop apps read and write the same review data per repository and branch, so you can install both and switch between them freely. See Review Storage for where that data lives.

Updating

Uninstalling

Remove config, managed review storage, legacy cache, and installed apps from either surface:

Terminal

er uninstall              # interactive confirm
er uninstall --yes        # no prompt
er uninstall --dry-run    # list paths only
er uninstall --keep-data  # leave review storage
er uninstall --keep-config # leave ~/.config/er
er uninstall --keep-apps  # leave binaries / .app

Or re-run the install script with --uninstall (same keep/dry-run flags are forwarded):

curl -fsSL https://raw.githubusercontent.com/VilfredSikker/easy-review/main/install.sh | bash -s -- --uninstall

Desktop

Open Settings → General → Uninstall (also linked from the welcome screen). Confirm by typing uninstall; the app quits after removal. Paths in use by the running process are deleted after it exits.

What gets removed by default:

MCP server (er-mcp)

Optional local MCP server for Claude Code, Cursor, Codex, and OpenCode — PR triage queues and AI sidecar upload into shared managed storage. Full setup (one-line claude mcp add / codex mcp add, plus mcp.json for Cursor and opencode.json for OpenCode): MCP Server Setup.

cargo install --path crates/er-mcp

Herdr plugin

Optional Herdr plugin — open er in a workspace tab, auto-review new worktrees, and Ctrl-click GitHub PR URLs. Listed on herdr.dev/plugins. Setup: Herdr Integration.

herdr plugin install VilfredSikker/easy-review/tools/herdr-easy-review --yes