BRK CLI

A command line interface to run a Bitcoin Research Kit instance.

It's very customizable with all parameters from the underlying tools (crates) used inside.

Run brk -h for more information.

Requirements

Hardware

Recommended

• Latest base model Mac mini
• Thunderbolt 4 SSD enclosure
• 2 TB NVMe SSD

Minimum

To be determined

Software

• Bitcoin
• Rust
• Unix based operating system (Mac OS or Linux)

[!IMPORTANT] Ubuntu users need to install open-ssl via sudo apt install libssl-dev pkg-config

Download

Binaries

You can find a pre-built binary for your operating system in the releases page.

Cargo

# Install
cargo install brk # or `cargo install brk_cli`, the result is the same

# Update
cargo install brk # or `cargo install-update -a` if you have `cargo-update` installed

Source

git clone https://github.com/bitcoinresearchkit/brk.git
cd brk/crates/brk
cargo run -r

Usage

Run brk -h to view each available parameter and their respective description.

[!TIP] Every parameter set will be saved at ~/.brk/config.toml, which allows you to simply run brk next time.

Tunnel

The easiest way to let others access your server is to use cloudflared which will also cache requests. For more information see Cloudflare Tunnel documentation.