bittensor-cli 9.10.1__tar.gz → 9.11.0__tar.gz

{bittensor_cli-9.10.1 → bittensor_cli-9.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bittensor-cli
-Version: 9.10.1
+Version: 9.11.0
 Summary: Bittensor CLI
 Author: bittensor.com
 Project-URL: homepage, https://github.com/opentensor/btcli
@@ -8,7 +8,7 @@ Project-URL: Repository, https://github.com/opentensor/btcli
 Requires-Python: <3.14,>=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: wheel
-Requires-Dist: async-substrate-interface>=1.4.2
+Requires-Dist: async-substrate-interface>=1.5.2
 Requires-Dist: aiohttp~=3.10.2
 Requires-Dist: backoff~=2.2.1
 Requires-Dist: GitPython>=3.0.0
@@ -168,10 +168,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:
@@ -198,6 +201,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

{bittensor_cli-9.10.1 → bittensor_cli-9.11.0}/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