Quick Start
A guide to start REI Network Node

Install

Install from npm:
1
npm install @rei-network/cli --global
Copied!
Install from source code:
1
git clone https://github.com/rei-network/rei.git
2
cd rei
3
npm install
4
npm link -w @rei-network/cli
Copied!

Usage

1
Usage: rei [options] [command]
2
3
Options:
4
-V, --version output the version number
5
--rpc open rpc server
6
--rpc-port <port> rpc server port
7
--rpc-host <port> rpc server host
8
--rpc-api <apis> rpc server apis: debug, eth, net, txpool, web3
9
--disable-p2p disable p2p server
10
--p2p-tcp-port <port> p2p server tcp port
11
--p2p-udp-port <port> p2p server udp port
12
--p2p-nat <ip> p2p server nat ip
13
--max-peers <peers> max p2p peers count
14
--max-dials <dials> max p2p dials count
15
--bootnodes <bootnodes...> comma separated list of bootnodes
16
--datadir <path> chain data dir path (default: "~/.rei")
17
--keystore <keystore> the datadir for keystore (default: "keystore")
18
--unlock <unlock> comma separated list of accounts to unlock
19
--password <password> password file to use for non-interactive password input
20
--chain <chain> chain name: rei-mainnet, rei-testnet, rei-devnet
21
--mine mine block
22
--coinbase <address> miner address
23
--verbosity <verbosity> logging verbosity: silent, error, warn, info, debug, detail (default: "info")
24
--receipts-cache-size <receiptsCacheSize> receipts cache size
25
-h, --help display help for command
26
27
Commands:
28
account Manage accounts
Copied!
Default settings:
Params
Default Value
Description
P2P TCP Port
4191
P2P Network TCP Port
P2P UDP Port
9810
P2P Network UDP Port
P2P NAT
127.0.0.1
The public IP of this node, used for node discovery
RPC Port
11451
RPC host
127.0.0.1
RPC API
eth,net,web3

Example

Proposer node startup
1
rei --mine --coinbase 0x...abc --unlock 0x...abc --password ./password
Copied!
RPC node startup
1
rei --rpc --rpc-host 0.0.0.0
Copied!
Bootnode startup
1
rei --p2p-nat 1.2.3.4
Copied!
Testnet or devnet node startup
1
rei --chain rei-testnet
2
rei --chain rei-devnet
Copied!
Copy link