mirror
/
go-ethereum
mirror of https://github.com/ethereum/go-ethereum
2
0
Fork 1
Code Issues Releases Wiki Activity

update command-line-options

Browse Source
pull/26959/head
Felix Lange 2 years ago
parent d5f9948a8e
commit e3ba8526f7
1 changed files with 589 additions and 217 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 764
      docs/fundamentals/command-line-options.md

764
docs/fundamentals/command-line-options.md
Unescape View File

@ -3,7 +3,15 @@ title: Command-line Options
description: A list of commands for Geth description: A list of commands for Geth
--- ---
Geth is primarily controlled using the command line. Geth is started using the `geth` command. Geth is stopped by pressing `ctrl-c`. There are then many combinations of commands that configure precisely how geth will run. These commands are displayed below. The same information can be obtained at any time from your Geth instance by running: Geth is primarily controlled using the command line. Geth is started using the `geth`
command. It is stopped by pressing `ctrl-c`.
You can configure Geth using command-line options (a.k.a. flags). Geth also has
sub-commands, which can be used to invoke functionality such as the console or blockchain
import/export.
The command-line help listing is reproduced below for your convenience. The same
information can be obtained at any time from your own Geth instance by running:
```sh ```sh
geth --help geth --help
@ -15,13 +23,11 @@ geth --help
NAME: NAME:
geth - the go-ethereum command line interface geth - the go-ethereum command line interface
Copyright 2013-2022 The go-ethereum Authors
USAGE: USAGE:
geth [options] [command] [command options] [arguments...] geth [global options] command [command options] [arguments...]
VERSION: VERSION:
1.10.19-stable-23bee162 1.11.5-unstable-f86913bc-20230315
COMMANDS: COMMANDS:
account Manage accounts account Manage accounts
@ -29,214 +35,580 @@ COMMANDS:
console Start an interactive JavaScript environment console Start an interactive JavaScript environment
db Low level database operations db Low level database operations
dump Dump a specific block from storage dump Dump a specific block from storage
dumpconfig Show configuration values 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-preimages Export the preimage database into an RLP stream
import Import a blockchain file import Import a blockchain file
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 Execute the specified JavaScript files js (DEPRECATED) Execute the specified JavaScript files
license Display license information license Display license information
makecache Generate ethash verification cache (for testing) makecache Generate ethash verification cache (for testing)
makedag Generate ethash mining DAG (for testing) makedag Generate ethash mining DAG (for testing)
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
verkle A set of experimental verkle tree management commands
version Print version numbers version Print version numbers
version-check Checks (online) whether the current version suffers from any known security vulnerabilities version-check Checks (online) for known Geth security vulnerabilities
wallet Manage Ethereum presale wallets wallet Manage Ethereum presale wallets
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
ETHEREUM OPTIONS: GLOBAL OPTIONS:
--config value TOML configuration file ACCOUNT
--datadir.minfreedisk value Minimum free disk space in MB, once reached triggers auto shut down (default = --cache.gc converted to MB, 0 = disabled)
--keystore value Directory for the keystore (default = inside the datadir) --allow-insecure-unlock (default: false)
--usb Enable monitoring and management of USB hardware wallets Allow insecure account unlocking when account-related RPCs are exposed by http
--pcscdpath value Path to the smartcard daemon (pcscd) socket file
--networkid value Explicitly set network id (integer)(For testnets: use --sepolia, --goerli instead) (default: 1) --keystore value
--syncmode value Blockchain sync mode ("snap", "full" or "light") (default: snap) Directory for the keystore (default = inside the datadir)
--exitwhensynced Exits after block synchronisation completes
--gcmode value Blockchain garbage collection mode ("full", "archive") (default: "full") --lightkdf (default: false)
--txlookuplimit value Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain) (default: 2350000) Reduce key-derivation RAM & CPU usage at some expense of KDF strength
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
--identity value Custom node name --password value
--lightkdf Reduce key-derivation RAM & CPU usage at some expense of KDF strength Password file to use for non-interactive password input
--eth.requiredblocks value Comma separated block number-to-hash mappings to require for peering (<number>=<hash>)
--mainnet Ethereum mainnet --pcscdpath value
--goerli Görli network: pre-configured proof-of-authority test network Path to the smartcard daemon (pcscd) socket file
--sepolia Sepolia network: pre-configured proof-of-work test network
--datadir value Data directory for the databases and keystore (default: "~/.ethereum") --signer value
--datadir.ancient value Data directory for ancient chain segments (default = inside chaindata) External signer (url or path to ipc file)
--remotedb value URL for remote database
--unlock value
LIGHT CLIENT OPTIONS: Comma separated list of accounts to unlock
--light.serve value Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100) (default: 0)
--light.ingress value Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited) (default: 0) --usb (default: false)
--light.egress value Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited) (default: 0) Enable monitoring and management of USB hardware wallets
--light.maxpeers value Maximum number of light clients to serve, or light servers to attach to (default: 100)
--ulc.servers value List of trusted ultra-light servers ALIASED (deprecated)
--ulc.fraction value Minimum % of trusted ultra-light servers required to announce a new head (default: 75)
--ulc.onlyannounce Ultra light server sends announcements only --nousb (default: false)
--light.nopruning Disable ancient light chain data pruning Disables monitoring for and managing USB hardware wallets (deprecated)
--light.nosyncserve Enables serving light clients before syncing
--whitelist value
DEVELOPER CHAIN OPTIONS: Comma separated block number-to-hash mappings to enforce (<number>=<hash>)
--dev Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled (deprecated in favor of --eth.requiredblocks)
--dev.period value Block period to use in developer mode (0 = mine only if transaction pending) (default: 0)
--dev.gaslimit value Initial block gas limit (default: 11500000) API AND CONSOLE
ETHASH OPTIONS: --authrpc.addr value (default: "localhost")
--ethash.cachedir value Directory to store the ethash verification caches (default = inside the datadir) Listening address for authenticated APIs
--ethash.cachesinmem value Number of recent ethash caches to keep in memory (16MB each) (default: 2)
--ethash.cachesondisk value Number of recent ethash caches to keep on disk (16MB each) (default: 3) --authrpc.jwtsecret value
--ethash.cacheslockmmap Lock memory maps of recent ethash caches Path to a JWT secret to use for authenticated RPC endpoints
--ethash.dagdir value Directory to store the ethash mining DAGs (default: "~/.ethash")
--ethash.dagsinmem value Number of recent ethash mining DAGs to keep in memory (1+GB each) (default: 1) --authrpc.port value (default: 8551)
--ethash.dagsondisk value Number of recent ethash mining DAGs to keep on disk (1+GB each) (default: 2) Listening port for authenticated APIs
--ethash.dagslockmmap Lock memory maps for recent ethash mining DAGs
--authrpc.vhosts value (default: "localhost")
TRANSACTION POOL OPTIONS: Comma separated list of virtual hostnames from which to accept requests (server
--txpool.locals value Comma separated accounts to treat as locals (no flush, priority inclusion) enforced). Accepts '*' wildcard.
--txpool.nolocals Disables price exemptions for locally submitted transactions
--txpool.journal value Disk journal for local transaction to survive node restarts (default: "transactions.rlp") --exec value
--txpool.rejournal value Time interval to regenerate the local transaction journal (default: 1h0m0s) Execute JavaScript statement
--txpool.pricelimit value Minimum gas price limit to enforce for acceptance into the pool (default: 1)
--txpool.pricebump value Price bump percentage to replace an already existing transaction (default: 10) --graphql (default: false)
--txpool.accountslots value Minimum number of executable transaction slots guaranteed per account (default: 16) Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if
--txpool.globalslots value Maximum number of executable transaction slots for all accounts (default: 5120) an HTTP server is started as well.
--txpool.accountqueue value Maximum number of non-executable transaction slots permitted per account (default: 64)
--txpool.globalqueue value Maximum number of non-executable transaction slots for all accounts (default: 1024) --graphql.corsdomain value
--txpool.lifetime value Maximum amount of time non-executable transaction are queued (default: 3h0m0s) Comma separated list of domains from which to accept cross origin requests
(browser enforced)
PERFORMANCE TUNING OPTIONS:
--cache value Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode) (default: 1024) --graphql.vhosts value (default: "localhost")
--cache.database value Percentage of cache memory allowance to use for database io (default: 50) Comma separated list of virtual hostnames from which to accept requests (server
--cache.trie value Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode) (default: 15) enforced). Accepts '*' wildcard.
--cache.trie.journal value Disk journal directory for trie cache to survive node restarts (default: "triecache")
--cache.trie.rejournal value Time interval to regenerate the trie cache journal (default: 1h0m0s) --header value, -H value
--cache.gc value Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode) (default: 25) Pass custom headers to the RPC server when using --remotedb or the geth attach
--cache.snapshot value Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode) (default: 10) console. This flag can be given multiple times.
--cache.noprefetch Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)
--cache.preimages Enable recording the SHA3/keccak preimages of trie keys --http (default: false)
--fdlimit value Raise the open file descriptor resource limit (default = system fd limit) (default: 0) Enable the HTTP-RPC server
ACCOUNT OPTIONS: --http.addr value (default: "localhost")
--unlock value Comma separated list of accounts to unlock HTTP-RPC server listening interface
--password value Password file to use for non-interactive password input
--signer value External signer (url or path to ipc file) --http.api value
--allow-insecure-unlock Allow insecure account unlocking when account-related RPCs are exposed by http API's offered over the HTTP-RPC interface
API AND CONSOLE OPTIONS: --http.corsdomain value
--ipcdisable Disable the IPC-RPC server Comma separated list of domains from which to accept cross origin requests
--ipcpath value Filename for IPC socket/pipe within the datadir (explicit paths escape it) (browser enforced)
--http Enable the HTTP-RPC server
--http.addr value HTTP-RPC server listening interface (default: "localhost") --http.port value (default: 8545)
--http.port value HTTP-RPC server listening port (default: 8545) HTTP-RPC server listening port
--http.api value API's offered over the HTTP-RPC interface
--http.rpcprefix value HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths. --http.rpcprefix value
--http.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all
--http.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost") paths.
--ws Enable the WS-RPC server
--ws.addr value WS-RPC server listening interface (default: "localhost") --http.vhosts value (default: "localhost")
--ws.port value WS-RPC server listening port (default: 8546) Comma separated list of virtual hostnames from which to accept requests (server
--ws.api value API's offered over the WS-RPC interface enforced). Accepts '*' wildcard.
--ws.rpcprefix value HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
--ws.origins value Origins from which to accept websockets requests --ipcdisable (default: false)
--authrpc.jwtsecret value Path to a JWT secret to use for authenticated RPC endpoints Disable the IPC-RPC server
--authrpc.addr value Listening address for authenticated APIs (default: "localhost")
--authrpc.port value Listening port for authenticated APIs (default: 8551) --ipcpath value
--authrpc.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost") Filename for IPC socket/pipe within the datadir (explicit paths escape it)
--graphql Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
--graphql.corsdomain value Comma separated list of domains from which to accept cross origin requests (browser enforced) --jspath value (default: .)
--graphql.vhosts value Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: "localhost") JavaScript root path for `loadScript`
--rpc.gascap value Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) (default: 50000000)
--rpc.evmtimeout value Sets a timeout used for eth_call (0=infinite) (default: 5s) --preload value
--rpc.txfeecap value Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap) (default: 1) Comma separated list of JavaScript files to preload into the console
--rpc.allow-unprotected-txs Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC
--jspath loadScript JavaScript root path for loadScript (default: ".") --rpc.allow-unprotected-txs (default: false)
--exec value Execute JavaScript statement Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC
--preload value Comma separated list of JavaScript files to preload into the console
--rpc.enabledeprecatedpersonal (default: false)
NETWORKING OPTIONS: Enables the (deprecated) personal namespace
--bootnodes value Comma separated enode URLs for P2P discovery bootstrap
--discovery.dns value Sets DNS discovery entry points (use "" to disable DNS) --rpc.evmtimeout value (default: 5s)
--port value Network listening port (default: 30303) Sets a timeout used for eth_call (0=infinite)
--maxpeers value Maximum number of network peers (network disabled if set to 0) (default: 50)
--maxpendpeers value Maximum number of pending connection attempts (defaults used if set to 0) (default: 0) --rpc.gascap value (default: 50000000)
--nat value NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>) (default: "any") Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)
--nodiscover Disables the peer discovery mechanism (manual peer addition)
--v5disc Enables the experimental RLPx V5 (Topic Discovery) mechanism --rpc.txfeecap value (default: 1)
--netrestrict value Restricts network communication to the given IP networks (CIDR masks) Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 =
--nodekey value P2P node key file no cap)
--nodekeyhex value P2P node key as hex (for testing)
--ws (default: false)
MINER OPTIONS: Enable the WS-RPC server
--mine Enable mining
--miner.threads value Number of CPU threads to use for mining (default: 0) --ws.addr value (default: "localhost")
--miner.notify value Comma separated HTTP URL list to notify of new work packages WS-RPC server listening interface
--miner.notify.full Notify with pending block headers instead of work packages
--miner.gasprice value Minimum gas price for mining a transaction (default: 1000000000) --ws.api value
--miner.gaslimit value Target gas ceiling for mined blocks (default: 30000000) API's offered over the WS-RPC interface
--miner.etherbase value Public address for block mining rewards (default = first account) (default: "0")
--miner.extradata value Block extra data set by the miner (default = client version) --ws.origins value
--miner.recommit value Time interval to recreate the block being mined (default: 3s) Origins from which to accept websockets requests
--miner.noverify Disable remote sealing verification
--ws.port value (default: 8546)
GAS PRICE ORACLE OPTIONS: WS-RPC server listening port
--gpo.blocks value Number of recent blocks to check for gas prices (default: 20)
--gpo.percentile value Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60) --ws.rpcprefix value
--gpo.maxprice value Maximum transaction priority fee (or gasprice before London fork) to be recommended by gpo (default: 500000000000) HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
--gpo.ignoreprice value Gas price below which gpo will ignore transactions (default: 2)
DEVELOPER CHAIN
VIRTUAL MACHINE OPTIONS:
--vmdebug Record information useful for VM and contract debugging --dev (default: false)
Ephemeral proof-of-authority network with a pre-funded developer account, mining
LOGGING AND DEBUGGING OPTIONS: enabled
--fakepow Disables proof-of-work verification
--nocompaction Disables db compaction after import --dev.gaslimit value (default: 11500000)
--verbosity value Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail (default: 3) Initial block gas limit
--vmodule value Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)
--log.json Format logs with JSON --dev.period value (default: 0)
--log.backtrace value Request a stack trace at a specific logging statement (e.g. "block.go:271") Block period to use in developer mode (0 = mine only if transaction pending)
--log.debug Prepends log messages with call-site location (file and line number)
--pprof Enable the pprof HTTP server ETHASH
--pprof.addr value pprof HTTP server listening interface (default: "127.0.0.1")
--pprof.port value pprof HTTP server listening port (default: 6060) --ethash.cachedir value
--pprof.memprofilerate value Turn on memory profiling with the given rate (default: 524288) Directory to store the ethash verification caches (default = inside the datadir)
--pprof.blockprofilerate value Turn on block profiling with the given rate (default: 0)
--pprof.cpuprofile value Write CPU profile to the given file --ethash.cachesinmem value (default: 2)
--trace value Write execution trace to the given file Number of recent ethash caches to keep in memory (16MB each)
METRICS AND STATS OPTIONS: --ethash.cacheslockmmap (default: false)
--metrics Enable metrics collection and reporting Lock memory maps of recent ethash caches
--metrics.expensive Enable expensive metrics collection and reporting
--metrics.addr value Enable stand-alone metrics HTTP server listening interface (default: "127.0.0.1") --ethash.cachesondisk value (default: 3)
--metrics.port value Metrics HTTP server listening port (default: 6060) Number of recent ethash caches to keep on disk (16MB each)
--metrics.influxdb Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.endpoint value InfluxDB API endpoint to report metrics to (default: "http://localhost:8086") --ethash.dagdir value (default: /Users/fjl/Library/Ethash)
--metrics.influxdb.database value InfluxDB database name to push reported metrics to (default: "geth") Directory to store the ethash mining DAGs
--metrics.influxdb.username value Username to authorize access to the database (default: "test")
--metrics.influxdb.password value Password to authorize access to the database (default: "test") --ethash.dagsinmem value (default: 1)
--metrics.influxdb.tags value Comma-separated InfluxDB tags (key/values) attached to all measurements (default: "host=localhost") Number of recent ethash mining DAGs to keep in memory (1+GB each)
--metrics.influxdbv2 Enable metrics export/push to an external InfluxDB v2 database
--metrics.influxdb.token value Token to authorize access to the database (v2 only) (default: "test") --ethash.dagslockmmap (default: false)
--metrics.influxdb.bucket value InfluxDB bucket name to push reported metrics to (v2 only) (default: "geth") Lock memory maps for recent ethash mining DAGs
--metrics.influxdb.organization value InfluxDB organization name (v2 only) (default: "geth")
--ethash.dagsondisk value (default: 2)
ALIASED (deprecated) OPTIONS: Number of recent ethash mining DAGs to keep on disk (1+GB each)
--nousb Disables monitoring for and managing USB hardware wallets (deprecated)
--whitelist value Comma separated block number-to-hash mappings to enforce (<number>=<hash>) (deprecated in favor of --eth.requiredblocks) ETHEREUM
MISC OPTIONS: --bloomfilter.size value (default: 2048)
--snapshot Enables snapshot-database mode (default = enable) Megabytes of memory allocated to bloom-filter for pruning
--bloomfilter.size value Megabytes of memory allocated to bloom-filter for pruning (default: 2048)
--ignore-legacy-receipts Geth will start up even if there are legacy receipts in freezer --config value
--help, -h show help TOML configuration file
--override.grayglacier value Manually specify Gray Glacier fork-block, overriding the bundled setting (default: 0)
--override.terminaltotaldifficulty value Manually specify TerminalTotalDifficulty, overriding the bundled setting (default: <nil>) --datadir value (default: /Users/fjl/Library/Ethereum)
Data directory for the databases and keystore
--datadir.ancient value
Root directory for ancient data (default = inside chaindata)
--datadir.minfreedisk value
Minimum free disk space in MB, once reached triggers auto shut down (default =
--cache.gc converted to MB, 0 = disabled)
--db.engine value (default: "leveldb")
Backing database implementation to use ('leveldb' or 'pebble')
--eth.requiredblocks value
Comma separated block number-to-hash mappings to require for peering
(<number>=<hash>)
--exitwhensynced (default: false)
Exits after block synchronisation completes
--gcmode value (default: "full")
Blockchain garbage collection mode ("full", "archive")
--goerli (default: false)
Görli network: pre-configured proof-of-authority test network
--mainnet (default: false)
Ethereum mainnet
--networkid value (default: 1)
Explicitly set network id (integer)(For testnets: use --rinkeby, --goerli,
--sepolia instead)
--override.shanghai value (default: 0)
Manually specify the Shanghai fork timestamp, overriding the bundled setting
--rinkeby (default: false)
Rinkeby network: pre-configured proof-of-authority test network
--sepolia (default: false)
Sepolia network: pre-configured proof-of-work test network
--snapshot (default: true)
Enables snapshot-database mode (default = enable)
--syncmode value (default: snap)
Blockchain sync mode ("snap", "full" or "light")
--txlookuplimit value (default: 2350000)
Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain)
GAS PRICE ORACLE
--gpo.blocks value (default: 20)
Number of recent blocks to check for gas prices
--gpo.ignoreprice value (default: 2)
Gas price below which gpo will ignore transactions
--gpo.maxprice value (default: 500000000000)
Maximum transaction priority fee (or gasprice before London fork) to be
recommended by gpo
--gpo.percentile value (default: 60)
Suggested gas price is the given percentile of a set of recent transaction gas
prices
LIGHT CLIENT
--light.egress value (default: 0)
Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited)
--light.ingress value (default: 0)
Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited)
--light.maxpeers value (default: 100)
Maximum number of light clients to serve, or light servers to attach to
--light.nopruning (default: false)
Disable ancient light chain data pruning
--light.nosyncserve (default: false)
Enables serving light clients before syncing
--light.serve value (default: 0)
Maximum percentage of time allowed for serving LES requests (multi-threaded
processing allows values over 100)
--ulc.fraction value (default: 75)
Minimum % of trusted ultra-light servers required to announce a new head
--ulc.onlyannounce (default: false)
Ultra light server sends announcements only
--ulc.servers value
List of trusted ultra-light servers
LOGGING AND DEBUGGING
--fakepow (default: false)
Disables proof-of-work verification
--log.backtrace value
Request a stack trace at a specific logging statement (e.g. "block.go:271")
--log.debug (default: false)
Prepends log messages with call-site location (file and line number)
--log.file value
Write logs to a file
--log.json (default: false)
Format logs with JSON
--nocompaction (default: false)
Disables db compaction after import
--pprof (default: false)
Enable the pprof HTTP server
--pprof.addr value (default: "127.0.0.1")
pprof HTTP server listening interface
--pprof.blockprofilerate value (default: 0)
Turn on block profiling with the given rate
--pprof.cpuprofile value
Write CPU profile to the given file
--pprof.memprofilerate value (default: 524288)
Turn on memory profiling with the given rate
--pprof.port value (default: 6060)
pprof HTTP server listening port
--remotedb value
URL for remote database
--trace value
Write execution trace to the given file
--verbosity value (default: 3)
Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail
--vmodule value
Per-module verbosity: comma-separated list of <pattern>=<level> (e.g.
eth/*=5,p2p=4)
METRICS AND STATS
--ethstats value
Reporting URL of a ethstats service (nodename:secret@host:port)
--metrics (default: false)
Enable metrics collection and reporting
--metrics.addr value
Enable stand-alone metrics HTTP server listening interface.
--metrics.expensive (default: false)
Enable expensive metrics collection and reporting
--metrics.influxdb (default: false)
Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.bucket value (default: "geth")
InfluxDB bucket name to push reported metrics to (v2 only)
--metrics.influxdb.database value (default: "geth")
InfluxDB database name to push reported metrics to
--metrics.influxdb.endpoint value (default: "http://localhost:8086")
InfluxDB API endpoint to report metrics to
--metrics.influxdb.organization value (default: "geth")
InfluxDB organization name (v2 only)
--metrics.influxdb.password value (default: "test")
Password to authorize access to the database
--metrics.influxdb.tags value (default: "host=localhost")
Comma-separated InfluxDB tags (key/values) attached to all measurements
--metrics.influxdb.token value (default: "test")
Token to authorize access to the database (v2 only)
--metrics.influxdb.username value (default: "test")
Username to authorize access to the database
--metrics.influxdbv2 (default: false)
Enable metrics export/push to an external InfluxDB v2 database
--metrics.port value (default: 6060)
Metrics HTTP server listening port.
Please note that --metrics.addr must be set
to start the server.
MINER
--mine (default: false)
Enable mining
--miner.etherbase value
0x prefixed public address for block mining rewards
--miner.extradata value
Block extra data set by the miner (default = client version)
--miner.gaslimit value (default: 30000000)
Target gas ceiling for mined blocks
--miner.gasprice value (default: 0)
Minimum gas price for mining a transaction
--miner.newpayload-timeout value (default: 2s)
Specify the maximum time allowance for creating a new payload
--miner.notify value
Comma separated HTTP URL list to notify of new work packages
--miner.notify.full (default: false)
Notify with pending block headers instead of work packages
--miner.noverify (default: false)
Disable remote sealing verification
--miner.recommit value (default: 2s)
Time interval to recreate the block being mined
--miner.threads value (default: 0)
Number of CPU threads to use for mining
MISC
--help, -h (default: false)
show help
--synctarget value
File for containing the hex-encoded block-rlp as sync target(dev feature)
--version, -v (default: false)
print the version
NETWORKING
--bootnodes value
Comma separated enode URLs for P2P discovery bootstrap
--discovery.dns value
Sets DNS discovery entry points (use "" to disable DNS)
--discovery.port value (default: 30303)
Use a custom UDP port for P2P discovery
--identity value
Custom node name
--maxpeers value (default: 50)
Maximum number of network peers (network disabled if set to 0)
--maxpendpeers value (default: 0)
Maximum number of pending connection attempts (defaults used if set to 0)
--nat value (default: "any")
NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>)
--netrestrict value
Restricts network communication to the given IP networks (CIDR masks)
--nodekey value
P2P node key file
--nodekeyhex value
P2P node key as hex (for testing)
--nodiscover (default: false)
Disables the peer discovery mechanism (manual peer addition)
--port value (default: 30303)
Network listening port
--v5disc (default: false)
Enables the experimental RLPx V5 (Topic Discovery) mechanism
PERFORMANCE TUNING
--cache value (default: 1024)
Megabytes of memory allocated to internal caching (default = 4096 mainnet full
node, 128 light mode)
--cache.blocklogs value (default: 32)
Size (in number of blocks) of the log cache for filtering
--cache.database value (default: 50)
Percentage of cache memory allowance to use for database io
--cache.gc value (default: 25)
Percentage of cache memory allowance to use for trie pruning (default = 25% full
mode, 0% archive mode)
--cache.noprefetch (default: false)
Disable heuristic state prefetch during block import (less CPU and disk IO, more
time waiting for data)
--cache.preimages (default: false)
Enable recording the SHA3/keccak preimages of trie keys
--cache.snapshot value (default: 10)
Percentage of cache memory allowance to use for snapshot caching (default = 10%
full mode, 20% archive mode)
--cache.trie value (default: 15)
Percentage of cache memory allowance to use for trie caching (default = 15% full
mode, 30% archive mode)
--cache.trie.journal value (default: "triecache")
Disk journal directory for trie cache to survive node restarts
--cache.trie.rejournal value (default: 1h0m0s)
Time interval to regenerate the trie cache journal
--fdlimit value (default: 0)
Raise the open file descriptor resource limit (default = system fd limit)
TRANSACTION POOL
--txpool.accountqueue value (default: 64)
Maximum number of non-executable transaction slots permitted per account
--txpool.accountslots value (default: 16)
Minimum number of executable transaction slots guaranteed per account
--txpool.globalqueue value (default: 1024)
Maximum number of non-executable transaction slots for all accounts
--txpool.globalslots value (default: 5120)
Maximum number of executable transaction slots for all accounts
--txpool.journal value (default: "transactions.rlp")
Disk journal for local transaction to survive node restarts
--txpool.lifetime value (default: 3h0m0s)
Maximum amount of time non-executable transaction are queued
--txpool.locals value
Comma separated accounts to treat as locals (no flush, priority inclusion)
--txpool.nolocals (default: false)
Disables price exemptions for locally submitted transactions
--txpool.pricebump value (default: 10)
Price bump percentage to replace an already existing transaction
--txpool.pricelimit value (default: 1)
Minimum gas price limit to enforce for acceptance into the pool
--txpool.rejournal value (default: 1h0m0s)
Time interval to regenerate the local transaction journal
VIRTUAL MACHINE
--vmdebug (default: false)
Record information useful for VM and contract debugging
COPYRIGHT: COPYRIGHT:
Copyright 2013-2022 The go-ethereum Authors Copyright 2013-2023 The go-ethereum Authors
``` ```

Write Preview
Loading…
Cancel
Save