Skip to content

Commit dfa79f0

Browse files
author
Clément Turmel
committed
refactor(docs): remove --json from subcommand tables
1 parent bb83ef0 commit dfa79f0

File tree

1 file changed

+3
-26
lines changed

1 file changed

+3
-26
lines changed

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

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@ Options:
234234
Directory where configuration file is located [default: ./config]
235235
--aggregator-endpoint <AGGREGATOR_ENDPOINT>
236236
Override configuration Aggregator endpoint URL [env: AGGREGATOR_ENDPOINT=]
237+
--json
238+
Enable JSON output for command results
237239
--log-format-json
238240
Enable JSON output for logs displayed according to verbosity level
239241
--log-output <LOG_OUTPUT>
@@ -539,6 +541,7 @@ Here is a list of the available parameters:
539541
| `unstable` | `--unstable` | - | - | Enable unstable commands | `false` | - | - |
540542
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | :heavy_check_mark: |
541543
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Override configuration Aggregator endpoint URL | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
544+
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
542545
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs displayed according to verbosity level | `false` | - | - |
543546
| `log_output` | `--log-output` | - | - | Redirect the logs to a file | - | - | - |
544547
| `origin_tag` | `--origin-tag` | - | - | Request origin tag | - | - | - |
@@ -548,22 +551,19 @@ Here is a list of the available parameters:
548551

549552
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
550553
| --------- | ------------------- | :------------------: | -------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
551-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
552554
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
553555
| `digest` | - | - | - | Digest of the Cardano db snapshot to show or `latest` for the latest artifact | - | - | :heavy_check_mark: |
554556

555557
`cardano-db snapshot list` command:
556558

557559
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
558560
| --------- | ------------------- | :------------------: | -------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :-------: |
559-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
560561
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
561562

562563
`cardano-db download` command:
563564

564565
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
565566
| ---------------------------- | ------------------------------ | :------------------: | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
566-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
567567
| `backend` | `--backend` | `-b` | - | Backend to use, either: `v1` (default, full database restoration only) or `v2` (full or partial database restoration) | `v1` | - | - |
568568
| `digest` | - | - | - | Digest of the Cardano db snapshot to download or `latest` for the latest artifact | - | - | :heavy_check_mark: |
569569
| `download_dir` | `--download-dir` | - | - | Directory where the immutable and ancillary files will be downloaded | - | - | - |
@@ -579,22 +579,14 @@ Here is a list of the available parameters:
579579
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
580580
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | ------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
581581
| `backend` | `--backend` | `-b` | - | - | `v2` | - | - |
582-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
583582
| `digest` | - | - | - | Digest of the Cardano db snapshot to verify or `latest` for the latest artifact | - | - | :heavy_check_mark: |
584583
| `db_dir` | `--db-dir` | - | - | Directory from where the immutable will be verified | - | - | - |
585584
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | - |
586585

587-
`mithril-stake-distribution list` command:
588-
589-
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
590-
| --------- | ------------------- | :------------------: | -------------------- | -------------------------------------- | ------------- | ------- | :-------: |
591-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
592-
593586
`mithril-stake-distribution download` command:
594587

595588
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
596589
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | ------------------------------------------------------------------------------------ | ------------- | ------- | :----------------: |
597-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
598590
| `artifact_hash` | - | - | - | Hash of the Mithril stake distribution artifact, or `latest` for the latest artifact | - | - | :heavy_check_mark: |
599591
| `download_dir` | `--download-dir` | - | - | Directory where the Mithril stake distribution will be downloaded | - | - | - |
600592
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | :heavy_check_mark: |
@@ -603,34 +595,19 @@ Here is a list of the available parameters:
603595

604596
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
605597
| --------- | ------------------- | :------------------: | -------------------- | ------------------------------------------------------------------------------------ | ------------- | ------- | :----------------: |
606-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
607598
| `hash` | - | - | - | Hash of the Cardano transaction snapshot to show or `latest` for the latest artifact | - | - | :heavy_check_mark: |
608599

609-
`cardano-transaction snapshot list` command:
610-
611-
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
612-
| --------- | ------------------- | :------------------: | -------------------- | -------------------------------------- | ------------- | ------- | :-------: |
613-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
614-
615600
`cardano-transaction certify` command:
616601

617602
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
618603
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | ------------------------------------------------------- | ------------- | ------- | :----------------: |
619-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
620604
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | :heavy_check_mark: |
621605
| `transactions_hashes` | - | - | - | Hashes of the transactions to certify | - | - | :heavy_check_mark: |
622606

623-
`cardano-stake-distribution list` command:
624-
625-
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
626-
| --------- | ------------------- | :------------------: | -------------------- | -------------------------------------- | ------------- | ------- | :-------: |
627-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
628-
629607
`cardano-stake-distribution download` command:
630608

631609
| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory |
632610
| -------------------------- | ---------------------------- | :------------------: | -------------------------- | --------------------------------------------------------------------------------------------- | ------------- | ------- | :----------------: |
633-
| `json` | `--json` | - | - | Enable JSON output for command results | `false` | - | - |
634611
| `unique_identifier` | - | - | - | Hash or Epoch of the Cardano stake distribution artifact, or `latest` for the latest artifact | - | - | :heavy_check_mark: |
635612
| `download_dir` | `--download-dir` | - | - | Directory where the Cardano stake distribution will be downloaded | - | - | - |
636613
| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key to check the certificate chain | - | - | :heavy_check_mark: |

0 commit comments

Comments
 (0)