d6fd7de361
* Fix typos
* Rephrasing some descriptions
* Links to run command parameters now link to the code as it is in blob 49d66a133e specifically.
* Lightly introduce some nice features of Github flavored markdown (IMPORTANT and TIP) to assess how this nuance is received by maintainers.
4.0 KiB
BRK Cli
A command line interface to interact with the full Bitcoin Research Kit. It's built on top of every other create and gives the possility to use BRK using the terminal instead of Rust.
It has 2 commands (other than help and version) which are run and query. The former is used to run the processing (indexer + computer) and/or the server. The latter uses brk_query as its backend just like to server to be able to get datasets via the terminal instead of the API. Both commands are custumizable by supporting all the parameters of their Rust counterparts (run, and query).
Requirements
Hardware
Recommended
Minimum
To be determined
Software
Important
Ubuntu users need to install
open-sslviasudo 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 command and their respective description.
-h works also for commands, so brk run -h will enumerate all the parameters of brk run.
Tip
Every parameter set for
brk runwill be saved at~/.brk/config.toml, which allows you to simply runbrk runnext time.
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.