forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-05-18 22:09:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: update CLI options from latest geth --help output (#31835)

Browse source 
Replaced outdated command-line options documentation with the latest
stable output from `geth --help` to reflect current Geth usage. This
ensures accuracy for users referencing CLI flags.
This commit is contained in:
Dlordkendex 2025-05-16 09:11:25 +01:00 committed by GitHub
parent 24e04b3eb7
commit 391d117f19
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 286 additions and 241 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

527
docs/fundamentals/command-line-options.md
View file

@ -24,10 +24,10 @@ NAME:
geth - the go-ethereum command line interface geth - the go-ethereum command line interface
USAGE: USAGE:
geth [global options] command [command options] [arguments...] geth [global options] command [command options]
VERSION: VERSION:
1.13.1-stable-3f40e65c 1.15.11-stable-36b2371c
COMMANDS: COMMANDS:
account Manage accounts account Manage accounts
@ -38,12 +38,14 @@ COMMANDS:
dumpconfig Export configuration values in a TOML format dumpconfig Export configuration values in a TOML format
dumpgenesis Dumps genesis block JSON configuration to stdout dumpgenesis Dumps genesis block JSON configuration to stdout
export Export blockchain into file export Export blockchain into file
export-preimages Export the preimage database into an RLP stream export-history Export blockchain history to Era archives
import Import a blockchain file import Import a blockchain file
import-history Import an Era archive
import-preimages Import the preimage database from an RLP stream import-preimages Import the preimage database from an RLP stream
init Bootstrap and initialize a new genesis block init Bootstrap and initialize a new genesis block
js (DEPRECATED) Execute the specified JavaScript files js (DEPRECATED) Execute the specified JavaScript files
license Display license information license Display license information
prune-history Prune blockchain history (block bodies and receipts) up to the merge block
removedb Remove blockchain and state databases removedb Remove blockchain and state databases
show-deprecated-flags Show flags that have been deprecated show-deprecated-flags Show flags that have been deprecated
snapshot A set of commands based on the snapshot snapshot A set of commands based on the snapshot
@ -54,386 +56,414 @@ COMMANDS:
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
GLOBAL OPTIONS: GLOBAL OPTIONS:
--log.rotate (default: false) ($GETH_LOG_ROTATE)
Enables log file rotation
ACCOUNT ACCOUNT
--allow-insecure-unlock (default: false) ($GETH_ALLOW_INSECURE_UNLOCK)
Allow insecure account unlocking when account-related RPCs are exposed by http
--keystore value ($GETH_KEYSTORE) --keystore value ($GETH_KEYSTORE)
Directory for the keystore (default = inside the datadir) Directory for the keystore (default = inside the datadir)
--lightkdf (default: false) ($GETH_LIGHTKDF) --lightkdf (default: false) ($GETH_LIGHTKDF)
Reduce key-derivation RAM & CPU usage at some expense of KDF strength Reduce key-derivation RAM & CPU usage at some expense of KDF strength
--password value ($GETH_PASSWORD) --password value ($GETH_PASSWORD)
Password file to use for non-interactive password input Password file to use for non-interactive password input
--pcscdpath value (default: "/run/pcscd/pcscd.comm") ($GETH_PCSCDPATH) --pcscdpath value (default: "/run/pcscd/pcscd.comm") ($GETH_PCSCDPATH)
Path to the smartcard daemon (pcscd) socket file Path to the smartcard daemon (pcscd) socket file
--signer value ($GETH_SIGNER) --signer value ($GETH_SIGNER)
External signer (url or path to ipc file) External signer (url or path to ipc file)
--unlock value ($GETH_UNLOCK)
Comma separated list of accounts to unlock
--usb (default: false) ($GETH_USB) --usb (default: false) ($GETH_USB)
Enable monitoring and management of USB hardware wallets Enable monitoring and management of USB hardware wallets
ALIASED (deprecated) ALIASED (deprecated)
--allow-insecure-unlock (default: false) ($GETH_ALLOW_INSECURE_UNLOCK)
Allow insecure account unlocking when account-related RPCs are exposed by http
(deprecated)
--cache.trie.journal value ($GETH_CACHE_TRIE_JOURNAL) --cache.trie.journal value ($GETH_CACHE_TRIE_JOURNAL)
Disk journal directory for trie cache to survive node restarts Disk journal directory for trie cache to survive node restarts
--cache.trie.rejournal value (default: 0s) ($GETH_CACHE_TRIE_REJOURNAL) --cache.trie.rejournal value (default: 0s) ($GETH_CACHE_TRIE_REJOURNAL)
Time interval to regenerate the trie cache journal Time interval to regenerate the trie cache journal
--light.egress value (default: 0) ($GETH_LIGHT_EGRESS)
Outgoing bandwidth limit for serving light clients (deprecated)
--light.ingress value (default: 0) ($GETH_LIGHT_INGRESS)
Incoming bandwidth limit for serving light clients (deprecated)
--light.maxpeers value (default: 0) ($GETH_LIGHT_MAXPEERS)
Maximum number of light clients to serve, or light servers to attach to
(deprecated)
--light.nopruning (default: false) ($GETH_LIGHT_NOPRUNING)
Disable ancient light chain data pruning (deprecated)
--light.nosyncserve (default: false) ($GETH_LIGHT_NOSYNCSERVE)
Enables serving light clients before syncing (deprecated)
--light.serve value (default: 0) ($GETH_LIGHT_SERVE)
Maximum percentage of time allowed for serving LES requests (deprecated)
--log.backtrace value ($GETH_LOG_BACKTRACE)
Request a stack trace at a specific logging statement (deprecated)
--log.debug (default: false) ($GETH_LOG_DEBUG)
Prepends log messages with call-site location (deprecated)
--metrics.expensive (default: false) ($GETH_METRICS_EXPENSIVE)
Enable expensive metrics collection and reporting (deprecated)
--mine (default: false) ($GETH_MINE)
Enable mining (deprecated)
--miner.etherbase value ($GETH_MINER_ETHERBASE)
0x prefixed public address for block mining rewards (deprecated)
--miner.newpayload-timeout value (default: 2s) ($GETH_MINER_NEWPAYLOAD_TIMEOUT)
Specify the maximum time allowance for creating a new payload (deprecated)
--nousb (default: false) ($GETH_NOUSB) --nousb (default: false) ($GETH_NOUSB)
Disables monitoring for and managing USB hardware wallets (deprecated) Disables monitoring for and managing USB hardware wallets (deprecated)
--rpc.enabledeprecatedpersonal (default: false) ($GETH_RPC_ENABLEDEPRECATEDPERSONAL)
This used to enable the 'personal' namespace.
--txlookuplimit value (default: 2350000) ($GETH_TXLOOKUPLIMIT) --txlookuplimit value (default: 2350000) ($GETH_TXLOOKUPLIMIT)
Number of recent blocks to maintain transactions index for (default = about one Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain) (deprecated, use history.transactions instead) year, 0 = entire chain) (deprecated, use history.transactions instead)
--unlock value ($GETH_UNLOCK)
Comma separated list of accounts to unlock (deprecated)
--v5disc (default: false) ($GETH_V5DISC) --v5disc (default: false) ($GETH_V5DISC)
Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use
--discv5 instead) --discv5 instead)
--whitelist value ($GETH_WHITELIST) --whitelist value ($GETH_WHITELIST)
Comma separated block number-to-hash mappings to enforce (<number>=<hash>) Comma separated block number-to-hash mappings to enforce (<number>=<hash>)
(deprecated in favor of --eth.requiredblocks) (deprecated in favor of --eth.requiredblocks)
API AND CONSOLE API AND CONSOLE
--authrpc.addr value (default: "localhost") ($GETH_AUTHRPC_ADDR) --authrpc.addr value (default: "localhost") ($GETH_AUTHRPC_ADDR)
Listening address for authenticated APIs Listening address for authenticated APIs
--authrpc.jwtsecret value ($GETH_AUTHRPC_JWTSECRET) --authrpc.jwtsecret value ($GETH_AUTHRPC_JWTSECRET)
Path to a JWT secret to use for authenticated RPC endpoints Path to a JWT secret to use for authenticated RPC endpoints
--authrpc.port value (default: 8551) ($GETH_AUTHRPC_PORT) --authrpc.port value (default: 8551) ($GETH_AUTHRPC_PORT)
Listening port for authenticated APIs Listening port for authenticated APIs
--authrpc.vhosts value (default: "localhost") ($GETH_AUTHRPC_VHOSTS) --authrpc.vhosts value (default: "localhost") ($GETH_AUTHRPC_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
--exec value ($GETH_EXEC) --exec value ($GETH_EXEC)
Execute JavaScript statement Execute JavaScript statement
--graphql (default: false) ($GETH_GRAPHQL) --graphql (default: false) ($GETH_GRAPHQL)
Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if
an HTTP server is started as well. an HTTP server is started as well.
--graphql.corsdomain value ($GETH_GRAPHQL_CORSDOMAIN) --graphql.corsdomain value ($GETH_GRAPHQL_CORSDOMAIN)
Comma separated list of domains from which to accept cross origin requests Comma separated list of domains from which to accept cross origin requests
(browser enforced) (browser enforced)
--graphql.vhosts value (default: "localhost") ($GETH_GRAPHQL_VHOSTS) --graphql.vhosts value (default: "localhost") ($GETH_GRAPHQL_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
--header value, -H value --header value, -H value ($GETH_HEADER)
Pass custom headers to the RPC server when using --remotedb or the geth attach Pass custom headers to the RPC server when using --remotedb or the geth attach
console. This flag can be given multiple times. console. This flag can be given multiple times.
--http (default: false) ($GETH_HTTP) --http (default: false) ($GETH_HTTP)
Enable the HTTP-RPC server Enable the HTTP-RPC server
--http.addr value (default: "localhost") ($GETH_HTTP_ADDR) --http.addr value (default: "localhost") ($GETH_HTTP_ADDR)
HTTP-RPC server listening interface HTTP-RPC server listening interface
--http.api value ($GETH_HTTP_API) --http.api value ($GETH_HTTP_API)
API's offered over the HTTP-RPC interface API's offered over the HTTP-RPC interface
--http.corsdomain value ($GETH_HTTP_CORSDOMAIN) --http.corsdomain value ($GETH_HTTP_CORSDOMAIN)
Comma separated list of domains from which to accept cross origin requests Comma separated list of domains from which to accept cross origin requests
(browser enforced) (browser enforced)
--http.port value (default: 8545) ($GETH_HTTP_PORT) --http.port value (default: 8545) ($GETH_HTTP_PORT)
HTTP-RPC server listening port HTTP-RPC server listening port
--http.rpcprefix value ($GETH_HTTP_RPCPREFIX) --http.rpcprefix value ($GETH_HTTP_RPCPREFIX)
HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
paths.
--http.vhosts value (default: "localhost") ($GETH_HTTP_VHOSTS) --http.vhosts value (default: "localhost") ($GETH_HTTP_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
--ipcdisable (default: false) ($GETH_IPCDISABLE) --ipcdisable (default: false) ($GETH_IPCDISABLE)
Disable the IPC-RPC server Disable the IPC-RPC server
--ipcpath value ($GETH_IPCPATH) --ipcpath value ($GETH_IPCPATH)
Filename for IPC socket/pipe within the datadir (explicit paths escape it) Filename for IPC socket/pipe within the datadir (explicit paths escape it)
--jspath value (default: .) ($GETH_JSPATH) --jspath value (default: .) ($GETH_JSPATH)
JavaScript root path for `loadScript` JavaScript root path for `loadScript`
--preload value ($GETH_PRELOAD) --preload value ($GETH_PRELOAD)
Comma separated list of JavaScript files to preload into the console Comma separated list of JavaScript files to preload into the console
--rpc.allow-unprotected-txs (default: false) ($GETH_RPC_ALLOW_UNPROTECTED_TXS) --rpc.allow-unprotected-txs (default: false) ($GETH_RPC_ALLOW_UNPROTECTED_TXS)
Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC
--rpc.batch-request-limit value (default: 1000) ($GETH_RPC_BATCH_REQUEST_LIMIT) --rpc.batch-request-limit value (default: 1000) ($GETH_RPC_BATCH_REQUEST_LIMIT)
Maximum number of requests in a batch Maximum number of requests in a batch
--rpc.batch-response-max-size value (default: 25000000) ($GETH_RPC_BATCH_RESPONSE_MAX_SIZE) --rpc.batch-response-max-size value (default: 25000000) ($GETH_RPC_BATCH_RESPONSE_MAX_SIZE)
Maximum number of bytes returned from a batched call Maximum number of bytes returned from a batched call
--rpc.enabledeprecatedpersonal (default: false) ($GETH_RPC_ENABLEDEPRECATEDPERSONAL)
Enables the (deprecated) personal namespace
--rpc.evmtimeout value (default: 5s) ($GETH_RPC_EVMTIMEOUT) --rpc.evmtimeout value (default: 5s) ($GETH_RPC_EVMTIMEOUT)
Sets a timeout used for eth_call (0=infinite) Sets a timeout used for eth_call (0=infinite)
--rpc.gascap value (default: 50000000) ($GETH_RPC_GASCAP) --rpc.gascap value (default: 50000000) ($GETH_RPC_GASCAP)
Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)
--rpc.txfeecap value (default: 1) --rpc.txfeecap value (default: 1) ($GETH_RPC_TXFEECAP)
Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 =
no cap) no cap)
--ws (default: false) ($GETH_WS) --ws (default: false) ($GETH_WS)
Enable the WS-RPC server Enable the WS-RPC server
--ws.addr value (default: "localhost") ($GETH_WS_ADDR) --ws.addr value (default: "localhost") ($GETH_WS_ADDR)
WS-RPC server listening interface WS-RPC server listening interface
--ws.api value ($GETH_WS_API) --ws.api value ($GETH_WS_API)
API's offered over the WS-RPC interface API's offered over the WS-RPC interface
--ws.origins value ($GETH_WS_ORIGINS) --ws.origins value ($GETH_WS_ORIGINS)
Origins from which to accept websockets requests Origins from which to accept websockets requests
--ws.port value (default: 8546) ($GETH_WS_PORT) --ws.port value (default: 8546) ($GETH_WS_PORT)
WS-RPC server listening port WS-RPC server listening port
--ws.rpcprefix value ($GETH_WS_RPCPREFIX) --ws.rpcprefix value ($GETH_WS_RPCPREFIX)
HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths. HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
BEACON CHAIN
--beacon.api value ($GETH_BEACON_API)
Beacon node (CL) light client API URL. This flag can be given multiple times.
--beacon.api.header value ($GETH_BEACON_API_HEADER)
Pass custom HTTP header fields to the remote beacon node API in "key:value"
format. This flag can be given multiple times.
--beacon.checkpoint value ($GETH_BEACON_CHECKPOINT)
Beacon chain weak subjectivity checkpoint block hash
--beacon.checkpoint.file value ($GETH_BEACON_CHECKPOINT_FILE)
Beacon chain weak subjectivity checkpoint import/export file
--beacon.config value ($GETH_BEACON_CONFIG)
Beacon chain config YAML file
--beacon.genesis.gvroot value ($GETH_BEACON_GENESIS_GVROOT)
Beacon chain genesis validators root
--beacon.genesis.time value (default: 0) ($GETH_BEACON_GENESIS_TIME)
Beacon chain genesis time
--beacon.nofilter (default: false) ($GETH_BEACON_NOFILTER)
Disable future slot signature filter
--beacon.threshold value (default: 342) ($GETH_BEACON_THRESHOLD)
Beacon sync committee participation threshold
DEVELOPER CHAIN DEVELOPER CHAIN
--dev (default: false) ($GETH_DEV) --dev (default: false) ($GETH_DEV)
Ephemeral proof-of-authority network with a pre-funded developer account, mining Ephemeral proof-of-authority network with a pre-funded developer account, mining
enabled enabled
--dev.gaslimit value (default: 11500000) ($GETH_DEV_GASLIMIT) --dev.gaslimit value (default: 11500000) ($GETH_DEV_GASLIMIT)
Initial block gas limit Initial block gas limit
--dev.period value (default: 0) ($GETH_DEV_PERIOD) --dev.period value (default: 0) ($GETH_DEV_PERIOD)
Block period to use in developer mode (0 = mine only if transaction pending) Block period to use in developer mode (0 = mine only if transaction pending)
ETHEREUM ETHEREUM
--bloomfilter.size value (default: 2048) ($GETH_BLOOMFILTER_SIZE)
Megabytes of memory allocated to bloom-filter for pruning
--config value ($GETH_CONFIG) --config value ($GETH_CONFIG)
TOML configuration file TOML configuration file
--datadir value (default: /root/.ethereum) ($GETH_DATADIR) --datadir value (default: /root/.ethereum) ($GETH_DATADIR)
Data directory for the databases and keystore Data directory for the databases and keystore
--datadir.ancient value ($GETH_DATADIR_ANCIENT) --datadir.ancient value ($GETH_DATADIR_ANCIENT)
Root directory for ancient data (default = inside chaindata) Root directory for ancient data (default = inside chaindata)
--datadir.minfreedisk value ($GETH_DATADIR_MINFREEDISK) --datadir.minfreedisk value ($GETH_DATADIR_MINFREEDISK)
Minimum free disk space in MB, once reached triggers auto shut down (default = Minimum free disk space in MB, once reached triggers auto shut down (default =
--cache.gc converted to MB, 0 = disabled) --cache.gc converted to MB, 0 = disabled)
--db.engine value ($GETH_DB_ENGINE) --db.engine value ($GETH_DB_ENGINE)
Backing database implementation to use ('pebble' or 'leveldb') Backing database implementation to use ('pebble' or 'leveldb')
--eth.requiredblocks value ($GETH_ETH_REQUIREDBLOCKS) --eth.requiredblocks value ($GETH_ETH_REQUIREDBLOCKS)
Comma separated block number-to-hash mappings to require for peering Comma separated block number-to-hash mappings to require for peering
(<number>=<hash>) (<number>=<hash>)
--exitwhensynced (default: false) ($GETH_EXITWHENSYNCED) --exitwhensynced (default: false) ($GETH_EXITWHENSYNCED)
Exits after block synchronisation completes Exits after block synchronisation completes
--goerli (default: false) ($GETH_GOERLI)
Görli network: pre-configured proof-of-authority test network
--holesky (default: false) ($GETH_HOLESKY) --holesky (default: false) ($GETH_HOLESKY)
Holesky network: pre-configured proof-of-stake test network Holesky network: pre-configured proof-of-stake test network
--hoodi (default: false) ($GETH_HOODI)
Hoodi network: pre-configured proof-of-stake test network
--mainnet (default: false) ($GETH_MAINNET) --mainnet (default: false) ($GETH_MAINNET)
Ethereum mainnet Ethereum mainnet
--networkid value (default: 1) ($GETH_NETWORKID) --networkid value (default: 0) ($GETH_NETWORKID)
Explicitly set network id (integer)(For testnets: use --goerli, --sepolia, Explicitly set network id (integer)(For testnets: use --sepolia, --holesky,
--holesky instead) --hoodi instead)
--override.cancun value (default: 0) ($GETH_OVERRIDE_CANCUN) --override.prague value (default: 0) ($GETH_OVERRIDE_PRAGUE)
Manually specify the Cancun fork timestamp, overriding the bundled setting Manually specify the Prague fork timestamp, overriding the bundled setting
--override.verkle value (default: 0) ($GETH_OVERRIDE_VERKLE) --override.verkle value (default: 0) ($GETH_OVERRIDE_VERKLE)
Manually specify the Verkle fork timestamp, overriding the bundled setting Manually specify the Verkle fork timestamp, overriding the bundled setting
--sepolia (default: false) ($GETH_SEPOLIA) --sepolia (default: false) ($GETH_SEPOLIA)
Sepolia network: pre-configured proof-of-work test network Sepolia network: pre-configured proof-of-work test network
--snapshot (default: true) ($GETH_SNAPSHOT) --snapshot (default: true) ($GETH_SNAPSHOT)
Enables snapshot-database mode (default = enable) Enables snapshot-database mode (default = enable)
GAS PRICE ORACLE GAS PRICE ORACLE
--gpo.blocks value (default: 20) ($GETH_GPO_BLOCKS) --gpo.blocks value (default: 20) ($GETH_GPO_BLOCKS)
Number of recent blocks to check for gas prices Number of recent blocks to check for gas prices
--gpo.ignoreprice value (default: 2) --gpo.ignoreprice value (default: 2) ($GETH_GPO_IGNOREPRICE)
Gas price below which gpo will ignore transactions Gas price below which gpo will ignore transactions
--gpo.maxprice value (default: 500000000000) --gpo.maxprice value (default: 500000000000) ($GETH_GPO_MAXPRICE)
Maximum transaction priority fee (or gasprice before London fork) to be Maximum transaction priority fee (or gasprice before London fork) to be
recommended by gpo recommended by gpo
--gpo.percentile value (default: 60) ($GETH_GPO_PERCENTILE) --gpo.percentile value (default: 60) ($GETH_GPO_PERCENTILE)
Suggested gas price is the given percentile of a set of recent transaction gas Suggested gas price is the given percentile of a set of recent transaction gas
prices prices
LIGHT CLIENT
--light.egress value (default: 0) ($GETH_LIGHT_EGRESS)
Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited)
--light.ingress value (default: 0) ($GETH_LIGHT_INGRESS)
Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited)
--light.maxpeers value (default: 100) ($GETH_LIGHT_MAXPEERS)
Maximum number of light clients to serve, or light servers to attach to
--light.nopruning (default: false) ($GETH_LIGHT_NOPRUNING)
Disable ancient light chain data pruning
--light.nosyncserve (default: false) ($GETH_LIGHT_NOSYNCSERVE)
Enables serving light clients before syncing
--light.serve value (default: 0) ($GETH_LIGHT_SERVE)
Maximum percentage of time allowed for serving LES requests (multi-threaded
processing allows values over 100)
LOGGING AND DEBUGGING LOGGING AND DEBUGGING
--log.backtrace value ($GETH_LOG_BACKTRACE) --go-execution-trace value ($GETH_GO_EXECUTION_TRACE)
Request a stack trace at a specific logging statement (e.g. "block.go:271") Write Go execution trace to the given file
--log.compress (default: false) ($GETH_LOG_COMPRESS) --log.compress (default: false) ($GETH_LOG_COMPRESS)
Compress the log files Compress the log files
--log.debug (default: false) ($GETH_LOG_DEBUG)
Prepends log messages with call-site location (file and line number)
--log.file value ($GETH_LOG_FILE) --log.file value ($GETH_LOG_FILE)
Write logs to a file Write logs to a file
--log.format value ($GETH_LOG_FORMAT) --log.format value ($GETH_LOG_FORMAT)
Log format to use (json|logfmt|terminal) Log format to use (json|logfmt|terminal)
--log.maxage value (default: 30) ($GETH_LOG_MAXAGE) --log.maxage value (default: 30) ($GETH_LOG_MAXAGE)
Maximum number of days to retain a log file Maximum number of days to retain a log file
--log.maxbackups value (default: 10) ($GETH_LOG_MAXBACKUPS) --log.maxbackups value (default: 10) ($GETH_LOG_MAXBACKUPS)
Maximum number of log files to retain Maximum number of log files to retain
--log.maxsize value (default: 100) ($GETH_LOG_MAXSIZE) --log.maxsize value (default: 100) ($GETH_LOG_MAXSIZE)
Maximum size in MBs of a single log file Maximum size in MBs of a single log file
--log.rotate (default: false) ($GETH_LOG_ROTATE)
Enables log file rotation
--log.vmodule value ($GETH_LOG_VMODULE) --log.vmodule value ($GETH_LOG_VMODULE)
Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. Per-module verbosity: comma-separated list of <pattern>=<level> (e.g.
eth/*=5,p2p=4) eth/*=5,p2p=4)
--nocompaction (default: false) ($GETH_NOCOMPACTION)
Disables db compaction after import
--pprof (default: false) ($GETH_PPROF) --pprof (default: false) ($GETH_PPROF)
Enable the pprof HTTP server Enable the pprof HTTP server
--pprof.addr value (default: "127.0.0.1") ($GETH_PPROF_ADDR) --pprof.addr value (default: "127.0.0.1") ($GETH_PPROF_ADDR)
pprof HTTP server listening interface pprof HTTP server listening interface
--pprof.blockprofilerate value (default: 0) ($GETH_PPROF_BLOCKPROFILERATE) --pprof.blockprofilerate value (default: 0) ($GETH_PPROF_BLOCKPROFILERATE)
Turn on block profiling with the given rate Turn on block profiling with the given rate
--pprof.cpuprofile value ($GETH_PPROF_CPUPROFILE) --pprof.cpuprofile value ($GETH_PPROF_CPUPROFILE)
Write CPU profile to the given file Write CPU profile to the given file
--pprof.memprofilerate value (default: 524288) ($GETH_PPROF_MEMPROFILERATE) --pprof.memprofilerate value (default: 524288) ($GETH_PPROF_MEMPROFILERATE)
Turn on memory profiling with the given rate Turn on memory profiling with the given rate
--pprof.port value (default: 6060) ($GETH_PPROF_PORT) --pprof.port value (default: 6060) ($GETH_PPROF_PORT)
pprof HTTP server listening port pprof HTTP server listening port
--remotedb value ($GETH_REMOTEDB) --remotedb value ($GETH_REMOTEDB)
URL for remote database URL for remote database
--trace value ($GETH_TRACE)
Write execution trace to the given file
--verbosity value (default: 3) ($GETH_VERBOSITY) --verbosity value (default: 3) ($GETH_VERBOSITY)
Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail
METRICS AND STATS METRICS AND STATS
--ethstats value ($GETH_ETHSTATS) --ethstats value ($GETH_ETHSTATS)
Reporting URL of a ethstats service (nodename:secret@host:port) Reporting URL of a ethstats service (nodename:secret@host:port)
--metrics (default: false) ($GETH_METRICS) --metrics (default: false) ($GETH_METRICS)
Enable metrics collection and reporting Enable metrics collection and reporting
--metrics.addr value ($GETH_METRICS_ADDR) --metrics.addr value ($GETH_METRICS_ADDR)
Enable stand-alone metrics HTTP server listening interface. Enable stand-alone metrics HTTP server listening interface.
--metrics.expensive (default: false) ($GETH_METRICS_EXPENSIVE)
Enable expensive metrics collection and reporting
--metrics.influxdb (default: false) ($GETH_METRICS_INFLUXDB) --metrics.influxdb (default: false) ($GETH_METRICS_INFLUXDB)
Enable metrics export/push to an external InfluxDB database Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.bucket value (default: "geth") ($GETH_METRICS_INFLUXDB_BUCKET) --metrics.influxdb.bucket value (default: "geth") ($GETH_METRICS_INFLUXDB_BUCKET)
InfluxDB bucket name to push reported metrics to (v2 only) InfluxDB bucket name to push reported metrics to (v2 only)
--metrics.influxdb.database value (default: "geth") ($GETH_METRICS_INFLUXDB_DATABASE) --metrics.influxdb.database value (default: "geth") ($GETH_METRICS_INFLUXDB_DATABASE)
InfluxDB database name to push reported metrics to InfluxDB database name to push reported metrics to
--metrics.influxdb.endpoint value (default: "http://localhost:8086") ($GETH_METRICS_INFLUXDB_ENDPOINT) --metrics.influxdb.endpoint value (default: "http://localhost:8086") ($GETH_METRICS_INFLUXDB_ENDPOINT)
InfluxDB API endpoint to report metrics to InfluxDB API endpoint to report metrics to
--metrics.influxdb.organization value (default: "geth") ($GETH_METRICS_INFLUXDB_ORGANIZATION) --metrics.influxdb.organization value (default: "geth") ($GETH_METRICS_INFLUXDB_ORGANIZATION)
InfluxDB organization name (v2 only) InfluxDB organization name (v2 only)
--metrics.influxdb.password value (default: "test") ($GETH_METRICS_INFLUXDB_PASSWORD) --metrics.influxdb.password value (default: "test") ($GETH_METRICS_INFLUXDB_PASSWORD)
Password to authorize access to the database Password to authorize access to the database
--metrics.influxdb.tags value (default: "host=localhost") ($GETH_METRICS_INFLUXDB_TAGS) --metrics.influxdb.tags value (default: "host=localhost") ($GETH_METRICS_INFLUXDB_TAGS)
Comma-separated InfluxDB tags (key/values) attached to all measurements Comma-separated InfluxDB tags (key/values) attached to all measurements
--metrics.influxdb.token value (default: "test") ($GETH_METRICS_INFLUXDB_TOKEN) --metrics.influxdb.token value (default: "test") ($GETH_METRICS_INFLUXDB_TOKEN)
Token to authorize access to the database (v2 only) Token to authorize access to the database (v2 only)
--metrics.influxdb.username value (default: "test") ($GETH_METRICS_INFLUXDB_USERNAME) --metrics.influxdb.username value (default: "test") ($GETH_METRICS_INFLUXDB_USERNAME)
Username to authorize access to the database Username to authorize access to the database
--metrics.influxdbv2 (default: false) ($GETH_METRICS_INFLUXDBV2) --metrics.influxdbv2 (default: false) ($GETH_METRICS_INFLUXDBV2)
Enable metrics export/push to an external InfluxDB v2 database Enable metrics export/push to an external InfluxDB v2 database
--metrics.port value (default: 6060) ($GETH_METRICS_PORT) --metrics.port value (default: 6060) ($GETH_METRICS_PORT)
Metrics HTTP server listening port. Metrics HTTP server listening port.
Please note that --metrics.addr must be set Please note that --metrics.addr must be set
@ -441,199 +471,214 @@ GLOBAL OPTIONS:
MINER MINER
--mine (default: false) ($GETH_MINE)
Enable mining
--miner.etherbase value ($GETH_MINER_ETHERBASE)
0x prefixed public address for block mining rewards
--miner.extradata value ($GETH_MINER_EXTRADATA) --miner.extradata value ($GETH_MINER_EXTRADATA)
Block extra data set by the miner (default = client version) Block extra data set by the miner (default = client version)
--miner.gaslimit value (default: 30000000) ($GETH_MINER_GASLIMIT) --miner.gaslimit value (default: 36000000) ($GETH_MINER_GASLIMIT)
Target gas ceiling for mined blocks Target gas ceiling for mined blocks
--miner.gasprice value (default: 0) ($GETH_MINER_GASPRICE) --miner.gasprice value (default: 1000000) ($GETH_MINER_GASPRICE)
Minimum gas price for mining a transaction Minimum gas price for mining a transaction
--miner.newpayload-timeout value (default: 2s) ($GETH_MINER_NEWPAYLOAD_TIMEOUT) --miner.pending.feeRecipient value ($GETH_MINER_PENDING_FEERECIPIENT)
Specify the maximum time allowance for creating a new payload 0x prefixed public address for the pending block producer (not used for actual
block production)
--miner.recommit value (default: 2s) ($GETH_MINER_RECOMMIT) --miner.recommit value (default: 2s) ($GETH_MINER_RECOMMIT)
Time interval to recreate the block being mined Time interval to recreate the block being mined
MISC MISC
--help, -h (default: false) --help, -h (default: false)
show help show help
--synctarget value ($GETH_SYNCTARGET) --synctarget value ($GETH_SYNCTARGET)
File for containing the hex-encoded block-rlp as sync target(dev feature) Hash of the block to full sync to (dev testing feature)
--version, -v (default: false) --version, -v (default: false)
print the version print the version
NETWORKING NETWORKING
--bootnodes value ($GETH_BOOTNODES) --bootnodes value ($GETH_BOOTNODES)
Comma separated enode URLs for P2P discovery bootstrap Comma separated enode URLs for P2P discovery bootstrap
--discovery.dns value ($GETH_DISCOVERY_DNS) --discovery.dns value ($GETH_DISCOVERY_DNS)
Sets DNS discovery entry points (use "" to disable DNS) Sets DNS discovery entry points (use "" to disable DNS)
--discovery.port value (default: 30303) ($GETH_DISCOVERY_PORT) --discovery.port value (default: 30303) ($GETH_DISCOVERY_PORT)
Use a custom UDP port for P2P discovery Use a custom UDP port for P2P discovery
--discovery.v4, --discv4 (default: true) ($GETH_DISCOVERY_V4) --discovery.v4, --discv4 (default: true) ($GETH_DISCOVERY_V4)
Enables the V4 discovery mechanism Enables the V4 discovery mechanism
--discovery.v5, --discv5 (default: false) ($GETH_DISCOVERY_V5) --discovery.v5, --discv5 (default: true) ($GETH_DISCOVERY_V5)
Enables the experimental RLPx V5 (Topic Discovery) mechanism Enables the V5 discovery mechanism
--identity value ($GETH_IDENTITY) --identity value ($GETH_IDENTITY)
Custom node name Custom node name
--maxpeers value (default: 50) ($GETH_MAXPEERS) --maxpeers value (default: 50) ($GETH_MAXPEERS)
Maximum number of network peers (network disabled if set to 0) Maximum number of network peers (network disabled if set to 0)
--maxpendpeers value (default: 0) ($GETH_MAXPENDPEERS) --maxpendpeers value (default: 0) ($GETH_MAXPENDPEERS)
Maximum number of pending connection attempts (defaults used if set to 0) Maximum number of pending connection attempts (defaults used if set to 0)
--nat value (default: "any") ($GETH_NAT) --nat value (default: "any") ($GETH_NAT)
NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>) NAT port mapping mechanism
(any|none|upnp|pmp|pmp:<IP>|extip:<IP>|stun:<IP:PORT>)
--netrestrict value ($GETH_NETRESTRICT) --netrestrict value ($GETH_NETRESTRICT)
Restricts network communication to the given IP networks (CIDR masks) Restricts network communication to the given IP networks (CIDR masks)
--nodekey value ($GETH_NODEKEY) --nodekey value ($GETH_NODEKEY)
P2P node key file P2P node key file
--nodekeyhex value ($GETH_NODEKEYHEX) --nodekeyhex value ($GETH_NODEKEYHEX)
P2P node key as hex (for testing) P2P node key as hex (for testing)
--nodiscover (default: false) ($GETH_NODISCOVER) --nodiscover (default: false) ($GETH_NODISCOVER)
Disables the peer discovery mechanism (manual peer addition) Disables the peer discovery mechanism (manual peer addition)
--port value (default: 30303) ($GETH_PORT) --port value (default: 30303) ($GETH_PORT)
Network listening port Network listening port
PERFORMANCE TUNING PERFORMANCE TUNING
--cache value (default: 1024) ($GETH_CACHE) --cache value (default: 1024) ($GETH_CACHE)
Megabytes of memory allocated to internal caching (default = 4096 mainnet full Megabytes of memory allocated to internal caching (default = 4096 mainnet full
node, 128 light mode) node, 128 light mode)
--cache.blocklogs value (default: 32) ($GETH_CACHE_BLOCKLOGS) --cache.blocklogs value (default: 32) ($GETH_CACHE_BLOCKLOGS)
Size (in number of blocks) of the log cache for filtering Size (in number of blocks) of the log cache for filtering
--cache.database value (default: 50) ($GETH_CACHE_DATABASE) --cache.database value (default: 50) ($GETH_CACHE_DATABASE)
Percentage of cache memory allowance to use for database io Percentage of cache memory allowance to use for database io
--cache.gc value (default: 25) ($GETH_CACHE_GC) --cache.gc value (default: 25) ($GETH_CACHE_GC)
Percentage of cache memory allowance to use for trie pruning (default = 25% full Percentage of cache memory allowance to use for trie pruning (default = 25% full
mode, 0% archive mode) mode, 0% archive mode)
--cache.noprefetch (default: false) ($GETH_CACHE_NOPREFETCH) --cache.noprefetch (default: false) ($GETH_CACHE_NOPREFETCH)
Disable heuristic state prefetch during block import (less CPU and disk IO, more Disable heuristic state prefetch during block import (less CPU and disk IO, more
time waiting for data) time waiting for data)
--cache.preimages (default: false) ($GETH_CACHE_PREIMAGES) --cache.preimages (default: false) ($GETH_CACHE_PREIMAGES)
Enable recording the SHA3/keccak preimages of trie keys Enable recording the SHA3/keccak preimages of trie keys
--cache.snapshot value (default: 10) ($GETH_CACHE_SNAPSHOT) --cache.snapshot value (default: 10) ($GETH_CACHE_SNAPSHOT)
Percentage of cache memory allowance to use for snapshot caching (default = 10% Percentage of cache memory allowance to use for snapshot caching (default = 10%
full mode, 20% archive mode) full mode, 20% archive mode)
--cache.trie value (default: 15) ($GETH_CACHE_TRIE) --cache.trie value (default: 15) ($GETH_CACHE_TRIE)
Percentage of cache memory allowance to use for trie caching (default = 15% full Percentage of cache memory allowance to use for trie caching (default = 15% full
mode, 30% archive mode) mode, 30% archive mode)
--crypto.kzg value (default: "gokzg") ($GETH_CRYPTO_KZG) --crypto.kzg value (default: "gokzg") ($GETH_CRYPTO_KZG)
KZG library implementation to use; gokzg (recommended) or ckzg KZG library implementation to use; gokzg (recommended) or ckzg
--fdlimit value (default: 0) ($GETH_FDLIMIT) --fdlimit value (default: 0) ($GETH_FDLIMIT)
Raise the open file descriptor resource limit (default = system fd limit) Raise the open file descriptor resource limit (default = system fd limit)
STATE HISTORY MANAGEMENT STATE HISTORY MANAGEMENT
--gcmode value (default: "full") ($GETH_GCMODE) --gcmode value (default: "full") ($GETH_GCMODE)
Blockchain garbage collection mode, only relevant in state.scheme=hash ("full", Blockchain garbage collection mode, only relevant in state.scheme=hash ("full",
"archive") "archive")
--history.chain value (default: "all") ($GETH_HISTORY_CHAIN)
Blockchain history retention ("all" or "postmerge")
--history.logs value (default: 2350000) ($GETH_HISTORY_LOGS)
Number of recent blocks to maintain log search index for (default = about one
year, 0 = entire chain)
--history.logs.disable (default: false) ($GETH_HISTORY_LOGS_DISABLE)
Do not maintain log search index
--history.logs.export value ($GETH_HISTORY_LOGS_EXPORT)
Export checkpoints to file in go source file format
--history.state value (default: 90000) ($GETH_HISTORY_STATE) --history.state value (default: 90000) ($GETH_HISTORY_STATE)
Number of recent blocks to retain state history for (default = 90,000 blocks, 0 Number of recent blocks to retain state history for, only relevant in
= entire chain) state.scheme=path (default = 90,000 blocks, 0 = entire chain)
--history.transactions value (default: 2350000) ($GETH_HISTORY_TRANSACTIONS) --history.transactions value (default: 2350000) ($GETH_HISTORY_TRANSACTIONS)
Number of recent blocks to maintain transactions index for (default = about one Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain) year, 0 = entire chain)
--state.scheme value (default: "hash") ($GETH_STATE_SCHEME) --state.scheme value ($GETH_STATE_SCHEME)
Scheme to use for storing ethereum state ('hash' or 'path') Scheme to use for storing ethereum state ('hash' or 'path')
--syncmode value (default: snap) ($GETH_SYNCMODE) --syncmode value (default: "snap") ($GETH_SYNCMODE)
Blockchain sync mode ("snap", "full" or "light") Blockchain sync mode ("snap" or "full")
TRANSACTION POOL (BLOB) TRANSACTION POOL (BLOB)
--blobpool.datacap value (default: 10737418240) ($GETH_BLOBPOOL_DATACAP) --blobpool.datacap value (default: 2684354560) ($GETH_BLOBPOOL_DATACAP)
Disk space to allocate for pending blob transactions (soft limit) Disk space to allocate for pending blob transactions (soft limit)
--blobpool.datadir value (default: "blobpool") ($GETH_BLOBPOOL_DATADIR) --blobpool.datadir value (default: "blobpool") ($GETH_BLOBPOOL_DATADIR)
Data directory to store blob transactions in Data directory to store blob transactions in
--blobpool.pricebump value (default: 100) ($GETH_BLOBPOOL_PRICEBUMP) --blobpool.pricebump value (default: 100) ($GETH_BLOBPOOL_PRICEBUMP)
Price bump percentage to replace an already existing blob transaction Price bump percentage to replace an already existing blob transaction
TRANSACTION POOL (EVM) TRANSACTION POOL (EVM)
--txpool.accountqueue value (default: 64) ($GETH_TXPOOL_ACCOUNTQUEUE) --txpool.accountqueue value (default: 64) ($GETH_TXPOOL_ACCOUNTQUEUE)
Maximum number of non-executable transaction slots permitted per account Maximum number of non-executable transaction slots permitted per account
--txpool.accountslots value (default: 16) ($GETH_TXPOOL_ACCOUNTSLOTS) --txpool.accountslots value (default: 16) ($GETH_TXPOOL_ACCOUNTSLOTS)
Minimum number of executable transaction slots guaranteed per account Minimum number of executable transaction slots guaranteed per account
--txpool.globalqueue value (default: 1024) ($GETH_TXPOOL_GLOBALQUEUE) --txpool.globalqueue value (default: 1024) ($GETH_TXPOOL_GLOBALQUEUE)
Maximum number of non-executable transaction slots for all accounts Maximum number of non-executable transaction slots for all accounts
--txpool.globalslots value (default: 5120) ($GETH_TXPOOL_GLOBALSLOTS) --txpool.globalslots value (default: 5120) ($GETH_TXPOOL_GLOBALSLOTS)
Maximum number of executable transaction slots for all accounts Maximum number of executable transaction slots for all accounts
--txpool.journal value (default: "transactions.rlp") ($GETH_TXPOOL_JOURNAL) --txpool.journal value (default: "transactions.rlp") ($GETH_TXPOOL_JOURNAL)
Disk journal for local transaction to survive node restarts Disk journal for local transaction to survive node restarts
--txpool.lifetime value (default: 3h0m0s) ($GETH_TXPOOL_LIFETIME) --txpool.lifetime value (default: 3h0m0s) ($GETH_TXPOOL_LIFETIME)
Maximum amount of time non-executable transaction are queued Maximum amount of time non-executable transaction are queued
--txpool.locals value ($GETH_TXPOOL_LOCALS) --txpool.locals value ($GETH_TXPOOL_LOCALS)
Comma separated accounts to treat as locals (no flush, priority inclusion) Comma separated accounts to treat as locals (no flush, priority inclusion)
--txpool.nolocals (default: false) ($GETH_TXPOOL_NOLOCALS) --txpool.nolocals (default: false) ($GETH_TXPOOL_NOLOCALS)
Disables price exemptions for locally submitted transactions Disables price exemptions for locally submitted transactions
--txpool.pricebump value (default: 10) ($GETH_TXPOOL_PRICEBUMP) --txpool.pricebump value (default: 10) ($GETH_TXPOOL_PRICEBUMP)
Price bump percentage to replace an already existing transaction Price bump percentage to replace an already existing transaction
--txpool.pricelimit value (default: 1) ($GETH_TXPOOL_PRICELIMIT) --txpool.pricelimit value (default: 1) ($GETH_TXPOOL_PRICELIMIT)
Minimum gas price tip to enforce for acceptance into the pool Minimum gas price tip to enforce for acceptance into the pool
--txpool.rejournal value (default: 1h0m0s) ($GETH_TXPOOL_REJOURNAL) --txpool.rejournal value (default: 1h0m0s) ($GETH_TXPOOL_REJOURNAL)
Time interval to regenerate the local transaction journal Time interval to regenerate the local transaction journal
VIRTUAL MACHINE VIRTUAL MACHINE
--vmdebug (default: false) ($GETH_VMDEBUG) --vmdebug (default: false) ($GETH_VMDEBUG)
Record information useful for VM and contract debugging Record information useful for VM and contract debugging
--vmtrace value ($GETH_VMTRACE)
Name of tracer which should record internal VM operations (costly)
--vmtrace.jsonconfig value (default: "{}") ($GETH_VMTRACE_JSONCONFIG)
Tracer configuration (JSON)
COPYRIGHT: COPYRIGHT:
Copyright 2013-2023 The go-ethereum Authors Copyright 2013-2025 The go-ethereum Authors
``` ```