go-ethereum/docs/cli/debug.md
Jerry a131e427f6 Automatically generate markdown pages from bor CLI
Adding a script that can automatically generate markdown pages from bor
CLI, so we can avoid copy-pasting helper strings whenever a flag is created,
deleted, or modified.

CLI docs could be generated with command `make docs`.
2022-05-09 17:10:36 +02:00

31 lines
No EOL
533 B
Markdown

# Debug
The ```bor debug``` command takes a debug dump of the running client.
## Options
- ```address```: Address of the grpc endpoint
- ```seconds```: seconds to trace
- ```output```: Output directory
## Examples
By default it creates a tar.gz file with the output:
```
$ bor debug
Starting debugger...
Created debug archive: bor-debug-2021-10-26-073819Z.tar.gz
```
Send the output to a specific directory:
```
$ bor debug --output data
Starting debugger...
Created debug directory: data/bor-debug-2021-10-26-075437Z
```