Installation

boincrs is currently distributed as a source build. Binary releases and packaged installers are tracked on the roadmap.

Prerequisites

• BOINC client (with GUI RPC enabled) for the local daemon.
• Rust stable toolchain with cargo.
• git to clone the repository.

Build from source

git clone https://github.com/jakenherman/boincrs.git
cd boincrs
cargo build --release

Binary output:

• Linux / macOS: ./target/release/boincrs
• Windows: .\target\release\boincrs.exe

You can also run without building a release binary:

cargo run

Platform notes

Linux

sudo apt install boinc-client boinc-manager  # or your distro equivalent
# ensure GUI RPC is enabled and note the path to gui_rpc_auth.cfg

The default password file is often /etc/boinc-client/gui_rpc_auth.cfg. Depending on your distribution and permissions you may need to sudo cat it or run boincrs as a user in the boinc group.

macOS

Install BOINC via the official installer or Homebrew. The GUI RPC password file lives inside the BOINC app data directory managed by the installer.

Windows

Install BOINC and install Rust via rustup. GUI RPC is enabled by default; the password file lives under the BOINC data folder (for example under C:\ProgramData\BOINC).

Verify

cargo test

See Testing for live-daemon and compatibility-matrix tests.

Next: Configuration.