boincrs

A fast, keyboard-first Rust terminal UI for a local BOINC client over the GUI RPC interface. Beta — PrimeGrid and Asteroids@home auto-attach via account keys are supported.

Full documentation lives at jakenherman.github.io/boincrs.

• Why boincrs?
• Getting started
• Configuration
• Project templates & profiles
• Keyboard reference
• Compatibility matrix

Quick install (from source)

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

Binary: ./target/release/boincrs (Linux/macOS) or .\target\release\boincrs.exe (Windows).

Quick run

cp .env.example .env          # fill in BOINCRS_PASSWORD_FILE + optional keys
cargo run

boincrs auto-loads .env at startup if one exists in the working directory. See the Configuration guide for every environment variable.

Requirements

• BOINC client running locally with GUI RPC enabled.
• Rust (stable) and cargo.
• GUI RPC password (often /etc/boinc-client/gui_rpc_auth.cfg on Linux), or BOINCRS_PASSWORD.
• Optional: project authenticator keys for auto-attach.

Testing

cargo test

Live-daemon and integration test variants are documented on the Testing page.

Contributing

See CONTRIBUTING.md and the Contributing guide.

Releases

Release notes live in CHANGELOG.md. Prebuilt Linux, macOS, and Windows binaries are attached to each entry on the Releases page.

Both are generated automatically from Conventional Commit messages by release-plz. See the Changelog page on the docs site for how the flow works.

Support & security

• Sponsor: SUPPORT.md
• Do not commit real .env values, GUI RPC passwords, or project authenticators. Treat them as secrets.

License

MIT — see LICENSE.