arnaucube
arnaucube/hermez-nodePublic Self-hosted repository
hermez-node/cli/node/README.md
cli/node/README.mdRaw
 1# node cli
 2
 3This is the main cli for the node
 4
 5## Usage
 6
 7```
 8NAME:
 9   hermez-node - A new cli application
10
11USAGE:
12   node [global options] command [command options] [arguments...]
13
14VERSION:
15   0.1.0-alpha
16
17COMMANDS:
18   importkey  Import ethereum private key
19   wipesql    Wipe the SQL DB (HistoryDB and L2DB), leaving the DB in a clean state
20   run        Run the hermez-node in the indicated mode
21   help, h    Shows a list of commands or help for one command
22
23GLOBAL OPTIONS:
24   --mode MODE    Set node MODE (can be "sync" or "coord")
25   --cfg FILE     Node configuration FILE
26   --help, -h     show help (default: false)
27   --version, -v  print the version (default: false)
28```
29
30## Configuration
31
32You can find a testing working configuration example at
33[cfg.buidler.toml](./cfg.buidler.toml)
34
35To read the documentation of each configuration parameter, please check the
36`type Node` and `type Coordinator` at
37[config/config.go](../../config/config.go)