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/db/list.md
+++ b/book/cli/reth/db/list.md
@ -0,0 +1,141 @@
+# reth db list
+
+Lists the contents of a table
+
+```bash
+$ reth db list --help
+Usage: reth db list [OPTIONS] <TABLE>
+
+Arguments:
+  <TABLE>
+          The table name
+
+Options:
+      --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]
+
+  -s, --skip <SKIP>
+          Skip first N entries
+          
+          [default: 0]
+
+      --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]
+
+  -r, --reverse
+          Reverse the order of the entries. If enabled last table entries are read
+
+  -l, --len <LEN>
+          How many items to take from the walker
+          
+          [default: 5]
+
+      --search <SEARCH>
+          Search parameter for both keys and values. Prefix it with `0x` to search for binary data, and text otherwise.
+          
+          ATTENTION! For compressed tables (`Transactions` and `Receipts`), there might be missing results since the search uses the raw uncompressed value from the database.
+
+      --min-row-size <MIN_ROW_SIZE>
+          Minimum size of row in bytes
+          
+          [default: 0]
+
+      --min-key-size <MIN_KEY_SIZE>
+          Minimum size of key in bytes
+          
+          [default: 0]
+
+      --min-value-size <MIN_VALUE_SIZE>
+          Minimum size of value in bytes
+          
+          [default: 0]
+
+  -c, --count
+          Returns the number of rows found
+
+  -j, --json
+          Dump as JSON instead of using TUI
+
+      --raw
+          Output bytes instead of human-readable decoded value
+
+      --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]
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+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
+```