mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-25 15:19:58 -07:00
brk_cli
Command-line interface for running a Bitcoin Research Kit instance.
Preview
- https://bitview.space - web interface
- https://bitview.space/api - API docs
Requirements
- Bitcoin Core running with RPC enabled
- Access to
blk*.datfiles - ~400 GB disk space
- 12+ GB RAM
Install
rustup update
RUSTFLAGS="-C target-cpu=native -C target-feature=+bmi1,+bmi2,+avx2" cargo install --locked brk_cli --version "$(cargo search brk_cli | head -1 | awk -F'"' '{print $2}')"
The SIMD flags (bmi1, bmi2, avx2) significantly improve pcodec decompression performance.
Portable build (without native CPU optimizations):
cargo install --locked brk_cli
Run
brk
Indexes the blockchain, computes datasets, starts the server on localhost:3110, and waits for new blocks.
Note: When more than 10,000 blocks behind, indexing completes before the server starts to free up memory from fragmentation that occurs during large syncs. The web interface at localhost:3110 won't be available until sync finishes.
Options
brk -h # Show all options
brk -V # Show version
Options are saved to ~/.brk/config.toml after first use.
Files
~/.brk/
├── config.toml Configuration
└── log Logs
<brkdir>/ Indexed data (default: ~/.brk)