Release/9.11.0

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 9.11.0 /2025-09-05
+* Better arg naming + type annotations by @thewhaleking in https://github.com/opentensor/btcli/pull/590
+* disk cache in config by @thewhaleking in https://github.com/opentensor/btcli/pull/588
+* Unstake no prompts by @thewhaleking in https://github.com/opentensor/btcli/pull/591
+* expand readme by @thewhaleking in https://github.com/opentensor/btcli/pull/598
+* Better arg formatting for readability by @thewhaleking in https://github.com/opentensor/btcli/pull/592
+* Update childkey proportion CLI argument in docs by @HudsonGraeme in https://github.com/opentensor/btcli/pull/602
+* Update example for show command by @HudsonGraeme in https://github.com/opentensor/btcli/pull/604
+* New cmd: `btcli utils latency` by @thewhaleking in https://github.com/opentensor/btcli/pull/599
+* Fix: Swap hotkey - new hotkey reg check by @ibraheem-abe in https://github.com/opentensor/btcli/pull/608
+* Update cli.py to remove double negative typo by @calebcgates in https://github.com/opentensor/btcli/pull/606
+* Better shows hotkeypubs in `w list` by @thewhaleking in https://github.com/opentensor/btcli/pull/611
+* subnet symbol set command by @thewhaleking in https://github.com/opentensor/btcli/pull/613
+* Debug log by @thewhaleking in https://github.com/opentensor/btcli/pull/597
+* Debug log additional by @thewhaleking in https://github.com/opentensor/btcli/pull/615
+
+### New Contributors
+* @calebcgates made their first contribution in https://github.com/opentensor/btcli/pull/606
+
+**Full Changelog**: https://github.com/opentensor/btcli/compare/v9.10.1...v9.11.0
+
 ## 9.10.2 /2025-09-05
 * Fixes swap-hotkey in by @ibraheem-abe in https://github.com/opentensor/btcli/commit/aec630ec06fb679957c1c2940f37a28751fd427f
 

README.md

@@ -135,10 +135,13 @@ You can set the commonly used values, such as your hotkey and coldkey names, the
 The default location of the config file is: `~/.bittensor/config.yml`. An example of a `config.yml` is shown below:
 
 ```yaml
-chain: ws://127.0.0.1:9945
 network: local
-no_cache: False
-wallet_hotkey: hotkey-user1
+use_cache: true
+dashboard_path: null
+disk_cache: false
+rate_tolerance: null
+safe_staking: true
+wallet_hotkey: default
 wallet_name: coldkey-user1
 wallet_path: ~/.bittensor/wallets
 metagraph_cols:
@@ -165,6 +168,29 @@ metagraph_cols:
 btcli config --help
 ```
 
+### ENV VARS
+BTCLI accepts a few environment variables that can alter how it works:
+ - USE_TORCH (default 0): If set to 1, will use torch instead of numpy
+ - DISK_CACHE (default 0, also settable in config): If set to 1 (or set in config), will use disk caching for various safe-cachable substrate
+calls (such as block number to block hash mapping), which can speed up subsequent calls.
+ - BTCLI_CONFIG_PATH (default `~/.bittensor/config.yml`): This will set the config file location, creating if it does not exist.
+ - BTCLI_DEBUG_FILE (default `~/.bittensor/debug.txt`): The file stores the most recent's command's debug log. 
+
+---
+
+## Debugging
+BTCLI will store a debug log for every command run. This file is overwritten for each new command run. The default location
+of this file is `~/.bittensor/debug.txt` and can be set with the `BTCLI_DEBUG_FILE` env var (see above section).
+
+The debug log will **NOT** contain any sensitive data (private keys), and is intended to be sent to the developers
+for debugging. This file contains basic information about the command being run, the config, and the back and forth of requests and responses
+to and from the chain.
+
+If you encounter an issue, and would like to save the file somewhere it won't be overwritten, run `btcli --debug`,
+and set the save file location. We recommend doing this first before anything, and then starting your debugging with
+us on our [Discord](https://discord.gg/bittensor), or by opening an issue on [GitHub](https://github.com/opentensor/btcli/issues/new) 
+(where you can also upload your debug file).
+
 ---
 
 ## License