besu/docs/Reference/Pantheon-CLI-Syntax.md

description: Pantheon commande line interface reference
<!--- END of page meta data -->

# Pantheon Command Line

!!! important "Breaking Changes in v0.9"
    In v0.9 the command line changed to improve usability. These are breaking changes; that is, 
    in many cases the v0.8 command line options will no longer work. This reference and the rest of 
    the documentation will be updated to reflect these changes. Any further information required 
    about the changes are included in the v0.9 release notes. 

This reference describes the syntax of the Pantheon Command Line Interface (CLI) options and subcommands.

```bash
pantheon [OPTIONS] [COMMAND]
```

Runs the Pantheon Ethereum full node client.

!!!tip
    Use a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md) to save the command line options in a file.

## Options

### accounts-whitelist

```bash tab="Syntax"
--accounts-whitelist[=<hex string of account public key>[,<hex string of account public key>...]...
```

```bash tab="Example"
 --accounts-whitelist=[0xfe3b557e8fb62b89f4916b721be55ceb828dbd73, 0x627306090abaB3A6e1400e9345bC60c78a8BEf57]
```

Comma separated account public keys for permissioned transactions. You can specify an empty list.

!!!note
    Permissioning is under development and will be available in v1.0.

### banned-node-ids

```bash tab="Syntax"
--banned-node-ids=<bannedNodeId>[,<bannedNodeId>...]...
```

```bash tab="Example Command Line"
--banned-nodeids=0xc35c3...d615f,0xf42c13...fc456
```

```bash tab="Example Configuration File"
banned-nodeids=["0xc35c3...d615f","0xf42c13...fc456"]
```

List of node IDs with which this node will not peer. The node ID is the public key of the node. You can specify the banned node IDs with or without the `0x` prefix.
  
!!!info
    This option is only available from v0.8.2. 

!!!tip
    The singular `--banned-node-id` and plural `--banned-node-ids` are available and are just two
    names for the same option.
 
### bootnodes

```bash tab="Syntax"
--bootnodes[=<enode://id@host:port>[,<enode://id@host:port>...]...]
```

```bash tab="Example Command Line"
--bootnodes=enode://c35c3...d615f@1.2.3.4:30303,enode://f42c13...fc456@1.2.3.5:30303
```

```bash tab="Example Configuration File"
bootnodes=["enode://c35c3...d615f@1.2.3.4:30303","enode://f42c13...fc456@1.2.3.5:30303"]
```
  
```bash tab="Example Node Acting as Bootnode"
--bootnodes
```  
  
List of comma-separated enode URLs for P2P discovery bootstrap. 
  
When connecting to MainNet or public testnets, the default is a predefined list of enode URLs. 

