Files
alkane-toolkit/docs/manual/01-getting-started.md
T
noahandClaude Opus 5.5 8275f893dd
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 7m55s
verify / verify-windows (pull_request) Successful in 5m8s
SSH login in the Credentials dialog; default range 192.168.1.1/24; legal publisher name
- Credentials dialog: new "SSH (restore)" row for the control-board SSH
  login used by the Braiins restore-to-stock. The username defaults to
  root; the password is masked and never re-displayed, and a blank
  password keeps the saved one. Reset to defaults also clears it.
  ssh-credentials.txt no longer has to be written by hand.
- Default scan range is now 192.168.1.1/24 (scans 192.168.1.0/24), and
  the range dialog's examples use that subnet.
- Windows version info, zip README, LICENSE and docs name the publisher
  as on the signing certificate: BlueFlare Energy Solutions Inc.
- Manual updated for all three.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 13:08:21 -06:00

1.9 KiB

Getting started

Alkane Toolkit finds the ASIC miners on your network and shows them in one table: model, firmware, hashrate, power, temperatures, fans and the health of every hashboard. From the same table you can run the controls each miner's firmware supports, such as pausing, restarting or changing pools.

Download

Get the latest release from the downloads page.

Platform File Notes
Windows 10 and 11 (x86_64) alkane-toolkit-vX.Y.Z-windows-x86_64.zip One signed alkane-toolkit.exe; nothing to install
Linux (x86_64) alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz One binary; needs GTK 3 (sudo apt install libgtk-3-0)

Windows

  1. Download the zip, right-click it, choose Properties, tick Unblock if it is shown, then extract it.
  2. Run alkane-toolkit.exe. Windows shows BlueFlare Energy Solutions Inc. as the verified publisher. To check the signature yourself, right-click the exe, choose Properties and open Digital Signatures.

Linux

tar xzf alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz
./alkane-toolkit-vX.Y.Z-linux-x86_64/alkane-toolkit

First run

The toolkit starts a scan as soon as it opens. Set your own ranges first with Scan ranges (see Scanning); until you do, it scans 192.168.1.0/24, the usual router subnet.

To look around without touching any miner, start it in demo mode. It shows a built-in sample fleet and simulates every action:

Platform Command
Windows (Command Prompt) set ALKANE_FAKE_SCAN=1 && alkane-toolkit.exe
Linux ALKANE_FAKE_SCAN=1 ./alkane-toolkit

Where settings are kept

Platform Folder
Windows %APPDATA%\alkane-toolkit
Linux ~/.config/alkane-toolkit

See Settings and credentials for the files in that folder. Deleting the folder resets the toolkit to its defaults.