]> Untitled Git - bdk-cli/commitdiff
docs(readme): add note about updating completions
authorva-an <mailbox@vaan.io>
Thu, 19 Mar 2026 08:48:16 +0000 (12:48 +0400)
committerVadim Anufriev <mailbox@vaan.io>
Thu, 19 Mar 2026 09:20:31 +0000 (13:20 +0400)
README.md

index e373722d820d3c1cd708ead44ff989af8330be4e..36c0cf2513f48efb9898def18891ecb7dfc5c14c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -236,6 +236,8 @@ This is available for wallet, key, repl and compile features. When ommitted, out
 bdk-cli completions --help
 ```
 
+Completion files are generated from the currently installed binary. After upgrading `bdk-cli`, re-run the `completions` command to keep them in sync with the new version.
+
 ## 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.