Skip to content

Commit

Permalink
docs/bdk-cli/installation.md:allow for individual copy/paste
Browse files Browse the repository at this point in the history
  • Loading branch information
RandyMcMillan committed Jul 5, 2024
1 parent e39d3a6 commit c56e219
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/bdk-cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,29 @@ At the time of writing, the project requires cargo >= 1.56.0, which is our minim
Once Cargo is installed, you can proceed to install the interactive `bdk-cli` tool directly from
the GitHub repository, by running:

```bash
# all features with the blocking esplora client
All features with the blocking esplora client

```sh
cargo install --git https://github.com/bitcoindevkit/bdk-cli --features=esplora-ureq,compiler
```

All features with the async esplora client

# all features with the async esplora client
```sh
cargo install --git https://github.com/bitcoindevkit/bdk-cli --features=esplora-reqwest,compiler
```

Minimal install (only repl feature is on by default)

# minimal install (only repl feature is on by default)
```sh
cargo install --git https://github.com/bitcoindevkit/bdk-cli
```

For Windows users, the default SQLite database requires extensive configuration and `bdk-cli` will not build properly if SQLite is unconfigured. To proceed with the installation using `sled` instead, run:

```bash
# disable sqlite and use sled
Disable sqlite and use sled

```sh
cargo install bdk-cli --no-default-features --features=key-value-db,esplora-ureq,compiler
```

Expand Down Expand Up @@ -86,6 +94,6 @@ SUBCOMMANDS:

An example command to sync a testnet wallet to a default electrum server looks like this:

```bash
```sh
bdk-cli wallet -w example --descriptor "wpkh(tprv8ZgxMBicQKsPexGYyaFwnAsCXCjmz2FaTm6LtesyyihjbQE3gRMfXqQBXKM43DvC1UgRVv1qom1qFxNMSqVAs88qx9PhgFnfGVUdiiDf6j4/0/*)" sync
```

0 comments on commit c56e219

Please sign in to comment.