From 38bdca161385671ac5d70acc62a492d0af092820 Mon Sep 17 00:00:00 2001 From: Gus Date: Thu, 22 Feb 2024 18:39:50 -0500 Subject: [PATCH] doc: Updates WalletBalanceCommand to specify wallet balance examples & flag usage --- bittensor/commands/wallets.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/bittensor/commands/wallets.py b/bittensor/commands/wallets.py index bd2460ea5b..61e21348e3 100644 --- a/bittensor/commands/wallets.py +++ b/bittensor/commands/wallets.py @@ -727,11 +727,28 @@ class WalletBalanceCommand: Optional arguments: None. The command uses the wallet and subtensor configurations to fetch balance data. - Example usage:: + Example usages: + + - To display the balance of a single wallet, use the command with the `--wallet.name` argument to specify the wallet name: + + ``` + btcli w balance --wallet.name WALLET + ``` + + - Alternatively, you can invoke the command without specifying a wallet name, which will prompt you to enter the wallets path: + + ``` + btcli w balance + ``` + + - To display the balances of all wallets, use the `--all` argument: - btcli wallet balance + ``` + btcli w balance --all + ``` Note: + When using `btcli`, `w` is used interchangeably with `wallet`. You may use either based on your preference for brevity or clarity. This command is essential for users to monitor their financial status on the Bittensor network. It helps in keeping track of assets and ensuring the wallet's financial health. """