mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
Use text instead of bash for CLI docs (#5977)
This commit is contained in:
2
book/cli/reth/config.md
vendored
2
book/cli/reth/config.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Write config to stdout
|
Write config to stdout
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth config --help
|
$ reth config --help
|
||||||
Usage: reth config [OPTIONS]
|
Usage: reth config [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db.md
vendored
2
book/cli/reth/db.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Database debugging utilities
|
Database debugging utilities
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db --help
|
$ reth db --help
|
||||||
Usage: reth db [OPTIONS] <COMMAND>
|
Usage: reth db [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/clear.md
vendored
2
book/cli/reth/db/clear.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Deletes all table entries
|
Deletes all table entries
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db clear --help
|
$ reth db clear --help
|
||||||
Usage: reth db clear [OPTIONS] <TABLE>
|
Usage: reth db clear [OPTIONS] <TABLE>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/diff.md
vendored
2
book/cli/reth/db/diff.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Create a diff between two database tables or two entire databases
|
Create a diff between two database tables or two entire databases
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db diff --help
|
$ reth db diff --help
|
||||||
Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT>
|
Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/drop.md
vendored
2
book/cli/reth/db/drop.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Deletes all database entries
|
Deletes all database entries
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db drop --help
|
$ reth db drop --help
|
||||||
Usage: reth db drop [OPTIONS]
|
Usage: reth db drop [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/get.md
vendored
2
book/cli/reth/db/get.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Gets the content of a table for the given key
|
Gets the content of a table for the given key
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db get --help
|
$ reth db get --help
|
||||||
Usage: reth db get [OPTIONS] <TABLE> <KEY>
|
Usage: reth db get [OPTIONS] <TABLE> <KEY>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/list.md
vendored
2
book/cli/reth/db/list.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Lists the contents of a table
|
Lists the contents of a table
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db list --help
|
$ reth db list --help
|
||||||
Usage: reth db list [OPTIONS] <TABLE>
|
Usage: reth db list [OPTIONS] <TABLE>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/path.md
vendored
2
book/cli/reth/db/path.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Returns the full database path
|
Returns the full database path
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db path --help
|
$ reth db path --help
|
||||||
Usage: reth db path [OPTIONS]
|
Usage: reth db path [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/snapshot.md
vendored
2
book/cli/reth/db/snapshot.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Snapshots tables from database
|
Snapshots tables from database
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db snapshot --help
|
$ reth db snapshot --help
|
||||||
Usage: reth db snapshot [OPTIONS] [SEGMENTS]...
|
Usage: reth db snapshot [OPTIONS] [SEGMENTS]...
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/stats.md
vendored
2
book/cli/reth/db/stats.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Lists all the tables, their entry count and their size
|
Lists all the tables, their entry count and their size
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db stats --help
|
$ reth db stats --help
|
||||||
Usage: reth db stats [OPTIONS]
|
Usage: reth db stats [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/db/version.md
vendored
2
book/cli/reth/db/version.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Lists current and local database versions
|
Lists current and local database versions
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth db version --help
|
$ reth db version --help
|
||||||
Usage: reth db version [OPTIONS]
|
Usage: reth db version [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/debug.md
vendored
2
book/cli/reth/debug.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Various debug routines
|
Various debug routines
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth debug --help
|
$ reth debug --help
|
||||||
Usage: reth debug [OPTIONS] <COMMAND>
|
Usage: reth debug [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/import.md
vendored
2
book/cli/reth/import.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
This syncs RLP encoded blocks from a file
|
This syncs RLP encoded blocks from a file
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth import --help
|
$ reth import --help
|
||||||
Usage: reth import [OPTIONS] <IMPORT_PATH>
|
Usage: reth import [OPTIONS] <IMPORT_PATH>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/init.md
vendored
2
book/cli/reth/init.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Initialize the database from a genesis file
|
Initialize the database from a genesis file
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth init --help
|
$ reth init --help
|
||||||
Usage: reth init [OPTIONS]
|
Usage: reth init [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/node.md
vendored
2
book/cli/reth/node.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Start the node
|
Start the node
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth node --help
|
$ reth node --help
|
||||||
Usage: reth node [OPTIONS]
|
Usage: reth node [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/p2p.md
vendored
2
book/cli/reth/p2p.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
P2P Debugging utilities
|
P2P Debugging utilities
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth p2p --help
|
$ reth p2p --help
|
||||||
Usage: reth p2p [OPTIONS] <COMMAND>
|
Usage: reth p2p [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/p2p/body.md
vendored
2
book/cli/reth/p2p/body.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Download block body
|
Download block body
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth p2p body --help
|
$ reth p2p body --help
|
||||||
Usage: reth p2p body [OPTIONS] <ID>
|
Usage: reth p2p body [OPTIONS] <ID>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/p2p/header.md
vendored
2
book/cli/reth/p2p/header.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Download block header
|
Download block header
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth p2p header --help
|
$ reth p2p header --help
|
||||||
Usage: reth p2p header [OPTIONS] <ID>
|
Usage: reth p2p header [OPTIONS] <ID>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/recover.md
vendored
2
book/cli/reth/recover.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Scripts for node recovery
|
Scripts for node recovery
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth recover --help
|
$ reth recover --help
|
||||||
Usage: reth recover [OPTIONS] <COMMAND>
|
Usage: reth recover [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/recover/storage-tries.md
vendored
2
book/cli/reth/recover/storage-tries.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Recover the node by deleting dangling storage tries
|
Recover the node by deleting dangling storage tries
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth recover storage-tries --help
|
$ reth recover storage-tries --help
|
||||||
Usage: reth recover storage-tries [OPTIONS]
|
Usage: reth recover storage-tries [OPTIONS]
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage.md
vendored
2
book/cli/reth/stage.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Manipulate individual stages
|
Manipulate individual stages
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage --help
|
$ reth stage --help
|
||||||
Usage: reth stage [OPTIONS] <COMMAND>
|
Usage: reth stage [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/drop.md
vendored
2
book/cli/reth/stage/drop.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Drop a stage's tables from the database
|
Drop a stage's tables from the database
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage drop --help
|
$ reth stage drop --help
|
||||||
Usage: reth stage drop [OPTIONS] <STAGE>
|
Usage: reth stage drop [OPTIONS] <STAGE>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/dump.md
vendored
2
book/cli/reth/stage/dump.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Dumps a stage from a range into a new database
|
Dumps a stage from a range into a new database
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage dump --help
|
$ reth stage dump --help
|
||||||
Usage: reth stage dump [OPTIONS] <COMMAND>
|
Usage: reth stage dump [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/dump/account-hashing.md
vendored
2
book/cli/reth/stage/dump/account-hashing.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
AccountHashing stage
|
AccountHashing stage
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage dump account-hashing --help
|
$ reth stage dump account-hashing --help
|
||||||
Usage: reth stage dump account-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
Usage: reth stage dump account-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/dump/execution.md
vendored
2
book/cli/reth/stage/dump/execution.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Execution stage
|
Execution stage
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage dump execution --help
|
$ reth stage dump execution --help
|
||||||
Usage: reth stage dump execution [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
Usage: reth stage dump execution [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/dump/merkle.md
vendored
2
book/cli/reth/stage/dump/merkle.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Merkle stage
|
Merkle stage
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage dump merkle --help
|
$ reth stage dump merkle --help
|
||||||
Usage: reth stage dump merkle [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
Usage: reth stage dump merkle [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/dump/storage-hashing.md
vendored
2
book/cli/reth/stage/dump/storage-hashing.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
StorageHashing stage
|
StorageHashing stage
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage dump storage-hashing --help
|
$ reth stage dump storage-hashing --help
|
||||||
Usage: reth stage dump storage-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
Usage: reth stage dump storage-hashing [OPTIONS] --output-db <OUTPUT_PATH> --from <FROM> --to <TO>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/run.md
vendored
2
book/cli/reth/stage/run.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Run a single stage.
|
Run a single stage.
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage run --help
|
$ reth stage run --help
|
||||||
Usage: reth stage run [OPTIONS] --from <FROM> --to <TO> <STAGE>
|
Usage: reth stage run [OPTIONS] --from <FROM> --to <TO> <STAGE>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/unwind.md
vendored
2
book/cli/reth/stage/unwind.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Unwinds a certain block range, deleting it from the database
|
Unwinds a certain block range, deleting it from the database
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage unwind --help
|
$ reth stage unwind --help
|
||||||
Usage: reth stage unwind [OPTIONS] <COMMAND>
|
Usage: reth stage unwind [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/unwind/num-blocks.md
vendored
2
book/cli/reth/stage/unwind/num-blocks.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Unwinds the given number of blocks from the database
|
Unwinds the given number of blocks from the database
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage unwind num-blocks --help
|
$ reth stage unwind num-blocks --help
|
||||||
Usage: reth stage unwind num-blocks [OPTIONS] <AMOUNT>
|
Usage: reth stage unwind num-blocks [OPTIONS] <AMOUNT>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/stage/unwind/to-block.md
vendored
2
book/cli/reth/stage/unwind/to-block.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Unwinds the database until the given block number (range is inclusive)
|
Unwinds the database until the given block number (range is inclusive)
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth stage unwind to-block --help
|
$ reth stage unwind to-block --help
|
||||||
Usage: reth stage unwind to-block [OPTIONS] <TARGET>
|
Usage: reth stage unwind to-block [OPTIONS] <TARGET>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/test-vectors.md
vendored
2
book/cli/reth/test-vectors.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Generate Test Vectors
|
Generate Test Vectors
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth test-vectors --help
|
$ reth test-vectors --help
|
||||||
Usage: reth test-vectors [OPTIONS] <COMMAND>
|
Usage: reth test-vectors [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
|
|||||||
2
book/cli/reth/test-vectors/tables.md
vendored
2
book/cli/reth/test-vectors/tables.md
vendored
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Generates test vectors for specified tables. If no table is specified, generate for all
|
Generates test vectors for specified tables. If no table is specified, generate for all
|
||||||
|
|
||||||
```bash
|
```text
|
||||||
$ reth test-vectors tables --help
|
$ reth test-vectors tables --help
|
||||||
Usage: reth test-vectors tables [OPTIONS] [NAMES]...
|
Usage: reth test-vectors tables [OPTIONS] [NAMES]...
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user