docs: improve CLI reference generator (#5740)

This commit is contained in:
DaniPopes
2023-12-14 12:18:18 +02:00
committed by GitHub
parent 013b4c93db
commit 744930f1de
49 changed files with 3481 additions and 3799 deletions

View File

@ -30,7 +30,7 @@ RUST_LOG=info reth node --full
On differences between archive and full nodes, see [Pruning & Full Node](./pruning.md#basic-concepts) section.
> Note that these commands will not open any HTTP/WS ports by default. You can change this by adding the `--http`, `--ws` flags, respectively and using the `--http.api` and `--ws.api` flags to enable various [JSON-RPC APIs](../jsonrpc/intro.md). For more commands, see the [`reth node` CLI reference](../cli/node.md).
> Note that these commands will not open any HTTP/WS ports by default. You can change this by adding the `--http`, `--ws` flags, respectively and using the `--http.api` and `--ws.api` flags to enable various [JSON-RPC APIs](../jsonrpc/intro.md). For more commands, see the [`reth node` CLI reference](../cli/reth/node.md).
The EL <> CL communication happens over the [Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine/common.md), which is by default exposed at `http://localhost:8551`. The connection is authenticated over JWT using a JWT secret which is auto-generated by Reth and placed in a file called `jwt.hex` in the data directory, which on Linux by default is `$HOME/.local/share/reth/` (`/Users/<NAME>/Library/Application Support/reth/mainnet/jwt.hex` in Mac).

View File

@ -61,7 +61,7 @@ is less than 1 second.
It will take the same time as initial sync.
1. Stop Reth
2. Drop the database using [`reth db drop`](../cli/db.md#reth-db-drop)
2. Drop the database using [`reth db drop`](../cli/reth/db/drop.md)
3. Start reth
### Database write error
@ -110,4 +110,4 @@ pthread_mutex_lock.c:438: __pthread_mutex_lock_full: Assertion `e != ESRCH || !r
If you are using Docker, a possible solution is to run all database-accessing containers with `--pid=host` flag.
For more information, check out the `Containers` section in the [libmdbx README](https://github.com/erthink/libmdbx#containers).
For more information, check out the `Containers` section in the [libmdbx README](https://github.com/erthink/libmdbx#containers).