On custom networks defined by [`--genesis-file`](#genesis-file) option,
an empty list of bootnodes is defined by default unless you define custom bootnodes as described in 
[private network documentation](../Configuring-Pantheon/Testing-Developing-Nodes.md#bootnodes).

!!! note
    Specifying that a node is a [bootnode](../Configuring-Pantheon/Testing-Developing-Nodes.md#bootnodes) 
    must be done on the command line using [`--bootnodes`](#bootnodes) option without value,
    not in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).  

### config-file

```bash tab="Syntax"
--config-file=<FILE>
```

```bash tab="Example Command Line"
--config-file=/home/me/me_node/config.toml
```

The path to the [TOML configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
The default is `none`.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#custom-configuration-file) or in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
    
### data-path

```bash tab="Syntax"
--data-path=<PATH>
```

```bash tab="Example Command Line"
--data-path=/home/me/me_node
```

```bash tab="Example Configuration File"
data-path="/home/me/me_node"
```

The path to the Pantheon data directory. The default is the `/build/distributions/pantheon-<version>` directory in the Pantheon installation directory.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#persisting-data). 

### genesis-file

Genesis file is used to create a custom network.

!!!tip
    To use a public Ethereum network such as Rinkeby, use the [`--network`](#network) option.
    The network option defines the genesis file for public networks.

```bash tab="Syntax"
--genesis-file=<FILE>
```

```bash tab="Example Command Line"
--genesis-file=/home/me/me_node/customGenesisFile.json
```

```bash tab="Example Configuration File"
genesis-file="/home/me/me_node/customGenesisFile.json"
```

The path to the genesis file.

!!!important
    The [`--genesis-file`](#genesis-file) and [`--network`](#network) option can't be used at the same time.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#custom-genesis-file). 

### host-whitelist

```bash tab="Syntax"
--host-whitelist=<hostname>[,<hostname>...]... or * or all
```

```bash tab="Example Command Line"
--host-whitelist=medomain.com,meotherdomain.com
```

```bash tab="Example Configuration File"
host-whitelist=["medomain.com", "meotherdomain.com"]
```

Comma-separated list of hostnames to allow access to the HTTP JSON-RPC API. Default is `localhost`. 

!!!tip
    To allow all hostnames, use `*` or `all`. We don't recommend allowing all hostnames for production code.

!!!note
    This option is only available from v0.8.3. Earlier versions allow access by all hostnames. 

### max-peers

```bash tab="Syntax"
--max-peers=<INTEGER>
```

```bash tab="Example Command Line"
--max-peers=42
```

```bash tab="Example Configuration File"
max-peers=42
```

Specifies the maximum P2P peer connections that can be established.
The default is 25.

### max-trailing-peers

!!!important
    This option is deprecated in favor of a intelligent default setting and will be removed in 0.9
    release.
    
```bash tab="Syntax"
--max-trailing-peers=<INTEGER>
```

```bash tab="Example Command Line"
--max-trailing-peers=2
```

```bash tab="Example Configuration File"
max-trailing-peers=2
```

Specifies the maximum P2P peer connections for peers that are trailing behind the local chain head. 
The default is unlimited but the number of trailing peers cannot exceed the value specified by [`--max-peers`](#max-peers).

### metrics-enabled

```bash tab="Syntax"
--metrics-enabled
```

```bash tab="Example Configuration File"
metrics-enabled=true
```

Set to `true` to enable the [Prometheus](https://prometheus.io/) monitoring service to access [Pantheon metrics](../Using-Pantheon/Debugging.md#monitor-node-performance-using-third-party-clients).
The default is `false`.

### metrics-host

```bash tab="Syntax"
--metrics-host=<HOST>
```

```bash tab="Example Command Line"
--metrics-host=127.0.0.1
```

```bash tab="Example Configuration File"
metrics-host="127.0.0.1"
```

Specifies the host on which the [Prometheus](https://prometheus.io/) monitoring service accesses Pantheon
metrics. The default is `127.0.0.1`. The metrics server respects the [`--host-whitelist` option](#host-whitelist).

### metrics-port

```bash tab="Syntax"
--metrics-port=<PORT>
```

```bash tab="Example Command Line"
--metrics-port=6174
```

```bash tab="Example Configuration File"
metrics-port="6174"
```

Specifies the port on which the [Prometheus](https://prometheus.io/) monitoring service accesses Pantheon
metrics. The default is `9545`. The metrics server respects the [`--host-whitelist` option](#host-whitelist).

### miner-coinbase

```bash tab="Syntax"
--miner-coinbase=<Ethereum account address>
```

```bash tab="Example Command Line"
--miner-coinbase=fe3b557e8fb62b89f4916b721be55ceb828dbd73
```

```bash tab="Example Configuration File"
--miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
```

Account to which mining rewards are paid.
You must specify a valid coinbase when you enable mining using the [`--miner-enabled`](#miner-enabled) 
option or the [`miner_start`](JSON-RPC-API-Methods.md#miner_start) JSON RPC-API method.

!!!note
    This option is ignored in networks using [Clique](../Consensus-Protocols/Clique.md) and [IBFT 2.0](../Consensus-Protocols/IBFT.md) consensus protocols. 

### miner-enabled

```bash tab="Syntax"
--miner-enabled
```

```bash tab="Example Configuration File"
miner-enabled=true
```

Enables mining when the node is started.
Default is `false`.
  
### miner-extra-data

```bash tab="Syntax"
--miner-extra-data=<Extra data>
```

```bash tab="Example Command Line"
--miner-extra-data=0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021
```

```bash tab="Example Configuration File"
miner-extra-data="0x444F4E27542050414E4943202120484F444C2C20484F444C2C20484F444C2021"
```

A hex string representing the 32 bytes to be included in the extra data field of a mined block.
The default is 0x.

### min-gas-price

```bash tab="Syntax"
--min-gas-price=<minTransactionGasPrice>
```

```bash tab="Example Command Line"
--min-gas-price=1337
```

```bash tab="Example Configuration File"
min-gas-price="1337"
```

The minimum price that a transaction offers for it to be included in a mined block.
The default is 1000.

### network

```bash tab="Syntax"
--network=<NETWORK>
```

```bash tab="Example Command Line"
--network=rinkeby
```

```bash tab="Example Configuration File"
network="rinkeby"
```

Predefined network configuration.
The default is `mainnet`.

Possible values are :

`mainnet`
:   Main Ethereum network

`ropsten`
:   PoW test network similar to current main Ethereum network. 

`rinkeby`
:   PoA test network using Clique.

`goerli`
:   PoA test network using Clique.

`dev`
:   PoW development network with a very low difficulty to enable local CPU mining.

!!!note
    Values are case insensitive, so either `mainnet` or `MAINNET` works.
    
!!!important
    The [`--network`](#network) and [`--genesis-file`](#genesis-file) option can't be used at the same time.

### network-id

```bash tab="Syntax"
--network-id=<INTEGER>
```

```bash tab="Example Command Line"
--network-id=8675309
```

```bash tab="Example Configuration File"
network-id="8675309"
```

P2P network identifier.

This option can be used to override your current network ID.
The default value is the current network chain ID which is defined in the genesis file.

### discovery-enabled

```bash tab="Syntax"
--discovery-enabled=false
```

```bash tab="Example Configuration File"
discovery-enabled=false
```

Enables or disables P2P peer discovery.
The default is `true`.

### node-private-key-file

```bash tab="Syntax"
--node-private-key-file=<FILE>
```

```bash tab="Example Command Line"
--node-private-key-file=/home/me/me_node/myPrivateKey
```

```bash tab="Example Configuration File"
node-private-key-file="/home/me/me_node/myPrivateKey"
```

`<FILE>` is the path of the private key file of the node.
The default is the key file in the data directory.
If no key file exists, a key file containing the generated private key is created;
otherwise, the existing key file specifies the node private key.


!!!attention
    The private key is not encrypted.
  
!!!note
    This option is only available from v0.8.2. 

### nodes-whitelist

```bash tab="Syntax"
--nodes-whitelist[=<enode://id@host:port>[,<enode://id@host:port>...]...]
```

```bash tab="Example Command Line"
--nodes-whitelist=enode://c35c3...d615f@3.14.15.92:30303,enode://f42c13...fc456@65.35.89.79:30303
```

```bash tab="Example Configuration File"
nodes-whitelist=["enode://c35c3...d615f@3.14.15.92:30303","enode://f42c13...fc456@65.35.89.79:30303"]
```

Comma-separated enode URLs for permissioned networks.
Not intended for use with mainnet or public testnets. 


!!!note
    This option is only available from v0.8.3. 

!!!note
    Permissioning is under development and will be available in v1.0.

### p2p-host

```bash tab="Syntax"
--p2p-host=<HOST>
```

```bash tab="Example Command Line"
# to listen on all interfaces
--p2p-host=0.0.0.0
```

```bash tab="Example Configuration File"
p2p-host="0.0.0.0"
```

Specifies the host on which P2P peer discovery listens.
The default is 127.0.0.1.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 

### p2p-port

```bash tab="Syntax"
--p2p-port=<PORT>
```

```bash tab="Example Command Line"
# to listen on port 1789
--p2p-port=1789
```

```bash tab="Example Configuration File"
p2p-port="1789"
```

Specifies the port on which P2P peer discovery listens.
The default is 30303.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 

### rpc-http-enabled

```bash tab="Syntax"
--rpc-http-enabled
```

```bash tab="Example Configuration File"
rpc-http-enabled=true
```

Set to `true` to enable the HTTP JSON-RPC service.
The default is `false`.

### rpc-http-host

```bash tab="Syntax"
--rpc-http-host=<HOST>
```

```bash tab="Example Command Line"
# to listen on all interfaces
--rpc-http-host=0.0.0.0
```

```bash tab="Example Configuration File"
rpc-http-host="0.0.0.0"
```

Specifies the host on which HTTP JSON-RPC listens.
The default is 127.0.0.1.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 

### rpc-http-port

```bash tab="Syntax"
--rpc-http-port=<PORT>
```

```bash tab="Example Command Line"
# to listen on port 3435
--rpc-http-port=3435
```

```bash tab="Example Configuration File"
rpc-http-port="3435"
```

Specifies the port on which HTTP JSON-RPC listens.
The default is 8545.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 

### rpc-http-api

```bash tab="Syntax"
--rpc-http-api=<api name>[,<api name>...]...
```

```bash tab="Example Command Line"
--rpc-http-api=ETH,NET,WEB3
```

```bash tab="Example Configuration File"
rpc-http-api=["ETH","NET","WEB3"]
```

Comma-separated APIs to enable on the HTTP JSON-RPC channel.
When you use this option, the `--rpc-http-enabled` option must also be specified.
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `DEBUG`, and `MINER`.
The default is: `ETH`, `NET`, `WEB3`.

!!!note
    :construction: IBFT is not currently supported. Support for IBFT is in active development. 

!!!tip
    The singular `--rpc-http-api` and plural `--rpc-http-apis` are available and are just two
    names for the same option.
    
### rpc-http-cors-origins

```bash tab="Syntax"
--rpc-http-cors-origins=<url>[,<url>...]... or all or *
```

```bash tab="Example Command Line"
# You can whitelist one or more domains with a comma-separated list.

--rpc-http-cors-origins="http://medomain.com","https://meotherdomain.com"
```

```bash tab="Example Configuration File"
rpc-http-cors-origins=["http://medomain.com","https://meotherdomain.com"]
```

```bash tab="Remix IDE domain example"
# The following allows Remix to interact with your Pantheon node without using MetaMask.

--rpc-http-cors-origins="http://remix.ethereum.org"
```

Specifies domain URLs for CORS validation.
Domain URLs must be enclosed in double quotes and comma-separated.

Listed domains will be allowed access to node data (whitelisted).
If your client interacts with Pantheon using a browser app (such as Remix using a direct connection or a block explorer), 
you must whitelist the client domains. 

The default value is `"none"`.
If you don't whitelist any domains, you won't be able to use webapps to interact with your Pantheon node.

!!!note
    MetaMask runs as native code so does not require CORS validation.
    If Remix is connecting to the node through MetaMask, it also does not require CORS validation.
    
!!!tip
    For development purposes, you can use `"all"` or `"*"` to accept requests from any domain, 
    but we don't recommend this for production code.

### rpc-ws-enabled

```bash tab="Syntax"
--rpc-ws-enabled
```

```bash tab="Example Configuration File"
rpc-ws-enabled=true
```

Set to `true` to enable the WebSockets JSON-RPC service.
The default is `false`.

### rpc-ws-api

```bash tab="Syntax"
--rpc-ws-api=<api name>[,<api name>...]...
```

```bash tab="Example Command Line"
--rpc-ws-api=ETH,NET,WEB3
```

```bash tab="Example Configuration File"
rpc-ws-api=["ETH","NET","WEB3"]
```

Comma-separated APIs to enable on Websockets channel.
When you use this option, the `--rpc-ws-enabled` option must also be specified.
The available API options are: `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `DEBUG`, and `MINER`.
The default is: `ETH`, `NET`, `WEB3`.

!!!note
    :construction: IBFT is not currently supported. Support for IBFT is in active development. 

!!!tip
    The singular `--rpc-ws-api` and plural `--rpc-ws-apis` are available and are just two
    names for the same option.
    
### rpc-ws-host

```bash tab="Syntax"
--ws-host=<HOST>
```

```bash tab="Example Command Line"
# to listen on all interfaces
--ws-host=0.0.0.0
```

```bash tab="Example Configuration File"
ws-host="0.0.0.0"
```

Host for Websocket WS-RPC to listen on.
The default is 127.0.0.1.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 
    
### rpc-ws-port

```bash tab="Syntax"
--ws-port=<PORT>
```

```bash tab="Example Command Line"
# to listen on port 6174
--ws-port=6174
```

```bash tab="Example Configuration File"
ws-port="6174"
```

Port for Websocket WS-RPC to listen on.
The default is 8546.

!!!note
    This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). 

### rpc-ws-refresh-delay

```bash tab="Syntax"
--rpc-ws-refresh-delay=<refresh delay>
```

```bash tab="Example"
--rpc-ws-refresh-delay="10000"
```

Refresh delay for Websocket synchronizing subscription in milliseconds. 
The default is 5000. 


### help

```bash tab="Syntax"
-h, --help
```

Show the help message and exit.

### logging

```bash tab="Syntax"
-l, --logging=<LEVEL>
```

```bash tab="Example Command Line"
--logging=DEBUG
```

```bash tab="Example Configration File"
logging="DEBUG"
```

Sets the logging verbosity.
Log levels are `OFF`, `FATAL`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`.
Default is `INFO`.

### version

```bash tab="Syntax"
  -V, --version
```

Print version information and exit.

## Commands

Pantheon subcommands are: 

### blocks

This command provides blocks related actions.

#### import

```bash tab="Syntax"
$ pantheon blocks import --from=<block-file>
```

```bash tab="Example"
$ pantheon blocks import --from=/home/me/me_project/mainnet.blocks
```

Imports blocks from the specified file into the blockchain database

### public-key

This command provides node public key related actions.

#### export

```bash tab="Syntax"
$ pantheon public-key export --to=<key-file>
```

```bash tab="Example"
$ pantheon public-key export --to=/home/me/me_project/not_precious_pub_key
```

Exports node public key to the specified file.