Difference between revisions of "Lighthouse --help"
Jump to navigation
Jump to search
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[lighthouse]] --help | [[lighthouse]] --help | ||
| + | [[lighthouse --version]] | ||
| + | [[lighthouse validator_client --help]] | ||
| + | [[lighthouse beacon_node --help]] | ||
== Lighthouse v3.0.0 == | == Lighthouse v3.0.0 == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | USAGE: | + | lighthouse --help |
| − | + | Lighthouse v3.0.0 | |
| − | + | Sigma Prime <[email protected]> | |
| − | FLAGS: | + | Ethereum 2.0 client by Sigma Prime. Provides a full-featured beacon node, a validator client and utilities for managing |
| − | + | validator accounts. | |
| − | + | ||
| − | + | USAGE: | |
| − | + | lighthouse [FLAGS] [OPTIONS] [SUBCOMMAND] | |
| − | + | ||
| − | + | FLAGS: | |
| − | + | --disable-malloc-tuning If present, do not configure the system allocator. Providing this flag will generally | |
| − | + | increase memory usage, it should only be provided when debugging specific memory | |
| − | + | allocation issues. | |
| − | + | -l Enables environment logging giving access to sub-protocol logs such as discv5 and | |
| − | OPTIONS: | + | libp2p |
| − | + | -h, --help Prints help information | |
| − | + | --logfile-compress If present, compress old log files. This can help reduce the space needed to store | |
| − | + | old logs. | |
| − | + | -V, --version Prints version information | |
| − | + | ||
| − | + | OPTIONS: | |
| − | + | -d, --datadir <DIR> | |
| − | + | Used to specify a custom root data directory for lighthouse keys and databases. Defaults to | |
| − | + | $HOME/.lighthouse/{network} where network is the value of the `network` flag Note: Users should specify | |
| + | separate custom datadirs for different networks. | ||
| + | --debug-level <LEVEL> | ||
| + | Specifies the verbosity level used when emitting logs to the terminal. [default: info] [possible | ||
| + | values: info, debug, trace, warn, error, crit] | ||
| + | --log-format <FORMAT> | ||
| + | Specifies the log format used when emitting logs to the terminal. [possible values: JSON] | ||
--logfile <FILE> | --logfile <FILE> | ||
| Line 70: | Line 73: | ||
PoW block. Incorrect use of this flag will cause your node to experience a consensus | PoW block. Incorrect use of this flag will cause your node to experience a consensus | ||
failure. Be extremely careful with this flag. | failure. Be extremely careful with this flag. | ||
| − | --terminal-total-difficulty-override <INTEGER> | + | [[--terminal-total-difficulty-override]] <INTEGER> |
| − | Used to coordinate manual overrides to the TERMINAL_TOTAL_DIFFICULTY parameter. Accepts a 256-bit decimal | + | Used to coordinate manual overrides to the [[TERMINAL_TOTAL_DIFFICULTY]] parameter. Accepts a 256-bit decimal |
integer (not a hex value). This flag should only be used if the user has a clear understanding that the | integer (not a hex value). This flag should only be used if the user has a clear understanding that the | ||
broad Ethereum community has elected to override the terminal difficulty. Incorrect use of this flag will | broad Ethereum community has elected to override the terminal difficulty. Incorrect use of this flag will | ||
| Line 80: | Line 83: | ||
if there is no existing database. | if there is no existing database. | ||
| − | SUBCOMMANDS: | + | SUBCOMMANDS: |
account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am, | account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am, | ||
account, account_manager] | account, account_manager] | ||
| Line 95: | Line 98: | ||
validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing | validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing | ||
blocks and attestations). [aliases: v, vc, validator] | blocks and attestations). [aliases: v, vc, validator] | ||
| − | |||
| − | |||
== v2.3.0 == | == v2.3.0 == | ||
Latest revision as of 09:45, 12 July 2023
lighthouse --help lighthouse --version lighthouse validator_client --help lighthouse beacon_node --help
Lighthouse v3.0.0[edit]
lighthouse --help Lighthouse v3.0.0 Sigma Prime <[email protected]> Ethereum 2.0 client by Sigma Prime. Provides a full-featured beacon node, a validator client and utilities for managing validator accounts. USAGE: lighthouse [FLAGS] [OPTIONS] [SUBCOMMAND] FLAGS: --disable-malloc-tuning If present, do not configure the system allocator. Providing this flag will generally increase memory usage, it should only be provided when debugging specific memory allocation issues. -l Enables environment logging giving access to sub-protocol logs such as discv5 and libp2p -h, --help Prints help information --logfile-compress If present, compress old log files. This can help reduce the space needed to store old logs. -V, --version Prints version information OPTIONS: -d, --datadir <DIR> Used to specify a custom root data directory for lighthouse keys and databases. Defaults to $HOME/.lighthouse/{network} where network is the value of the `network` flag Note: Users should specify separate custom datadirs for different networks. --debug-level <LEVEL> Specifies the verbosity level used when emitting logs to the terminal. [default: info] [possible values: info, debug, trace, warn, error, crit] --log-format <FORMAT> Specifies the log format used when emitting logs to the terminal. [possible values: JSON]
--logfile <FILE>
File path where the log file will be stored. Once it grows to the value specified in `--logfile-max-size` a
new log file is generated where future logs are stored. Once the number of log files exceeds the value
specified in `--logfile-max-number` the oldest log file will be overwritten.
--logfile-debug-level <LEVEL>
The verbosity level used when emitting logs to the log file. [default: debug] [possible values:
info, debug, trace, warn, error, crit]
--logfile-max-number <COUNT>
The maximum number of log files that will be stored. If set to 0, background file logging is disabled.
[default: 5]
--logfile-max-size <SIZE>
The maximum size (in MB) each log file can grow to before rotating. If set to 0, background file logging is
disabled. [default: 200]
--network <network>
Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater,
goerli, gnosis, kiln, ropsten, sepolia]
--safe-slots-to-import-optimistically <INTEGER>
Used to coordinate manual overrides of the SAFE_SLOTS_TO_IMPORT_OPTIMISTICALLY parameter. This flag should
only be used if the user has a clear understanding that the broad Ethereum community has elected to override
this parameter in the event of an attack at the PoS transition block. Incorrect use of this flag can cause
your node to possibly accept an invalid chain or sync more slowly. Be extremely careful with this flag.
-s, --spec <DEPRECATED>
This flag is deprecated, it will be disallowed in a future release. This value is now derived from the
--network or --testnet-dir flags.
--terminal-block-hash-epoch-override <EPOCH>
Used to coordinate manual overrides to the TERMINAL_BLOCK_HASH_ACTIVATION_EPOCH parameter. This flag should
only be used if the user has a clear understanding that the broad Ethereum community has elected to override
the terminal PoW block. Incorrect use of this flag will cause your node to experience a consensus
failure. Be extremely careful with this flag.
--terminal-block-hash-override <TERMINAL_BLOCK_HASH>
Used to coordinate manual overrides to the TERMINAL_BLOCK_HASH parameter. This flag should only be used if
the user has a clear understanding that the broad Ethereum community has elected to override the terminal
PoW block. Incorrect use of this flag will cause your node to experience a consensus
failure. Be extremely careful with this flag.
--terminal-total-difficulty-override <INTEGER>
Used to coordinate manual overrides to the TERMINAL_TOTAL_DIFFICULTY parameter. Accepts a 256-bit decimal
integer (not a hex value). This flag should only be used if the user has a clear understanding that the
broad Ethereum community has elected to override the terminal difficulty. Incorrect use of this flag will
cause your node to experience a consensus
failure. Be extremely careful with this flag.
-t, --testnet-dir <DIR>
Path to directory containing eth2_testnet specs. Defaults to a hard-coded Lighthouse testnet. Only effective
if there is no existing database.
SUBCOMMANDS:
account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am,
account, account_manager]
beacon_node The primary component which connects to the Ethereum 2.0 P2P network and downloads, verifies
and stores blocks. Provides a HTTP API for querying the beacon chain and publishing messages
to the network. [aliases: b, bn, beacon]
boot_node Start a special Lighthouse process that only serves as a discv5 boot-node. This process will
*not* import blocks or perform most typical beacon node functions. Instead, it will simply
run the discv5 service and assist nodes on the network to discover each other. This is the
recommended way to provide a network boot-node since it has a reduced attack surface
compared to a full beacon node.
database_manager Manage a beacon node database [aliases: db]
help Prints this message or the help of the given subcommand(s)
validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing
blocks and attestations). [aliases: v, vc, validator]
v2.3.0[edit]
Lighthouse v2.3.0 Sigma Prime <[email protected]> Ethereum 2.0 client by Sigma Prime. Provides a full-featured beacon node, a validator client and utilities for managing validator accounts. USAGE: lighthouse [FLAGS] [OPTIONS] [SUBCOMMAND] FLAGS: --disable-malloc-tuning If present, do not configure the system allocator. Providing this flag will generally increase memory usage, it should only be provided when debugging specific memory allocation issues. -l Enables environment logging giving access to sub-protocol logs such as discv5 and libp2p -h, --help Prints help information --logfile-compress If present, compress old log files. This can help reduce the space needed to store old logs. -V, --version Prints version information OPTIONS: -d, --datadir <DIR> Used to specify a custom root data directory for lighthouse keys and databases. Defaults to $HOME/.lighthouse/{network} where network is the value of the `network` flag Note: Users should specify separate custom datadirs for different networks. --debug-level <LEVEL> Specifies the verbosity level used when emitting logs to the terminal. [default: info] [possible values: info, debug, trace, warn, error, crit] --log-format <FORMAT> Specifies the log format used when emitting logs to the terminal. [possible values: JSON] --logfile <FILE> File path where the log file will be stored. Once it grows to the value specified in `--logfile-max-size` a new log file is generated where future logs are stored. Once the number of log files exceeds the value specified in `--logfile-max-number` the oldest log file will be overwritten. --logfile-debug-level <LEVEL> The verbosity level used when emitting logs to the log file. [default: debug] [possible values: info, debug, trace, warn, error, crit] --logfile-max-number <COUNT> The maximum number of log files that will be stored. If set to 0, background file logging is disabled. [default: 5] --logfile-max-size <SIZE> The maximum size (in MB) each log file can grow to before rotating. If set to 0, background file logging is disabled. [default: 200] --network <network> Name of the Eth2 chain Lighthouse will sync and follow. [possible values: mainnet, prater, gnosis, kiln, ropsten] --safe-slots-to-import-optimistically <INTEGER> Used to coordinate manual overrides of the SAFE_SLOTS_TO_IMPORT_OPTIMISTICALLY parameter. This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override this parameter in the event of an attack at the PoS transition block. Incorrect use of this flag can cause your node to possibly accept an invalid chain or sync more slowly. Be extremely careful with this flag. -s, --spec <DEPRECATED> This flag is deprecated, it will be disallowed in a future release. This value is now derived from the --network or --testnet-dir flags. --terminal-block-hash-epoch-override <EPOCH> Used to coordinate manual overrides to the TERMINAL_BLOCK_HASH_ACTIVATION_EPOCH parameter. This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override the terminal PoW block. Incorrect use of this flag will cause your node to experience a consensus failure. Be extremely careful with this flag. --terminal-block-hash-override <TERMINAL_BLOCK_HASH> Used to coordinate manual overrides to the TERMINAL_BLOCK_HASH parameter. This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override the terminal PoW block. Incorrect use of this flag will cause your node to experience a consensus failure. Be extremely careful with this flag. --terminal-total-difficulty-override <INTEGER> Used to coordinate manual overrides to the TERMINAL_TOTAL_DIFFICULTY parameter. Accepts a 256-bit decimal integer (not a hex value). This flag should only be used if the user has a clear understanding that the broad Ethereum community has elected to override the terminal difficulty. Incorrect use of this flag will cause your node to experience a consensus failure. Be extremely careful with this flag. -t, --testnet-dir <DIR> Path to directory containing eth2_testnet specs. Defaults to a hard-coded Lighthouse testnet. Only effective if there is no existing database. SUBCOMMANDS: account_manager Utilities for generating and managing Ethereum 2.0 accounts. [aliases: a, am, account, account_manager] beacon_node The primary component which connects to the Ethereum 2.0 P2P network and downloads, verifies and stores blocks. Provides a HTTP API for querying the beacon chain and publishing messages to the network. [aliases: b, bn, beacon] boot_node Start a special Lighthouse process that only serves as a discv5 boot-node. This process will *not* import blocks or perform most typical beacon node functions. Instead, it will simply run the discv5 service and assist nodes on the network to discover each other. This is the recommended way to provide a network boot-node since it has a reduced attack surface compared to a full beacon node. database_manager Manage a beacon node database [aliases: db] help Prints this message or the help of the given subcommand(s) validator_client When connected to a beacon node, performs the duties of a staked validator (e.g., proposing blocks and attestations). [aliases: v, vc, validator]
See also[edit]
Advertising:
