add cli

docs/src/SUMMARY.md

@@ -3,6 +3,7 @@
 - [Introduction](./intro.md)
 - [Become a Validator](./validator.md)
 - [Installation](./install.md)
+- [Command-line Options](./cli.md)
 - [Advanced Usage for Developers](./advanced.md)
 - [FAQs](./faq.md)
 - [Contribute](./contribute.md)

docs/src/cli.md

@@ -0,0 +1,109 @@
+# Command-line Options
+
+You can run your customized beacon node using the beacon_node CLI. The available options are shown below.
+
+## Prerequisites
+
+Specifying a genesis file is mandatory to run this CLI. You can either get it from the official eth2 repository [here](https://github.com/eth2-clients/eth2-testnets/blob/master/shared/witti/genesis.ssz) or generate your own like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L154) when starting a local testnet. You can also specify the path of your genesis file like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L229).
+
+For example, download a genesis file and then run the following command to start the node:
+
+<img src="./img/beacon_node_example.PNG" alt="" style="margin: 0 40 0 40"/>
+
+## CLI Help Message
+
+```
+$ ./build/beacon_node --help
+Nimbus beacon node v0.3.0 (e537ed9
+)
+Copyright (c) 2019-2020 Status Research & Development GmbH
+
+Nim Compiler Version 1.3.1 [Windows: amd64]
+Compiled at 2020-04-16
+Copyright (c) 2006-2020 by Andreas Rumpf
+
+git hash: b4e9f8e814373fc38741736197d88475663ce758
+active boot switches: -d:release
+
+
+Usage:
+
+beacon_node [OPTIONS]... command
+
+The following options are available:
+
+     --log-level             Sets the log level.
+     --eth1-network          The Eth1 network tracked by the beacon node.
+     --quick-start           Run in quickstart mode
+ -d, --data-dir              The directory where nimbus will store all blockchain data.
+     --web3-url              URL of the Web3 server to observe Eth1.
+     --deposit-contract      Address of the deposit contract.
+ -b, --bootstrap-node        Specifies one or more bootstrap nodes to use when connecting to the
+                             network.
+     --bootstrap-file        Specifies a line-delimited file of bootstrap Ethereum network addresses.
+     --listen-address        Listening address for the Ethereum LibP2P traffic.
+     --tcp-port              Listening TCP port for Ethereum LibP2P traffic.
+     --udp-port              Listening UDP port for node discovery.
+     --max-peers             The maximum number of peers to connect to
+     --nat                   Specify method to use for determining public address. Must be one of: any,
+                             none, upnp, pmp, extip:<IP>.
+ -v, --validator             Path to a validator private key, as generated by makeDeposits.
+ -s, --state-snapshot        Json file specifying a recent state snapshot.
+     --node-name             A name for this node that will appear in the logs. If you set this to
+                             'auto', a persistent automatically generated ID will be selected for each
+                             --dataDir folder.
+     --verify-finalization   Specify whether to verify finalization occurs on schedule, for testing.
+     --stop-at-epoch         A positive epoch selects the epoch at which to stop.
+     --metrics               Enable the metrics server.
+     --metrics-address       Listening address of the metrics server.
+     --metrics-port          Listening HTTP port of the metrics server.
+     --status-bar            Display a status bar at the bottom of the terminal screen.
+     --status-bar-contents   Textual template for the contents of the status bar.
+     --rpc                   Enable the JSON-RPC server
+     --rpc-port              HTTP port for the JSON-RPC service.
+     --rpc-address           Listening address of the RPC server
+     --dump                  Write SSZ dumps of blocks, attestations and states to data dir
+
+Available sub-commands:
+
+beacon_node importValidator [OPTIONS]...
+
+The following options are available:
+
+     --keyfile               File with validator key to be imported (in hex form).
+
+beacon_node createTestnet [OPTIONS]...
+
+The following options are available:
+
+ -d, --validators-dir        Directory containing validator descriptors named 'vXXXXXXX.deposit.json'.
+     --total-validators      The number of validators in the newly created chain.
+     --first-validator       Index of first validator to add to validator list.
+     --last-user-validator   The last validator index that will free for taking from a testnet
+                             participant.
+     --bootstrap-address     The public IP address that will be advertised as a bootstrap node for the
+                             testnet.
+     --bootstrap-port        The TCP/UDP port that will be used by the bootstrap node.
+ -g, --genesis-offset        Seconds from now to add to genesis time.
+     --output-genesis        Output file where to write the initial state snapshot.
+     --with-genesis-root     Include a genesis root in 'network.json'.
+     --output-bootstrap-file  Output file with list of bootstrap nodes for the network.
+
+beacon_node makeDeposits [OPTIONS]...
+
+The following options are available:
+
+     --quickstart-deposits   Number of quick-start deposits to generate.
+     --random-deposits       Number of secure random deposits to generate.
+     --deposits-dir          Folder to write deposits to.
+     --deposit-private-key   Private key of the controlling (sending) account
+     --min-delay             Minimum possible delay between making two deposits (in seconds)
+     --max-delay             Maximum possible delay between making two deposits (in seconds)
+
+beacon_node query command
+
+Available sub-commands:
+
+beacon_node query get <getQueryPath>
+<getQueryPath>                REST API path to evaluate
+```

docs/src/intro.md

@@ -14,9 +14,10 @@ In this book, we will cover:
 1. [What is beacon chain](./faq.md#1-what-is-beacon-chain) and [what is Nimbus](./faq.md#4-what-is-nimbus) to equip you with some basic knowledge.
 2. How to [become a validator](./validator.md) in Ethereum 2.0 as a user.
 3. [Installation steps](./install.md) for nimbus beacon chain.
-4. [Advanced usage](./advanced.md) for developers.
+4. [Command-line options](./cli.md) for running your customized nimbus beacon node.
-5. Common [questions and answers](./faq.md) to satisfy your curiosity.
+5. [Advanced usage](./advanced.md) for developers.
-6. How to [contribute](./contribute.md) to this book.
+6. Common [questions and answers](./faq.md) to satisfy your curiosity.
+7. How to [contribute](./contribute.md) to this book.
 
 Feel free to give us feedback on how to improve as well as contribute to our book on github. :)