Alkane Toolkit
The code quality grade reports GUI Clippy and first-party Rust formatting checks from the last successful main build. Test coverage has a separate badge.
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through a patched wx-rs bridge. In-app image flashing is disabled while that path is reworked.
Run locally
scripts/build-wx-linux.sh
scripts/build-gui-linux.sh
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan uses offline fixtures and does not contact hardware.
Windows 10/11 builds are cross-compiled on Linux (scripts/build-wx-windows.sh,
then scripts/build-gui-windows.sh) and attached to every release as a
self-contained alkane-toolkit.exe; see docs/windows.md.
macOS is not built.
Current scope
- Discover miners by CIDR or IP range with vendored asic-rs.
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
- Filter and sort the desktop table; inspect probes with
miner_probe. - Use controls supported by the selected firmware and restore supported aftermarket firmware to stock.
Discovery is read-only. Control and restore actions change miners. Check the selected devices before applying them. See the implementation plan and firmware matrix for planned coverage.
Development
WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config" \
CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" \
cargo test -p alkane-gui --offline
Keep build output off the source share. main runs full CI and publishes
qualifying releases; next builds -rc candidates. Badges measure host
code, not installation support. See the public
benchmark history.
Firmware safety
Installation must follow the SDK install rules: use the exact board's packer and boot-switch procedure, verify through an independent channel, and never write bootloader or secure regions.
License
MIT. Vendored dependencies keep their own terms.