noahandClaude Opus 5.5 b46f15b340 Bug report button: file bugs and feature requests from the app
A Bug report button between Export and Settings opens a dialog: a type
(Bug, UI change, Feature request), one text box whose first line
becomes the issue title, and "Include the recent activity log
(passwords removed)", ticked by default. Send posts the report to the
report relay (next commit), which files it as an issue in
blueflare/alkane-toolkit. The dialog then shows the issue number, and
Open issue opens it, or shows why the report was not sent with the text
kept.

The app holds no token. A report carries the app version, platform, OS
version, appearance, language and window size, plus the newest 80 log
lines (at most 16 KiB). Before the log leaves the machine,
bug_report::scrub removes values of password/token/secret-like names,
Authorization and Cookie headers, URL passwords and PEM private keys.
The request goes through the system curl, as the other HTTP actions
do. ALKANE_REPORT_URL overrides the relay address for testing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BdKQBRg6YCM1XXQCTnD5GF
2026-11-04 10:59:02 -06:00
2026-09-23 08:05:11 -06:00
2026-09-23 08:05:11 -06:00

Alkane Toolkit

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

The badges link to the project site: the manual, the code-quality dashboard (how the grade is set, coverage by crate and file) and the benchmark history.

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 builds run on a Mac (scripts/build-wx-macos.sh, then scripts/build-gui-macos.sh) and produce one universal app for Apple Silicon and Intel, macOS 11 or later; see docs/macos.md.

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.

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 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.

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%