From: Vadim Anufriev <mailbox@vaan.io>
Date: Tue, 10 Feb 2026 08:56:40 +0000 (+0400)
Subject: docs(readme): add completions block to readme
X-Git-Tag: v3.0.0~2^2~3
X-Git-Url: http://internal-gitweb-vhost/?a=commitdiff_plain;h=ba0bef15335808172f87b11e5f0707f9f1ace098;p=bdk-cli

docs(readme): add completions block to readme
---

diff --git a/README.md b/README.md
index d905197..e373722 100644
--- a/README.md
+++ b/README.md
@@ -228,6 +228,14 @@ cargo run -- --pretty -n signet wallet -w {wallet_name} balance
 ```
 This is available for wallet, key, repl and compile features. When ommitted, outputs default to `JSON`.
 
+## Shell Completions
+
+`bdk-cli` supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell. For setup instructions, run:
+
+```shell
+bdk-cli completions --help
+```
+
 ## Saving and using wallet configurations
 
 The `wallet config` sub-command allows you to save wallet settings to a `config.toml` file in the default directory (`~/.bdk-bitcoin/`) or custom directory specified with the `--datadir` flag. This eliminate the need to repeatedly specify descriptors, client types, and other parameters for each command. Once configured, you can use any wallet command by simply specifying the wallet name. All other parameters are automatically loaded from the saved configuration.