feat(book): update CLI section (#4694)

book/SUMMARY.md

@@ -35,5 +35,6 @@
    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)

book/cli/cli.md

@@ -30,43 +30,64 @@ Reth
 Usage: reth [OPTIONS] <COMMAND>
 
 Commands:
-  node
-          Start the node
-  init
-          Initialize the database from a genesis file
-  import
-          This syncs RLP encoded blocks from a file
-  db
-          Database debugging utilities
-  stage
-          Manipulate individual stages
-  p2p
-          P2P Debugging utilities
-  test-vectors
-          Generate Test Vectors
-  config
-          Write config to stdout
-  debug
-          Various debug routines
-  help
-          Print this message or the help of the given subcommand(s)
+  node          Start the node
+  init          Initialize the database from a genesis file
+  import        This syncs RLP encoded blocks from a file
+  db            Database debugging utilities
+  stage         Manipulate individual stages
+  p2p           P2P Debugging utilities
+  test-vectors  Generate Test Vectors
+  config        Write config to stdout
+  debug         Various debug routines
+  recover       Scripts for node recovery
+  help          Print this message or the help of the given subcommand(s)
 
 Options:
+      --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
+          - goerli
+          - sepolia
+
+          [default: mainnet]
+
+      --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')
 
   -V, --version
           Print version
 
 Logging:
-      --log.persistent
-          The flag to enable persistent logs
-
       --log.directory <PATH>
           The path to put log files in
           
           [default: /reth/logs]
 
+      --log.max-size <SIZE>
+          The maximum size (in MB) of log files
+          
+          [default: 200]
+
+      --log.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.journald
           Log events to journald
 
@@ -75,6 +96,16 @@ Logging:
           
           [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.

book/cli/config.json

@@ -4,14 +4,17 @@
     "db": {
       "stats": [],
       "list": [],
+      "diff": [],
       "get": [],
       "drop": [],
+      "clear": [],
       "version": [],
       "path": []
     },
     "debug": {
       "execution": [],
-      "merkle": []
+      "merkle": [],
+      "in-memory-merkle": []
     },
     "import": [],
     "init": [],
@@ -20,6 +23,9 @@
       "header": [],
       "body": []
     },
+    "recover": {
+      "storage-tries": []
+    },
     "stage": {
       "run": [],
       "drop": [],

book/cli/config.md

@@ -14,18 +14,48 @@ Options:
       --default
           Show the default config
 
+      --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
+          - goerli
+          - sepolia
+
+          [default: mainnet]
+
+      --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.persistent
-          The flag to enable persistent logs
-
       --log.directory <PATH>
           The path to put log files in
           
           [default: /reth/logs]
 
+      --log.max-size <SIZE>
+          The maximum size (in MB) of log files
+          
+          [default: 200]
+
+      --log.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.journald
           Log events to journald
 
@@ -34,6 +64,16 @@ Logging:
           
           [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.