Create CLI documentation with a Rust script (instead of Python) + style improvement (#10680)

This commit is contained in:
Hendrik Eeckhaut
2024-09-06 21:35:12 +02:00
committed by GitHub
parent 27d4e8c363
commit d1d544e23c
51 changed files with 468 additions and 296 deletions

View File

@ -4,6 +4,8 @@ Calculates the content checksum of a table
```bash
$ reth db checksum --help
```
```txt
Usage: reth db checksum [OPTIONS] <TABLE>
Arguments:

View File

@ -4,6 +4,8 @@ Deletes all table entries
```bash
$ reth db clear --help
```
```txt
Usage: reth db clear [OPTIONS] <COMMAND>
Commands:

View File

@ -4,6 +4,8 @@ Deletes all database table entries
```bash
$ reth db clear mdbx --help
```
```txt
Usage: reth db clear mdbx [OPTIONS] <TABLE>
Arguments:

View File

@ -4,6 +4,8 @@ Deletes all static file segment entries
```bash
$ reth db clear static-file --help
```
```txt
Usage: reth db clear static-file [OPTIONS] <SEGMENT>
Arguments:

View File

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

View File

@ -4,6 +4,8 @@ Deletes all database entries
```bash
$ reth db drop --help
```
```txt
Usage: reth db drop [OPTIONS]
Options:

View File

@ -4,6 +4,8 @@ Gets the content of a table for the given key
```bash
$ reth db get --help
```
```txt
Usage: reth db get [OPTIONS] <COMMAND>
Commands:

View File

@ -4,6 +4,8 @@ Gets the content of a database table for the given key
```bash
$ reth db get mdbx --help
```
```txt
Usage: reth db get mdbx [OPTIONS] <TABLE> <KEY> [SUBKEY]
Arguments:

View File

@ -4,6 +4,8 @@ Gets the content of a static file segment for the given key
```bash
$ reth db get static-file --help
```
```txt
Usage: reth db get static-file [OPTIONS] <SEGMENT> <KEY>
Arguments:

View File

@ -4,6 +4,8 @@ Lists the contents of a table
```bash
$ reth db list --help
```
```txt
Usage: reth db list [OPTIONS] <TABLE>
Arguments:

View File

@ -4,6 +4,8 @@ Returns the full database path
```bash
$ reth db path --help
```
```txt
Usage: reth db path [OPTIONS]
Options:

View File

@ -4,6 +4,8 @@ Lists all the tables, their entry count and their size
```bash
$ reth db stats --help
```
```txt
Usage: reth db stats [OPTIONS]
Options:

View File

@ -4,6 +4,8 @@ Lists current and local database versions
```bash
$ reth db version --help
```
```txt
Usage: reth db version [OPTIONS]
Options: