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

This commit is contained in:
Alexey Shekhirin
2023-09-20 22:51:09 +01:00
committed by GitHub
parent b870a4ef01
commit a52b433e65
13 changed files with 672 additions and 1492 deletions

View File

@ -30,28 +30,42 @@ 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')
@ -59,14 +73,21 @@ Options:
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.