Skip to content

Commit b486457

Browse files
committed
feature(docs): update client CLI docs with args available in all commands
1 parent e79b500 commit b486457

File tree

6 files changed

+164
-47
lines changed

6 files changed

+164
-47
lines changed

docs/website/root/manual/develop/nodes/mithril-client.md

Lines changed: 157 additions & 44 deletions
Large diffs are not rendered by default.

mithril-client-cli/src/commands/cardano_db/download/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ const DB_DIRECTORY_NAME: &str = "db";
2020
/// Clap command to download a Cardano db and verify its associated certificate.
2121
#[derive(Parser, Debug, Clone)]
2222
pub struct CardanoDbDownloadCommand {
23+
///Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration)
2324
#[arg(short, long, value_enum, default_value_t)]
2425
backend: CardanoDbCommandsBackend,
2526

mithril-client-cli/src/commands/cardano_db/list.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ use mithril_client::{Client, MithrilResult};
1111
/// Clap command to list existing Cardano dbs
1212
#[derive(Parser, Debug, Clone)]
1313
pub struct CardanoDbListCommand {
14+
///Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration)
1415
#[arg(short, long, value_enum, default_value_t)]
1516
backend: CardanoDbCommandsBackend,
1617
}

mithril-client-cli/src/commands/cardano_db/show.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ use crate::{
1616
/// Clap command to show a given Cardano db
1717
#[derive(Parser, Debug, Clone)]
1818
pub struct CardanoDbShowCommand {
19+
///Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration)
1920
#[arg(short, long, value_enum, default_value_t)]
2021
backend: CardanoDbCommandsBackend,
2122

mithril-client-cli/src/commands/cardano_db/verify.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ use crate::{
2222
/// Clap command to verify a Cardano db and its associated certificate.
2323
#[derive(Parser, Debug, Clone)]
2424
pub struct CardanoDbVerifyCommand {
25+
///Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration)
2526
#[arg(short, long, value_enum, default_value_t = CardanoDbCommandsBackend::V2)]
2627
backend: CardanoDbCommandsBackend,
2728

mithril-client-cli/src/commands/tools/snapshot_converter.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ pub struct SnapshotConverterCommand {
121121
#[clap(long)]
122122
db_directory: PathBuf,
123123

124-
/// Cardano node version of the Mithril signed snapshot.
124+
/// Cardano node version of the Mithril signed snapshot (`latest` and `pre-release` are also supported to download the latest or pre-release distribution).
125125
///
126126
/// `latest` and `pre-release` are also supported to download the latest or pre-release distribution.
127127
#[clap(long)]
@@ -135,11 +135,11 @@ pub struct SnapshotConverterCommand {
135135
)]
136136
cardano_network: Option<CardanoNetwork>,
137137

138-
/// UTxO-HD flavor to convert the ledger snapshot to.
138+
/// UTxO-HD flavor to convert the ledger snapshot to (`Legacy` or `LMDB`).
139139
#[clap(long)]
140140
utxo_hd_flavor: UTxOHDFlavor,
141141

142-
/// If set, the converted snapshot replaces the current ledger state in the `db_directory`.
142+
/// Replaces the current ledger state in the `db_directory`.
143143
#[clap(long)]
144144
commit: bool,
145145

0 commit comments

Comments
 (0)