docs: improve CLI reference generator (#5740)

2025-12-06 10:59:55 +00:00 · 2023-12-14 12:18:18 +02:00
parent 013b4c93db
commit 744930f1de
49 changed files with 3481 additions and 3799 deletions
--- a/book/cli/reth/p2p.md
+++ b/book/cli/reth/p2p.md
@ -0,0 +1,155 @@
+# reth p2p
+
+P2P Debugging utilities
+
+```bash
+$ reth p2p --help
+Usage: reth p2p [OPTIONS] <COMMAND>
+
+Commands:
+  header  Download block header
+  body    Download block body
+  help    Print this message or the help of the given subcommand(s)
+
+Options:
+      --config <FILE>
+          The path to the configuration file to use.
+
+      --chain <CHAIN_OR_PATH>
+          The chain this node is running.
+          Possible values are either a built-in chain or the path to a chain specification file.
+          
+          Built-in chains:
+              mainnet, sepolia, goerli, holesky, dev
+          
+          [default: mainnet]
+
+      --datadir <DATA_DIR>
+          The path to the data dir for all reth files and subdirectories.
+          
+          Defaults to the OS-specific data directory:
+          
+          - Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
+          - Windows: `{FOLDERID_RoamingAppData}/reth/`
+          - macOS: `$HOME/Library/Application Support/reth/`
+          
+          [default: default]
+
+      --p2p-secret-key <PATH>
+          Secret key to use for this node.
+          
+          This also will deterministically set the peer ID.
+
+  -d, --disable-discovery
+          Disable the discovery service
+
+      --disable-dns-discovery
+          Disable the DNS discovery
+
+      --disable-discv4-discovery
+          Disable Discv4 discovery
+
+      --discovery.addr <DISCOVERY_ADDR>
+          The UDP address to use for P2P discovery/networking
+          
+          [default: 0.0.0.0]
+
+      --discovery.port <DISCOVERY_PORT>
+          The UDP port to use for P2P discovery/networking
+          
+          [default: 30303]
+
+      --trusted-peer <TRUSTED_PEER>
+          Target trusted peer
+
+      --trusted-only
+          Connect only to trusted peers
+
+      --instance <INSTANCE>
+          Add a new instance of a node.
+          
+          Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
+          
+          Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
+          
+          Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
+          
+          [default: 1]
+
+      --retries <RETRIES>
+          The number of retries per request
+          
+          [default: 5]
+
+      --nat <NAT>
+          [default: any]
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+Database:
+      --db.log-level <LOG_LEVEL>
+          Database logging level. Levels higher than "notice" require a debug build
+
+          Possible values:
+          - fatal:   Enables logging for critical conditions, i.e. assertion failures
+          - error:   Enables logging for error conditions
+          - warn:    Enables logging for warning conditions
+          - notice:  Enables logging for normal but significant condition
+          - verbose: Enables logging for verbose informational
+          - debug:   Enables logging for debug-level messages
+          - trace:   Enables logging for trace debug-level messages
+          - extra:   Enables logging for extra debug-level messages
+
+Logging:
+      --log.file.directory <PATH>
+          The path to put log files in
+          
+          [default: <CACHE_DIR>/logs]
+
+      --log.file.max-size <SIZE>
+          The maximum size (in MB) of one log file
+          
+          [default: 200]
+
+      --log.file.max-files <COUNT>
+          The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
+          
+          [default: 5]
+
+      --log.file.filter <FILTER>
+          The filter to use for logs written to the log file
+          
+          [default: debug]
+
+      --log.journald
+          Write logs to journald
+
+      --log.journald.filter <FILTER>
+          The filter to use for logs written to journald
+          
+          [default: error]
+
+      --color <COLOR>
+          Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
+          
+          [default: always]
+
+          Possible values:
+          - always: Colors on
+          - auto:   Colors on
+          - never:  Colors off
+
+Display:
+  -v, --verbosity...
+          Set the minimum log level.
+          
+          -v      Errors
+          -vv     Warnings
+          -vvv    Info
+          -vvvv   Debug
+          -vvvvv  Traces (warning: very verbose!)
+
+  -q, --quiet
+          Silence all log output
+```