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/SUMMARY.md
+++ b/book/SUMMARY.md
@ -1,41 +1,69 @@
 # Reth Book

-1. [Introduction](./intro.md)
-1. [Installation](./installation/installation.md)
-   1. [Pre-Built Binaries](./installation/binaries.md)
-   1. [Docker](./installation/docker.md)
-   1. [Build from Source](./installation/source.md)
-   1. [Build for ARM devices](./installation/build-for-arm-devices.md)
-   1. [Update Priorities](./installation/priorities.md)
-1. [Run a Node](./run/run-a-node.md)
-   1. [Mainnet or official testnets](./run/mainnet.md)
-   1. [OP Stack](./run/optimism.md)
-   1. [Private testnet](./run/private-testnet.md)
-   1. [Metrics](./run/observability.md)
-   1. [Configuring Reth](./run/config.md)
-   1. [Transaction types](./run/transactions.md)
-   1. [Pruning & Full Node](./run/pruning.md)
-   1. [Ports](./run/ports.md)
-   1. [Troubleshooting](./run/troubleshooting.md)
-1. [Interacting with Reth over JSON-RPC](./jsonrpc/intro.md)
-   1. [eth](./jsonrpc/eth.md)
-   1. [web3](./jsonrpc/web3.md)
-   1. [net](./jsonrpc/net.md)
-   1. [txpool](./jsonrpc/txpool.md)
-   1. [debug](./jsonrpc/debug.md)
-   1. [trace](./jsonrpc/trace.md)
-   1. [admin](./jsonrpc/admin.md)
-   1. [rpc](./jsonrpc/rpc.md)
-1. [CLI Reference](./cli/cli.md)
-   1. [reth node](./cli/node.md)
-   1. [reth init](./cli/init.md)
-   1. [reth import](./cli/import.md)
-   1. [reth db](./cli/db.md)
-   1. [reth stage](./cli/stage.md)
-   1. [reth p2p](./cli/p2p.md)
-   1. [reth test-vectors](./cli/test-vectors.md)
-   1. [reth config](./cli/config.md)
-   1. [reth debug](./cli/debug.md)
-   1. [reth recover](./cli/recover.md)
-1. [Developers](./developers/developers.md)
-   1. [Contribute](./developers/contribute.md)
+- [Introduction](./intro.md)
+- [Installation](./installation/installation.md)
+   - [Pre-Built Binaries](./installation/binaries.md)
+   - [Docker](./installation/docker.md)
+   - [Build from Source](./installation/source.md)
+   - [Build for ARM devices](./installation/build-for-arm-devices.md)
+   - [Update Priorities](./installation/priorities.md)
+- [Run a Node](./run/run-a-node.md)
+   - [Mainnet or official testnets](./run/mainnet.md)
+   - [OP Stack](./run/optimism.md)
+   - [Private testnet](./run/private-testnet.md)
+   - [Metrics](./run/observability.md)
+   - [Configuring Reth](./run/config.md)
+   - [Transaction types](./run/transactions.md)
+   - [Pruning & Full Node](./run/pruning.md)
+   - [Ports](./run/ports.md)
+   - [Troubleshooting](./run/troubleshooting.md)
+- [Interacting with Reth over JSON-RPC](./jsonrpc/intro.md)
+   - [eth](./jsonrpc/eth.md)
+   - [web3](./jsonrpc/web3.md)
+   - [net](./jsonrpc/net.md)
+   - [txpool](./jsonrpc/txpool.md)
+   - [debug](./jsonrpc/debug.md)
+   - [trace](./jsonrpc/trace.md)
+   - [admin](./jsonrpc/admin.md)
+   - [rpc](./jsonrpc/rpc.md)
+- [CLI Reference](./cli/cli.md) <!-- CLI_REFERENCE START -->
+  - [`reth`](./cli/reth.md)
+    - [`reth node`](./cli/reth/node.md)
+    - [`reth init`](./cli/reth/init.md)
+    - [`reth import`](./cli/reth/import.md)
+    - [`reth db`](./cli/reth/db.md)
+      - [`reth db stats`](./cli/reth/db/stats.md)
+      - [`reth db list`](./cli/reth/db/list.md)
+      - [`reth db diff`](./cli/reth/db/diff.md)
+      - [`reth db get`](./cli/reth/db/get.md)
+      - [`reth db drop`](./cli/reth/db/drop.md)
+      - [`reth db clear`](./cli/reth/db/clear.md)
+      - [`reth db snapshot`](./cli/reth/db/snapshot.md)
+      - [`reth db version`](./cli/reth/db/version.md)
+      - [`reth db path`](./cli/reth/db/path.md)
+    - [`reth stage`](./cli/reth/stage.md)
+      - [`reth stage run`](./cli/reth/stage/run.md)
+      - [`reth stage drop`](./cli/reth/stage/drop.md)
+      - [`reth stage dump`](./cli/reth/stage/dump.md)
+        - [`reth stage dump execution`](./cli/reth/stage/dump/execution.md)
+        - [`reth stage dump storage-hashing`](./cli/reth/stage/dump/storage-hashing.md)
+        - [`reth stage dump account-hashing`](./cli/reth/stage/dump/account-hashing.md)
+        - [`reth stage dump merkle`](./cli/reth/stage/dump/merkle.md)
+      - [`reth stage unwind`](./cli/reth/stage/unwind.md)
+        - [`reth stage unwind to-block`](./cli/reth/stage/unwind/to-block.md)
+        - [`reth stage unwind num-blocks`](./cli/reth/stage/unwind/num-blocks.md)
+    - [`reth p2p`](./cli/reth/p2p.md)
+      - [`reth p2p header`](./cli/reth/p2p/header.md)
+      - [`reth p2p body`](./cli/reth/p2p/body.md)
+    - [`reth test-vectors`](./cli/reth/test-vectors.md)
+      - [`reth test-vectors tables`](./cli/reth/test-vectors/tables.md)
+    - [`reth config`](./cli/reth/config.md)
+    - [`reth debug`](./cli/reth/debug.md)
+      - [`reth debug execution`](./cli/reth/debug/execution.md)
+      - [`reth debug merkle`](./cli/reth/debug/merkle.md)
+      - [`reth debug in-memory-merkle`](./cli/reth/debug/in-memory-merkle.md)
+      - [`reth debug build-block`](./cli/reth/debug/build-block.md)
+    - [`reth recover`](./cli/reth/recover.md)
+      - [`reth recover storage-tries`](./cli/reth/recover/storage-tries.md)
+- [Developers](./developers/developers.md) <!-- CLI_REFERENCE END -->
+   - [Contribute](./developers/contribute.md)