]> Untitled Git - bitcoindevkit.org/commitdiff
Updated installation.md to reflect v0.2.1
authorVishal Menon <vishalmenon.92@gmail.com>
Tue, 6 Jul 2021 21:36:30 +0000 (03:06 +0530)
committerSteve Myers <steve@notmandatory.org>
Thu, 8 Jul 2021 16:55:38 +0000 (09:55 -0700)
content/bdk-cli/installation.md

index 8b9b7d7e921d1e1dbf20af6164bceb27245497ea..ac3eae9aefabeed0496eabcb342bd33a42d4ffe5 100644 (file)
@@ -15,7 +15,7 @@ follow their instructions, after which you can test if everything went fine by r
 `cargo version`, which should print something like:
 
 ```
-cargo 1.45.0 (744bd1fbb 2020-06-15)
+cargo 1.53.0 (53cb7b09b 2021-06-17)
 ```
 
 If you really don't want to pipe the output of `curl` into `sh`, you can also try using a
@@ -23,9 +23,7 @@ If you really don't want to pipe the output of `curl` into `sh`, you can also tr
 advanced users and won't be covered in this guide.
 
 {{% notice note %}}
-At the time of writing, the project requires cargo >= 1.45.0, which is the latest stable as of
-June 2020. If you have an older version installed with rustup.rs, you can upgrade it with
-`rustup update`.
+At the time of writing, the project requires cargo >= 1.46.0, which is our minimum supported rust version (MSRV) as of July 2021. If you have an older version installed with rustup.rs, you can upgrade it with `rustup update`.
 {{% /notice %}}
 
 ## Installing the `bdk-cli` tool
@@ -34,13 +32,18 @@ Once Cargo is installed, you can proceed to install the interactive `bdk-cli` to
 the GitHub repository, by running:
 
 ```bash
-cargo install --git https://github.com/bitcoindevkit/bdk-cli --features="compiler"
-# most commonly used features
+# all features
+cargo install --git https://github.com/bitcoindevkit/bdk-cli --features=esplora,compiler
+
+# minimal install
+cargo install --git https://github.com/bitcoindevkit/bdk-cli
 ```
 
-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:
+This command may take a while to finish, since it will fetch and compile all the dependencies and the `bdk` library itself.  
+
+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:
 
 ```text
 BDK CLI 0.2.1-dev
@@ -58,14 +61,16 @@ OPTIONS:
     -n, --network <NETWORK>    Sets the network [default: testnet]
 
 SUBCOMMANDS:
-    help      Prints this message or the help of the given subcommand(s)
-    key       Key management sub-commands
-    repl      Enter REPL command loop mode
-    wallet    Wallet options and sub-commands
+    compile    Compile a miniscript policy to an output descriptor
+    help       Prints this message or the help of the given subcommand(s)
+    key        Key management sub-commands
+    repl       Enter REPL command loop mode
+    wallet     Wallet options and sub-commands
+
 ```
 
-An example command to sync a testnet wallet looks like this:
+An example command to sync a testnet wallet to a default electrum server looks like this:
 
 ```bash
-bdk-cli wallet -w example --descriptor "wpkh(tprv8ZgxMBicQKsPexGYyaFwnAsCXCjmz2FaTm6LtesyyihjbQE3gRMfXqQBXKM43DvC1UgRVv1qom1qFxNMSqVAs88qx9PhgFnfGVUdiiDf6j4/0/*)" --server ssl://electrum.blockstream.info:60002 sync 
+bdk-cli wallet -w example --descriptor "wpkh(tprv8ZgxMBicQKsPexGYyaFwnAsCXCjmz2FaTm6LtesyyihjbQE3gRMfXqQBXKM43DvC1UgRVv1qom1qFxNMSqVAs88qx9PhgFnfGVUdiiDf6j4/0/*)" sync 
 ```