3070cb7c39
* linter * Add markdown linter * add env * only check markdown * Add token * Update .github/workflows/test-suite.yml * Markdown linter * Exit code * Update script * rename * mdlint * Add an empty line after end of file * Testing disable * add text * update mdlint.sh * ori validator inclusion * Add config yml file * Remove MD041 and fix advanced-datadir file * FIx validator inclusion file conflict * Merge branch 'unstable' into markdown-linter * change files * Merge branch 'markdown-linter' of https://github.com/chong-he/lighthouse into markdown-linter * mdlint * Remove MD025 * Remove MD036 * Remove MD045 * Removr MD001 * Set MD028 to false * Remove MD024 * Remove MD055 * Remove MD029 * Remove MD040 * Set MD040 to false * Set MD033 to false * Set MD013 to false * Rearrange yml file * Update mdlint.sh and test * Test remove fix * Test with fix * Test with space * Fix summary indentation * Test mdlint.sh * Update mdlint.sh * Test * Update * Test fix * Test again * Fix * merge into check-code * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Remove set -e * Add comment * Merge pull request #7 from chong-he/unstable Merge unstable to markdown branch * mdlint * Merge branch 'unstable' into markdown-linter * mdlint
1.9 KiB
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 abeacon_nodeas 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 bnand$ lighthouse vcinstead of the long-formbeacon_nodeandvalidator_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" 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.
lighthouse beacon_node --help
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. 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.