]> Untitled Git - bitcoindevkit.org/commitdiff
fix(cli-docs): windows build breaks with sqlite
authorRob N <rob.netzke@gmail.com>
Tue, 23 Apr 2024 07:27:30 +0000 (21:27 -1000)
committerthunderbiscuit <thunderbiscuit@protonmail.com>
Wed, 1 May 2024 15:08:58 +0000 (11:08 -0400)
docs/bdk-cli/installation.md

index 93c197d24f5d928f339e5ef6831fac440bd1c967..bdd095d99d1b039e0b00729e3f8e3f48a995c525 100644 (file)
@@ -36,6 +36,13 @@ cargo install --git https://github.com/bitcoindevkit/bdk-cli --features=esplora-
 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
+cargo install bdk-cli --no-default-features --features=key-value-db,esplora-ureq,compiler
+```
+
 This command may take a while to finish, since it will fetch and compile all the dependencies and the `bdk` library itself.
 
 Once it's done, you can check if everything went fine by running `bdk-cli --help` which should print something like this: