Use text instead of bash for CLI docs (#5977)

This commit is contained in:
Paweł Urbanek
2024-01-09 18:14:55 +01:00
committed by GitHub
parent a1225be077
commit d421120a25
33 changed files with 33 additions and 33 deletions

View File

@ -2,7 +2,7 @@
Write config to stdout
```bash
```text
$ reth config --help
Usage: reth config [OPTIONS]

2
book/cli/reth/db.md vendored
View File

@ -2,7 +2,7 @@
Database debugging utilities
```bash
```text
$ reth db --help
Usage: reth db [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Deletes all table entries
```bash
```text
$ reth db clear --help
Usage: reth db clear [OPTIONS] <TABLE>

View File

@ -2,7 +2,7 @@
Create a diff between two database tables or two entire databases
```bash
```text
$ reth db diff --help
Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT>

View File

@ -2,7 +2,7 @@
Deletes all database entries
```bash
```text
$ reth db drop --help
Usage: reth db drop [OPTIONS]

View File

@ -2,7 +2,7 @@
Gets the content of a table for the given key
```bash
```text
$ reth db get --help
Usage: reth db get [OPTIONS] <TABLE> <KEY>

View File

@ -2,7 +2,7 @@
Lists the contents of a table
```bash
```text
$ reth db list --help
Usage: reth db list [OPTIONS] <TABLE>

View File

@ -2,7 +2,7 @@
Returns the full database path
```bash
```text
$ reth db path --help
Usage: reth db path [OPTIONS]

View File

@ -2,7 +2,7 @@
Snapshots tables from database
```bash
```text
$ reth db snapshot --help
Usage: reth db snapshot [OPTIONS] [SEGMENTS]...

View File

@ -2,7 +2,7 @@
Lists all the tables, their entry count and their size
```bash
```text
$ reth db stats --help
Usage: reth db stats [OPTIONS]

View File

@ -2,7 +2,7 @@
Lists current and local database versions
```bash
```text
$ reth db version --help
Usage: reth db version [OPTIONS]

View File

@ -2,7 +2,7 @@
Various debug routines
```bash
```text
$ reth debug --help
Usage: reth debug [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
This syncs RLP encoded blocks from a file
```bash
```text
$ reth import --help
Usage: reth import [OPTIONS] <IMPORT_PATH>

View File

@ -2,7 +2,7 @@
Initialize the database from a genesis file
```bash
```text
$ reth init --help
Usage: reth init [OPTIONS]

View File

@ -2,7 +2,7 @@
Start the node
```bash
```text
$ reth node --help
Usage: reth node [OPTIONS]

View File

@ -2,7 +2,7 @@
P2P Debugging utilities
```bash
```text
$ reth p2p --help
Usage: reth p2p [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Download block body
```bash
```text
$ reth p2p body --help
Usage: reth p2p body [OPTIONS] <ID>

View File

@ -2,7 +2,7 @@
Download block header
```bash
```text
$ reth p2p header --help
Usage: reth p2p header [OPTIONS] <ID>

View File

@ -2,7 +2,7 @@
Scripts for node recovery
```bash
```text
$ reth recover --help
Usage: reth recover [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Recover the node by deleting dangling storage tries
```bash
```text
$ reth recover storage-tries --help
Usage: reth recover storage-tries [OPTIONS]

View File

@ -2,7 +2,7 @@
Manipulate individual stages
```bash
```text
$ reth stage --help
Usage: reth stage [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Drop a stage's tables from the database
```bash
```text
$ reth stage drop --help
Usage: reth stage drop [OPTIONS] <STAGE>

View File

@ -2,7 +2,7 @@
Dumps a stage from a range into a new database
```bash
```text
$ reth stage dump --help
Usage: reth stage dump [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
AccountHashing stage
```bash
```text
$ reth stage dump account-hashing --help
Usage: reth stage dump account-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>

View File

@ -2,7 +2,7 @@
Execution stage
```bash
```text
$ reth stage dump execution --help
Usage: reth stage dump execution [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>

View File

@ -2,7 +2,7 @@
Merkle stage
```bash
```text
$ reth stage dump merkle --help
Usage: reth stage dump merkle [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>

View File

@ -2,7 +2,7 @@
StorageHashing stage
```bash
```text
$ reth stage dump storage-hashing --help
Usage: reth stage dump storage-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>

View File

@ -2,7 +2,7 @@
Run a single stage.
```bash
```text
$ reth stage run --help
Usage: reth stage run [OPTIONS] --from <FROM> --to <TO> <STAGE>

View File

@ -2,7 +2,7 @@
Unwinds a certain block range, deleting it from the database
```bash
```text
$ reth stage unwind --help
Usage: reth stage unwind [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Unwinds the given number of blocks from the database
```bash
```text
$ reth stage unwind num-blocks --help
Usage: reth stage unwind num-blocks [OPTIONS] <AMOUNT>

View File

@ -2,7 +2,7 @@
Unwinds the database until the given block number (range is inclusive)
```bash
```text
$ reth stage unwind to-block --help
Usage: reth stage unwind to-block [OPTIONS] <TARGET>

View File

@ -2,7 +2,7 @@
Generate Test Vectors
```bash
```text
$ reth test-vectors --help
Usage: reth test-vectors [OPTIONS] <COMMAND>

View File

@ -2,7 +2,7 @@
Generates test vectors for specified tables. If no table is specified, generate for all
```bash
```text
$ reth test-vectors tables --help
Usage: reth test-vectors tables [OPTIONS] [NAMES]...