forked from paradigmxyz/reth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(book): update CLI (paradigmxyz#8093)
- Loading branch information
Showing
3 changed files
with
285 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# reth db checksum | ||
|
||
Calculates the content checksum of a table | ||
|
||
```bash | ||
$ reth db checksum --help | ||
Usage: reth db checksum [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] | ||
|
||
--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] | ||
|
||
--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.stdout.format <FORMAT> | ||
The format to use for logs written to stdout | ||
[default: terminal] | ||
Possible values: | ||
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging | ||
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications | ||
- terminal: Represents terminal-friendly formatting for logs | ||
--log.stdout.filter <FILTER> | ||
The filter to use for logs written to stdout | ||
[default: ] | ||
--log.file.format <FORMAT> | ||
The format to use for logs written to the log file | ||
[default: terminal] | ||
Possible values: | ||
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging | ||
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications | ||
- terminal: Represents terminal-friendly formatting for logs | ||
--log.file.filter <FILTER> | ||
The filter to use for logs written to the log file | ||
[default: debug] | ||
--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.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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
# reth init-state | ||
|
||
Initialize the database from a state dump file | ||
|
||
```bash | ||
$ reth init-state --help | ||
Usage: reth init-state [OPTIONS] | ||
|
||
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] | ||
|
||
--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] | ||
|
||
--state <STATE_DUMP_FILE> | ||
JSONL file with state dump. | ||
|
||
Must contain accounts in following format, additional account fields are ignored. Can | ||
also contain { "root": \<state-root\> } as first line. | ||
{ | ||
"balance": "\<balance\>", | ||
"nonce": \<nonce\>, | ||
"code": "\<bytecode\>", | ||
"storage": { | ||
"\<key\>": "\<value\>", | ||
.. | ||
}, | ||
"address": "\<address\>", | ||
} | ||
|
||
Allows init at a non-genesis block. Caution! Blocks must be manually imported up until | ||
and including the non-genesis block to init chain at. See 'import' command. | ||
|
||
--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') | ||
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 | ||
--db.exclusive <EXCLUSIVE> | ||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume | ||
[possible values: true, false] | ||
Logging: | ||
--log.stdout.format <FORMAT> | ||
The format to use for logs written to stdout | ||
[default: terminal] | ||
Possible values: | ||
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging | ||
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications | ||
- terminal: Represents terminal-friendly formatting for logs | ||
--log.stdout.filter <FILTER> | ||
The filter to use for logs written to stdout | ||
[default: ] | ||
--log.file.format <FORMAT> | ||
The format to use for logs written to the log file | ||
[default: terminal] | ||
Possible values: | ||
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging | ||
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications | ||
- terminal: Represents terminal-friendly formatting for logs | ||
--log.file.filter <FILTER> | ||
The filter to use for logs written to the log file | ||
[default: debug] | ||
--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.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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters