brk_cli 0.1.0-beta.1

A command line interface to run a BRK instance
brk_cli-0.1.0-beta.1 is not a library.
Visit the last successful build: brk_cli-0.0.111

brk_cli

Command-line interface for running a Bitcoin Research Kit instance.

Preview

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.

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)