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*.dat files
~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.

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)

1.1 KiB Raw Blame History