forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-07-19 11:20:45 +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

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

@ -24,10 +24,10 @@ NAME:
geth - the go-ethereum command line interface
USAGE:
geth [global options] command [command options] [arguments...]
geth [global options] command [command options]
VERSION:
1.13.1-stable-3f40e65c
1.15.11-stable-36b2371c
COMMANDS:
account Manage accounts
@ -38,12 +38,14 @@ COMMANDS:
dumpconfig Export configuration values in a TOML format
dumpgenesis Dumps genesis block JSON configuration to stdout
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-history Import an Era archive
import-preimages Import the preimage database from an RLP stream
init Bootstrap and initialize a new genesis block
js (DEPRECATED) Execute the specified JavaScript files
license Display license information
prune-history Prune blockchain history (block bodies and receipts) up to the merge block
removedb Remove blockchain and state databases
show-deprecated-flags Show flags that have been deprecated
snapshot A set of commands based on the snapshot
@ -54,16 +56,9 @@ COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--log.rotate (default: false) ($GETH_LOG_ROTATE)
Enables log file rotation
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)
Directory for the keystore (default = inside the datadir)
@ -79,28 +74,72 @@ GLOBAL OPTIONS:
--signer value ($GETH_SIGNER)
External signer (url or path to ipc file)
--unlock value ($GETH_UNLOCK)
Comma separated list of accounts to unlock
--usb (default: false) ($GETH_USB)
Enable monitoring and management of USB hardware wallets
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)
Disk journal directory for trie cache to survive node restarts
--cache.trie.rejournal value (default: 0s) ($GETH_CACHE_TRIE_REJOURNAL)
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)
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)
Number of recent blocks to maintain transactions index for (default = about one
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)
Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use
--discv5 instead)
@ -140,7 +179,7 @@ GLOBAL OPTIONS:
Comma separated list of virtual hostnames from which to accept requests (server
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
console. This flag can be given multiple times.
@ -161,8 +200,7 @@ GLOBAL OPTIONS:
HTTP-RPC server listening port
--http.rpcprefix value ($GETH_HTTP_RPCPREFIX)
HTTP path 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.
--http.vhosts value (default: "localhost") ($GETH_HTTP_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server
@ -189,16 +227,13 @@ GLOBAL OPTIONS:
--rpc.batch-response-max-size value (default: 25000000) ($GETH_RPC_BATCH_RESPONSE_MAX_SIZE)
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)
Sets a timeout used for eth_call (0=infinite)
--rpc.gascap value (default: 50000000) ($GETH_RPC_GASCAP)
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 =
no cap)
@ -220,6 +255,37 @@ GLOBAL OPTIONS:
--ws.rpcprefix value ($GETH_WS_RPCPREFIX)
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
@ -236,9 +302,6 @@ GLOBAL OPTIONS:
ETHEREUM
--bloomfilter.size value (default: 2048) ($GETH_BLOOMFILTER_SIZE)
Megabytes of memory allocated to bloom-filter for pruning
--config value ($GETH_CONFIG)
TOML configuration file
@ -262,21 +325,21 @@ GLOBAL OPTIONS:
--exitwhensynced (default: false) ($GETH_EXITWHENSYNCED)
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 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)
Ethereum mainnet
--networkid value (default: 1) ($GETH_NETWORKID)
Explicitly set network id (integer)(For testnets: use --goerli, --sepolia,
--holesky instead)
--networkid value (default: 0) ($GETH_NETWORKID)
Explicitly set network id (integer)(For testnets: use --sepolia, --holesky,
--hoodi instead)
--override.cancun value (default: 0) ($GETH_OVERRIDE_CANCUN)
Manually specify the Cancun fork timestamp, overriding the bundled setting
--override.prague value (default: 0) ($GETH_OVERRIDE_PRAGUE)
Manually specify the Prague fork timestamp, overriding the bundled setting
--override.verkle value (default: 0) ($GETH_OVERRIDE_VERKLE)
Manually specify the Verkle fork timestamp, overriding the bundled setting
@ -293,10 +356,10 @@ GLOBAL OPTIONS:
--gpo.blocks value (default: 20) ($GETH_GPO_BLOCKS)
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
--gpo.maxprice value (default: 500000000000)
--gpo.maxprice value (default: 500000000000) ($GETH_GPO_MAXPRICE)
Maximum transaction priority fee (or gasprice before London fork) to be
recommended by gpo
@ -304,42 +367,15 @@ GLOBAL OPTIONS:
Suggested gas price is the given percentile of a set of recent transaction gas
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
--log.backtrace value ($GETH_LOG_BACKTRACE)
Request a stack trace at a specific logging statement (e.g. "block.go:271")
--go-execution-trace value ($GETH_GO_EXECUTION_TRACE)
Write Go execution trace to the given file
--log.compress (default: false) ($GETH_LOG_COMPRESS)
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)
Write logs to a file
@ -355,13 +391,13 @@ GLOBAL OPTIONS:
--log.maxsize value (default: 100) ($GETH_LOG_MAXSIZE)
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)
Per-module verbosity: comma-separated list of <pattern>=<level> (e.g.
eth/*=5,p2p=4)
--nocompaction (default: false) ($GETH_NOCOMPACTION)
Disables db compaction after import
--pprof (default: false) ($GETH_PPROF)
Enable the pprof HTTP server
@ -383,9 +419,6 @@ GLOBAL OPTIONS:
--remotedb value ($GETH_REMOTEDB)
URL for remote database
--trace value ($GETH_TRACE)
Write execution trace to the given file
--verbosity value (default: 3) ($GETH_VERBOSITY)
Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail
@ -401,9 +434,6 @@ GLOBAL OPTIONS:
--metrics.addr value ($GETH_METRICS_ADDR)
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)
Enable metrics export/push to an external InfluxDB database
@ -442,23 +472,18 @@ GLOBAL OPTIONS:
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)
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
--miner.gasprice value (default: 0) ($GETH_MINER_GASPRICE)
--miner.gasprice value (default: 1000000) ($GETH_MINER_GASPRICE)
Minimum gas price for mining a transaction
--miner.newpayload-timeout value (default: 2s) ($GETH_MINER_NEWPAYLOAD_TIMEOUT)
Specify the maximum time allowance for creating a new payload
--miner.pending.feeRecipient value ($GETH_MINER_PENDING_FEERECIPIENT)
0x prefixed public address for the pending block producer (not used for actual
block production)
--miner.recommit value (default: 2s) ($GETH_MINER_RECOMMIT)
Time interval to recreate the block being mined
@ -470,7 +495,7 @@ GLOBAL OPTIONS:
show help
--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)
print the version
@ -490,8 +515,8 @@ GLOBAL OPTIONS:
--discovery.v4, --discv4 (default: true) ($GETH_DISCOVERY_V4)
Enables the V4 discovery mechanism
--discovery.v5, --discv5 (default: false) ($GETH_DISCOVERY_V5)
Enables the experimental RLPx V5 (Topic Discovery) mechanism
--discovery.v5, --discv5 (default: true) ($GETH_DISCOVERY_V5)
Enables the V5 discovery mechanism
--identity value ($GETH_IDENTITY)
Custom node name
@ -503,7 +528,8 @@ GLOBAL OPTIONS:
Maximum number of pending connection attempts (defaults used if set to 0)
--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)
Restricts network communication to the given IP networks (CIDR masks)
@ -565,24 +591,37 @@ GLOBAL OPTIONS:
Blockchain garbage collection mode, only relevant in state.scheme=hash ("full",
"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)
Number of recent blocks to retain state history for (default = 90,000 blocks, 0
= entire chain)
Number of recent blocks to retain state history for, only relevant in
state.scheme=path (default = 90,000 blocks, 0 = entire chain)
--history.transactions value (default: 2350000) ($GETH_HISTORY_TRANSACTIONS)
Number of recent blocks to maintain transactions index for (default = about one
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')
--syncmode value (default: snap) ($GETH_SYNCMODE)
Blockchain sync mode ("snap", "full" or "light")
--syncmode value (default: "snap") ($GETH_SYNCMODE)
Blockchain sync mode ("snap" or "full")
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)
--blobpool.datadir value (default: "blobpool") ($GETH_BLOBPOOL_DATADIR)
@ -633,7 +672,13 @@ GLOBAL OPTIONS:
--vmdebug (default: false) ($GETH_VMDEBUG)
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 2013-2023 The go-ethereum Authors
Copyright 2013-2025 The go-ethereum Authors
```