Contact Sales

Quick Start

GUI

The Graphical User Interface (GUI) mode of Toolbox offers a user-friendly interface that allows you to efficiently manage your bitcoin mining operations. To launch the application, simply follow the steps below:

Windows

Double-click the Toolbox icon to open it in your default browser.

macOS

Double-click the Toolbox icon to open it in your default browser.

Linux

  • Open a terminal or command prompt on your system.
  • Navigate to the Braiins Toolbox directory.
  • Type the following command and press Enter:
./braiins-toolbox

This command will open the Toolbox application in your default web browser.

CLI

In addition to the GUI mode, Braiins Toolbox also provides a Command Line Interface (CLI) version, allowing you to interact with the application using text-based commands. The CLI version can be run from the same binary as the GUI version, providing a unified experience.

To get started with the CLI mode, follow the steps below:

  • Open a terminal or command prompt on your system.
  • Navigate to the Toolbox installation directory.

Windows and macOS have their own specific commands to be run in CLI mode:

  • For Windows, run it as braiins-toolbox.exe --version without the ./ at the beginning.
  • For macOS, the CLI app is stored here: /Applications/Braiins\ Toolbox.app/Contents/MacOS/braiins-toolbox

This is a quick summary of the most important commands.

Scan your network

./braiins-toolbox scan '10.10.10-11.*'

Firmware commands

# Install Braiins OS
./braiins-toolbox firmware install '10.10.10-11.*'

# Install Braiins OS with a contract key XYZ
./braiins-toolbox firmware install --contract-code 'XYZ' '10.10.10-11.*'

# Uninstall back to the factory firmware
./braiins-toolbox firmware uninstall '10.10.10-11.*'

# Upgrade Braiins OS
./braiins-toolbox firmware upgrade '10.10.10-11.*'

System commands

# Reboot devices
./braiins-toolbox system reboot '10.10.10-11.*'

# Collect HW data and logs from Antminers S19 with Braiins OS or Bitmain factory firmware
./braiins-toolbox system collect-data '10.10.10-11.*'

# Locate device
./braiins-toolbox system locate-device on '10.10.10.1'

# Run command
./braiins-toolbox system execute '10.10.10-11.*' --command "cat /etc/bos_version"

# Set network to DHCP
./braiins-toolbox system set-network dhcp '10.10.10.1'

Miner commands:

# Set Pool URLs
./braiins-toolbox miner set-pool-urls --url 'stratum+tcp://user@stratum.braiins.com:3333' '10.10.10-11.*'

# Start mining
./braiins-toolbox miner start '10.10.10-11.*'

# Stop mining
./braiins-toolbox miner stop '10.10.10-11.*'

# Restart mining
./braiins-toolbox miner restart '10.10.10-11.*'

# Pause mining
./braiins-toolbox miner pause '10.10.10-11.*'

# Resume mining
./braiins-toolbox miner resume '10.10.10-11.*'

# Set power mode for Bitmain FW
./braiins-toolbox miner set-mode low '10.10.10-11.*'

Tuner commands

# Set power target to 3318 Watts
./braiins-toolbox tuner target --power 3318 '10.10.10-11.*'

# Add 20 TH/s
./braiins-toolbox tuner target --hashrate iii '10.10.10-11.*'

# Set DPS ON
./braiins-toolbox tuner set-dps on '10.10.10-11.*'

# Remove tuned profiles
./braiins-toolbox tuner remove-profiles '10.10.10-11.*'

Cooling commands

# Set cooling mode to auto on Braiins OS devices
./braiins-toolbox cooling set --mode auto '10.10.10.10'

# Set hot temperature to 75°C on Braiins OS devices
./braiins-toolbox cooling set --hot-temp 75 '10.10.10.10'

# Require at least 4 fans to be operational and set auto cooling mode on Braiins OS devices
./braiins-toolbox cooling set --mode auto --min-required-fans 4 '10.10.10.10'

# Configure manual mode with fixed fan speed 70% on Braiins OS devices
./braiins-toolbox cooling set --mode manual --fixed-fan-speed 70 '10.10.10.10'

# Define custom fan range for auto mode on Braiins OS devices
./braiins-toolbox cooling set --mode auto --custom-fan-range 30-90 '10.10.10.10'

# Set fan behavior while paused on Braiins OS devices
./braiins-toolbox cooling set --fan-paused-mode manual --fan-paused-pwm 50 '10.10.10.10'

Advanced commands

# List all available Braiins OS advanced settings
./braiins-toolbox advanced list

# Read current advanced settings from Braiins OS devices
./braiins-toolbox advanced get --all '10.10.10-11.*'

# Configure advanced settings on Braiins OS devices
./braiins-toolbox advanced set -S enable_defrost=true -S defrost_temperature_limit_c=10 '10.10.10-11.*'

# Reset all advanced settings to their defaults on Braiins OS devices
./braiins-toolbox advanced reset --all '10.10.10-11.*'

Custom Contract commands

# Apply contract key XYZ on Braiins OS devices
./braiins-toolbox custom-contract apply --contract-code 'XYZ' '10.10.10-11.*'
Recommended next step

Need firmware that does more than stock setup?

Braiins OS is the next step when you want more control over miner behavior, tuning, efficiency, and long-term operating performance.
See Braiins OSAsk in Telegram
Was this helpful?