Skip to content

Commit ba0bef1

Browse files
committed
docs(readme): add completions block to readme
1 parent c447159 commit ba0bef1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,14 @@ cargo run -- --pretty -n signet wallet -w {wallet_name} balance
228228
```
229229
This is available for wallet, key, repl and compile features. When ommitted, outputs default to `JSON`.
230230

231+
## Shell Completions
232+
233+
`bdk-cli` supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell. For setup instructions, run:
234+
235+
```shell
236+
bdk-cli completions --help
237+
```
238+
231239
## Saving and using wallet configurations
232240

233241
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.

0 commit comments

Comments
 (0)