mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-27 16:19:59 -07:00
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.
97 lines
4.0 KiB
Markdown
97 lines
4.0 KiB
Markdown
# BRK Cli
|
|
|
|
<p align="left">
|
|
<a href="https://github.com/bitcoinresearchkit/brk">
|
|
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/bitcoinresearchkit/brk?style=social">
|
|
</a>
|
|
<a href="https://github.com/bitcoinresearchkit/brk/blob/main/LICENSE.md">
|
|
<img src="https://img.shields.io/crates/l/brk" alt="License" />
|
|
</a>
|
|
<a href="https://crates.io/crates/brk_cli">
|
|
<img src="https://img.shields.io/crates/v/brk_cli" alt="Version" />
|
|
</a>
|
|
<a href="https://docs.rs/brk_cli">
|
|
<img src="https://img.shields.io/docsrs/brk_cli" alt="Documentation" />
|
|
</a>
|
|
<img src="https://img.shields.io/crates/size/brk_cli" alt="Size" />
|
|
<a href="https://deps.rs/crate/brk_cli">
|
|
<img src="https://deps.rs/crate/brk_cli/latest/status.svg" alt="Dependency status">
|
|
</a>
|
|
<a href="https://discord.gg/HaR3wpH3nr">
|
|
<img src="https://img.shields.io/discord/1350431684562124850?label=discord" alt="Discord" />
|
|
</a>
|
|
<a href="https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6">
|
|
<img src="https://img.shields.io/badge/nostr-purple?link=https%3A%2F%2Fprimal.net%2Fp%2Fnprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6" alt="Nostr" />
|
|
</a>
|
|
<a href="https://bsky.app/profile/bitcoinresearchkit.org">
|
|
<img src="https://img.shields.io/badge/bluesky-blue?link=https%3A%2F%2Fbsky.app%2Fprofile%2Fbitcoinresearchkit.org" alt="Bluesky" />
|
|
</a>
|
|
<a href="https://x.com/brkdotorg">
|
|
<img src="https://img.shields.io/badge/x.com-black" alt="X" />
|
|
</a>
|
|
</p>
|
|
|
|
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`](https://github.com/bitcoinresearchkit/brk/blob/c9c6b583338203b2b11bdf31e961b1c306f5d82b/crates/brk_cli/src/run.rs#L110-L191), and [`query`](https://github.com/bitcoinresearchkit/brk/blob/main/crates/brk_query/src/params.rs)).
|
|
|
|
## Requirements
|
|
|
|
### Hardware
|
|
|
|
#### Recommended
|
|
|
|
- [Latest base model Mac mini](https://www.apple.com/mac-mini/)
|
|
- [Thunderbolt 4 SSD enclosure](https://satechi.net/products/usb4-nvme-ssd-pro-enclosure/Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0VmFyaWFudC80MDE4ODQ3MDA2NzI4OA==?queryID=7961465089021ee203a60db7e62e90d2)
|
|
- [2 TB NVMe SSD](https://shop.sandisk.com/products/ssd/internal-ssd/wd-black-sn850x-nvme-ssd?sku=WDS200T2X0E-00BCA0)
|
|
|
|
#### Minimum
|
|
|
|
To be determined
|
|
|
|
### Software
|
|
|
|
- [Bitcoin](https://bitcoin.org/en/full-node)
|
|
- [Rust](https://www.rust-lang.org/tools/install)
|
|
- Unix based operating system (Mac OS or Linux)
|
|
|
|
> [!IMPORTANT]
|
|
> Ubuntu users need to install `open-ssl` via `sudo apt install libssl-dev pkg-config`
|
|
|
|
|
|
## Download
|
|
|
|
### Binaries
|
|
|
|
You can find a pre-built binary for your operating system in the [releases page](https://github.com/bitcoinresearchkit/brk/releases/latest).
|
|
|
|
### Cargo
|
|
|
|
```bash
|
|
# 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
|
|
|
|
```bash
|
|
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 run` will be saved at `~/.brk/config.toml`, which allows you to simply run `brk run` next 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](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) documentation.
|