668115a4b8
## Issue Addressed Resolves https://github.com/sigp/lighthouse/issues/3019 ## Proposed Changes - Eth2 Eth2.0 Ethereum 2.0 -> Ethereum consensus - Eth2 network -> consensus layer - Ethereum 2.0 specification -> Ethereum proof-of-stake consensus specification - Eth2 deposit contract -> Staking deposit contract - Eth1 -> execution client ## Additional Info The description needs to be updated by someone who has permission to do. 📝 <img width="487" alt="image" src="https://user-images.githubusercontent.com/1885716/153995211-816d9561-751e-4810-abb9-83d979379783.png">
56 lines
1.9 KiB
Markdown
56 lines
1.9 KiB
Markdown
# Command-Line Interface (CLI)
|
|
|
|
The `lighthouse` binary provides all necessary Ethereum consensus client functionality. It
|
|
has two primary sub-commands:
|
|
|
|
- `$ lighthouse beacon_node`: the largest and most fundamental component which connects to
|
|
the p2p network, processes messages and tracks the head of the beacon
|
|
chain.
|
|
- `$ lighthouse validator_client`: a lightweight but important component which loads a validators private
|
|
key and signs messages using a `beacon_node` as a source-of-truth.
|
|
|
|
There are also some ancillary binaries like `lcli` and `account_manager`, but
|
|
these are primarily for testing.
|
|
|
|
> **Note:** documentation sometimes uses `$ lighthouse bn` and `$ lighthouse
|
|
> vc` instead of the long-form `beacon_node` and `validator_client`. These
|
|
> commands are valid on the CLI too.
|
|
|
|
## Installation
|
|
|
|
Typical users may install `lighthouse` to `CARGO_HOME` with `cargo install
|
|
--path lighthouse` from the root of the repository. See ["Configuring the
|
|
`PATH` environment variable"](https://www.rust-lang.org/tools/install) for more
|
|
information.
|
|
|
|
For developers, we recommend building Lighthouse using the `$ cargo build --release
|
|
--bin lighthouse` command and executing binaries from the
|
|
`<lighthouse-repository>/target/release` directory. This is more ergonomic when
|
|
modifying and rebuilding regularly.
|
|
|
|
## Documentation
|
|
|
|
Each binary supports the `--help` flag, this is the best source of
|
|
documentation.
|
|
|
|
```bash
|
|
$ lighthouse beacon_node --help
|
|
```
|
|
|
|
```bash
|
|
$ lighthouse validator_client --help
|
|
```
|
|
|
|
## Creating a new database/testnet
|
|
|
|
Lighthouse should run out-of-the box and connect to the current testnet
|
|
maintained by Sigma Prime.
|
|
|
|
However, for developers, testnets can be created by following the instructions
|
|
outlined in [testnets](./testnets.md). The steps listed here will create a
|
|
local database specified to a new testnet.
|
|
|
|
## Resuming from an existing database
|
|
|
|
Once a database/testnet has been created, it can be resumed by running `$ lighthouse bn`.
|