mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-02 16:21:42 +00:00
Clarify command-line reference docs (#6524)
* Clarify command-line reference docs * Update page title * Merge remote-tracking branch 'origin/unstable' into cli-reference * Update CLI script
This commit is contained in:
@@ -54,13 +54,13 @@
|
||||
* [Merge Migration](./merge-migration.md)
|
||||
* [Late Block Re-orgs](./late-block-re-orgs.md)
|
||||
* [Blobs](./advanced-blobs.md)
|
||||
* [Built-In Documentation](./help_general.md)
|
||||
* [Command Line Reference (CLI)](./help_general.md)
|
||||
* [Beacon Node](./help_bn.md)
|
||||
* [Validator Client](./help_vc.md)
|
||||
* [Validator Manager](./help_vm.md)
|
||||
* [Create](./help_vm_create.md)
|
||||
* [Import](./help_vm_import.md)
|
||||
* [Move](./help_vm_move.md)
|
||||
* [Move](./help_vm_move.md)
|
||||
* [Contributing](./contributing.md)
|
||||
* [Development Environment](./setup.md)
|
||||
* [FAQs](./faq.md)
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
# 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`.
|
||||
@@ -1,4 +1,4 @@
|
||||
# Lighthouse General Commands
|
||||
# Lighthouse CLI Reference
|
||||
|
||||
```
|
||||
Ethereum 2.0 client by Sigma Prime. Provides a full-featured beacon node, a
|
||||
|
||||
@@ -40,7 +40,7 @@ vm_import=./help_vm_import.md
|
||||
vm_move=./help_vm_move.md
|
||||
|
||||
# create .md files
|
||||
write_to_file "$general_cli" "$general" "Lighthouse General Commands"
|
||||
write_to_file "$general_cli" "$general" "Lighthouse CLI Reference"
|
||||
write_to_file "$bn_cli" "$bn" "Beacon Node"
|
||||
write_to_file "$vc_cli" "$vc" "Validator Client"
|
||||
write_to_file "$vm_cli" "$vm" "Validator Manager"
|
||||
|
||||
Reference in New Issue
Block a user