Skip to content

Commit 2960cde

Browse files
committed
Expand README
1 parent 04ca8b1 commit 2960cde

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,21 @@ BTCLI accepts a few environment variables that can alter how it works:
174174
- 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
175175
calls (such as block number to block hash mapping), which can speed up subsequent calls.
176176
- BTCLI_CONFIG_PATH (default `~/.bittensor/config.yml`): This will set the config file location, creating if it does not exist.
177+
- BTCLI_DEBUG_FILE (default `~/.bittensor/debug.txt`): The file stores the most recent's command's debug log.
178+
179+
---
180+
181+
## Debugging
182+
BTCLI will store a debug log for every command run. This file is overwritten for each new command run. The default location
183+
of this file is `~/.bittensor/debug.txt` and can be set with the `BTCLI_DEBUG_FILE` env var (see above section).
184+
185+
The debug log will **NOT** contain any sensitive data (private keys), and is intended to be sent to the developers
186+
for debugging. This file contains basic information about the command being run, the config, and the back and forth of requests and responses
187+
to and from the chain.
188+
189+
If you encounter an issue, and would like to save the file somewhere it won't be overwritten, run `btcli --debug`,
190+
and set the save file location. We recommend doing this first before anything, and then starting your debugging with
191+
us on our [Discord](https://discord.gg/bittensor).
177192

178193
---
179194

0 commit comments

Comments
 (0)