12 releases
Uses new Rust 2024
new 0.0.12 | Apr 2, 2025 |
---|---|
0.0.11 | Mar 31, 2025 |
0.0.2 | Feb 27, 2025 |
#90 in Magic Beans
841 downloads per month
Used in brk
420KB
11K
SLoC
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 commandes for now (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 very costumizable by having all the parameters of their Rust counterparts (run
, query
).
Requirements
Hardware
Recommended
Minimum
To be determined
Software
- Bitcoin
- Rust
- Unix based operating system (Mac OS or Linux)
- Ubuntu users need to install
open-ssl
viasudo apt install libssl-dev pkg-config
- Ubuntu users need to install
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
Usage
Run brk -h
to view each available command and their respective description.
-h
works also for commands, which mean that brk run -h
will explain all the parameters of brk run
for example.
Every parameter set for brk run
will be saved at ~/.brk/config.toml
, which will allow you to simply run brk run
next time.
Then the easiest to let others access your server is to use cloudflared
which will also cache requests. For more information go to: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/
Dependencies
~62MB
~1M SLoC