Installation

Install current RCompare binaries or build the workspace from source

Linux Installation

Standalone Binaries (x86_64)

Download the latest CLI and Slint GUI binaries from GitHub releases.

wget https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_cli-linux-x86_64 wget https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_gui-linux-x86_64 chmod +x rcompare_cli-linux-x86_64 rcompare_gui-linux-x86_64 # Optional: install into PATH sudo mv rcompare_cli-linux-x86_64 /usr/local/bin/rcompare_cli sudo mv rcompare_gui-linux-x86_64 /usr/local/bin/rcompare_gui

Standalone Binaries (arm64)

wget https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_cli-linux-arm64 wget https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_gui-linux-arm64 chmod +x rcompare_cli-linux-arm64 rcompare_gui-linux-arm64

Versioned Release Archive

Combined archives include both binaries and are named with the release version.

# Example for a tagged release (replace v0.1.0) VERSION=v0.1.0 wget https://github.com/aecs4u/rcompare/releases/download/${VERSION}/rcompare-${VERSION}-linux-x86_64.tar.gz tar xzf rcompare-${VERSION}-linux-x86_64.tar.gz

Windows Installation

Direct Binaries (x86_64)

Download CLI and Slint GUI executables from the latest release.

https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_cli-windows-x86_64.exe https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_gui-windows-x86_64.exe

Optional Combined Archive

Release ZIP assets are versioned (for example: rcompare-v0.1.0-windows-x86_64.zip).

Download them from the GitHub Releases page.

macOS Installation

Apple Silicon (arm64)

curl -LO https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_cli-macos-arm64 curl -LO https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_gui-macos-arm64 chmod +x rcompare_cli-macos-arm64 rcompare_gui-macos-arm64

Intel (x86_64)

curl -LO https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_cli-macos-x86_64 curl -LO https://github.com/aecs4u/rcompare/releases/latest/download/rcompare_gui-macos-x86_64 chmod +x rcompare_cli-macos-x86_64 rcompare_gui-macos-x86_64

Build from Source

Build Rust binaries and optional components directly from the repository.

Prerequisites

  • Rust toolchain (stable)
  • Git
  • Python 3.10+ and uv (for rcompare_pyside)

Build CLI + Slint GUI

git clone https://github.com/aecs4u/rcompare.git cd rcompare cargo build --release # Run binaries ./target/release/rcompare_cli scan /path/to/left /path/to/right ./target/release/rcompare_gui

Run PySide6 GUI

cd rcompare_pyside uv sync uv run python -m rcompare_pyside

Build C FFI Library

cargo build --package rcompare_ffi --release

CLI Command Quick Reference

Primary commands available in rcompare_cli

Command Description
scan LEFT RIGHT Compare two sources and report statuses
sync LEFT RIGHT Plan or execute synchronization operations
copy LEFT RIGHT Copy selected relative paths between sides
diff-file LEFT RIGHT Compute a focused diff for one relative path
read LEFT RIGHT Read one file from a selected side to stdout or file

Examples

# Scan with JSON output rcompare_cli scan /left /right --json # Plan sync without writing changes rcompare_cli sync /left /right --direction bidirectional --dry-run --json # Compare one file in YAML mode rcompare_cli diff-file /left /right --path config/app.yaml --mode yaml --json # Copy selected files from left to right rcompare_cli copy /left /right --direction left_to_right --path src/main.rs --path Cargo.toml

Configuration

Environment Variables

Variable Description
RCOMPARE_CACHE_DIR Custom directory for hash cache storage
RUST_LOG Enable verbose logging (for example RUST_LOG=debug)

Need Help?

Check the FAQ or open an issue in the main repository.

View FAQ Report Issue