From: Vadim Anufriev <mailbox@vaan.io>
Date: Tue, 10 Feb 2026 09:07:28 +0000 (+0400)
Subject: docs(completions): edit help output
X-Git-Tag: v3.0.0~2^2~2
X-Git-Url: http://internal-gitweb-vhost/parse/src/example_cli/%22https:/source-script.js?a=commitdiff_plain;h=e173b476b59d286ae96a079292504dc4f3a42212;p=bdk-cli

docs(completions): edit help output
---

diff --git a/src/commands.rs b/src/commands.rs
index 96f9b88..b45bae2 100644
--- a/src/commands.rs
+++ b/src/commands.rs
@@ -130,26 +130,49 @@ pub enum CliSubCommand {
     Wallets,
     /// Generate tab-completion scripts for your shell.
     ///
-    /// Outputs a shell-specific completion script to stdout.
-    /// To enable completions you need to redirect this output into the appropriate location for your shell.
+    /// The completion script is output on stdout, allowing you to redirect
+    /// it to a file of your choosing. Where you place the file will depend
+    /// on your shell and operating system.
+    ///
+    /// Here are common setups for supported shells:
     ///
     /// Bash:
-    ///   bdk-cli completions bash > ~/.local/share/bash-completion/completions/bdk-cli
+    ///
+    ///     Completion files are commonly stored in
+    ///     `~/.local/share/bash-completion/completions` for user-specific commands.
+    ///     Run the commands:
+    ///
+    ///         $ mkdir -p ~/.local/share/bash-completion/completions
+    ///         $ bdk-cli completions bash > ~/.local/share/bash-completion/completions/bdk-cli
     ///
     /// Zsh:
-    ///   bdk-cli completions zsh > ~/.zfunc/_bdk-cli
-    ///   # Make sure ~/.zfunc is in your fpath (add to .zshrc):
-    ///   #   fpath=(~/.zfunc $fpath)
-    ///   #   autoload -Uz compinit && compinit
+    ///
+    ///     Completion files are commonly stored in a directory listed in your `fpath`.
+    ///     Run the commands:
+    ///
+    ///         $ mkdir -p ~/.zfunc
+    ///         $ bdk-cli completions zsh > ~/.zfunc/_bdk-cli
+    ///
+    ///     Make sure `~/.zfunc` is in your fpath by adding to your `.zshrc`:
+    ///
+    ///         fpath=(~/.zfunc $fpath)
+    ///         autoload -Uz compinit && compinit
     ///
     /// Fish:
-    ///   bdk-cli completions fish > ~/.config/fish/completions/bdk-cli.fish
+    ///
+    ///     Completion files are commonly stored in
+    ///     `~/.config/fish/completions`. Run the commands:
+    ///
+    ///         $ mkdir -p ~/.config/fish/completions
+    ///         $ bdk-cli completions fish > ~/.config/fish/completions/bdk-cli.fish
     ///
     /// PowerShell:
-    ///   bdk-cli completions powershell >> $PROFILE
+    ///
+    ///         $ bdk-cli completions powershell >> $PROFILE
     ///
     /// Elvish:
-    ///   bdk-cli completions elvish >> ~/.elvish/rc.elv
+    ///
+    ///         $ bdk-cli completions elvish >> ~/.elvish/rc.elv
     ///
     /// After installing the completion script, restart your shell or source
     /// the configuration file for the changes to take effect.