Alkane Toolkit

CI tests coverage bench bench coverage lines of code code quality dependencies license

Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through a patched wx-rs bridge. Firmware installation is under development.

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. For Windows and macOS, use the matching scripts/build-gui-*.sh script.

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.

Discovery is read-only. The installer and operator actions remain in the implementation plan and firmware matrix.

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.

After an Alkane image boots, compare its build marker with the verified archive from a separate host:

alkane-cli verify-sdk-release <SHA256SUMS> <downloaded-board-archive>
alkane-cli verify-running-build <ip> <ssh-user> <absolute-known-hosts-file> <board> <sdk-commit> <os-commit>

The first command checks the release checksum, inner file list, checksums, and SDK and OS revisions for a board archive. It prints the revisions to use in the second command. The QEMU research archive has no board revision metadata, so only its release checksum is checked. The second command reads /etc/alkane-build over SSH and fails on a mismatch. Neither command installs firmware or establishes the recovery path.

License

MIT. Vendored dependencies keep their own terms.

S
Description
Rust + wxWidgets cross-platform toolkit: install stock or alkaneOS on any ASIC miner
Readme MIT
92 MiB
v0.115.0
Latest
2026-11-17 00:03:11 -07:00
Languages
Rust 87.8%
Python 8.5%
Shell 3.5%
Dockerfile 0.2%