From bd6597707b39983e36773b4c1455c7351824a14f Mon Sep 17 00:00:00 2001 From: sfauvel Date: Tue, 20 Feb 2024 11:13:07 +0100 Subject: [PATCH] Remove doc generated --- .../protocol-demo/mithrildemo-command-line.md | 83 ---- .../mithril-aggregator-command-line.md | 415 ----------------- .../mithril-client-command-line.md | 438 ------------------ mithril-relay/mithril-relay-command-line.md | 198 -------- mithril-signer/mithril-signer-command-line.md | 100 ---- .../mithril-end-to-end-command-line.md | 145 ------ 6 files changed, 1379 deletions(-) delete mode 100644 demo/protocol-demo/mithrildemo-command-line.md delete mode 100644 mithril-aggregator/mithril-aggregator-command-line.md delete mode 100644 mithril-client-cli/mithril-client-command-line.md delete mode 100644 mithril-relay/mithril-relay-command-line.md delete mode 100644 mithril-signer/mithril-signer-command-line.md delete mode 100644 mithril-test-lab/mithril-end-to-end/mithril-end-to-end-command-line.md diff --git a/demo/protocol-demo/mithrildemo-command-line.md b/demo/protocol-demo/mithrildemo-command-line.md deleted file mode 100644 index 6eae338865d..00000000000 --- a/demo/protocol-demo/mithrildemo-command-line.md +++ /dev/null @@ -1,83 +0,0 @@ - - -### mithrildemo - -Simple demonstration of the Mithril protocol -```bash -Simple demonstration of the Mithril protocol - -Usage: mithrildemo [OPTIONS] - -Options: - -m, --m - Security parameter, upper bound on indices - - [default: 200] - - -k, --k - Quorum parameter - - [default: 5] - - --phi-f - f in phi(w) = 1 - (1 - f)^w, where w is the stake of a participant - - [default: 0.2] - - --nparties - Number of parties - - [default: 5] - - --nmessages - Number of messages to sign - - [default: 1] - - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **generate-doc** | Generate documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `m` | `--m` | `-m` | - | Security parameter, upper bound on indices | `200` | - | - | -| `k` | `--k` | `-k` | - | Quorum parameter | `5` | - | - | -| `phi_f` | `--phi-f` | - | - | f in phi(w) = 1 - (1 - f)^w, where w is the stake of a participant | `0.2` | - | - | -| `nparties` | `--nparties` | - | - | Number of parties | `5` | - | - | -| `nmessages` | `--nmessages` | - | - | Number of messages to sign | `1` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | -#### mithrildemo generate-doc - -Generate documentation -```bash -Generate documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | diff --git a/mithril-aggregator/mithril-aggregator-command-line.md b/mithril-aggregator/mithril-aggregator-command-line.md deleted file mode 100644 index 62e5ca1e6ee..00000000000 --- a/mithril-aggregator/mithril-aggregator-command-line.md +++ /dev/null @@ -1,415 +0,0 @@ - - -### mithril-aggregator - -Mithril Aggregator Node -```bash -Mithril Aggregator Node - -Usage: mithril-aggregator [OPTIONS] - -Commands: - genesis Genesis tools - era Era tools - serve Server runtime mode - tools List of tools to upkeep the aggregator - help Print this message or the help of the given subcommand(s) - -Options: - -r, --run-mode - Run Mode - - [default: dev] - - -v, --verbose... - Verbosity level - - --db-directory - Directory of the Cardano node files - - --config-directory - Directory where configuration file is located - - [default: ./config] - - -h, --help - Print help - - -V, --version - Print version - -``` -| Subcommand | Performed action | -|------------|------------------| -| **genesis** | Genesis tools | -| **era** | Era tools | -| **serve** | Server runtime mode | -| **tools** | List of tools to upkeep the aggregator | -| **generate-doc** | Generate documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `cardano_cli_path` | - | - | `CARDANO_CLI_PATH` | Cardano CLI tool path | - | `cardano-cli` | - | -| `cardano_node_socket_path` | - | - | `CARDANO_NODE_SOCKET_PATH` | Path of the socket used by the Cardano CLI tool
to communicate with the Cardano node | - | `/tmp/cardano.sock` | - | -| `cardano_node_version` | - | - | `CARDANO_NODE_VERSION` | Cardano node version.

**NOTE**: This cannot be verified for now (see [this
issue](https://github.com/input-output-hk/cardano-cli/issues/224)). This
is why it has to be manually given to the Aggregator | - | - | - | -| `cexplorer_pools_url` | - | - | `CEXPLORER_POOLS_URL` | Url to CExplorer list of pools to import as signer in the database. | - | - | - | -| `chain_observer_type` | - | - | `CHAIN_OBSERVER_TYPE` | Cardano chain observer type | - | - | - | -| `config_directory` | `--config-directory` | - | - | Directory where configuration file is located | `./config` | - | - | -| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store aggregator data (Certificates, Snapshots, Protocol Parameters, ...) | - | `./mithril-aggregator/stores` | - | -| `db_directory` | `--db-directory` | - | `DB_DIRECTORY` | Directory of the Cardano node files | `/db` | - | - | -| `disable_digests_cache` | - | - | `DISABLE_DIGESTS_CACHE` | Use the digest caching strategy | `false` | - | - | -| `environment` | - | - | `ENVIRONMENT` | What kind of runtime environment the configuration is meant to. | `Production` | - | - | -| `era_reader_adapter_params` | - | - | `ERA_READER_ADAPTER_PARAMS` | Era reader adapter parameters | - | - | - | -| `era_reader_adapter_type` | - | - | `ERA_READER_ADAPTER_TYPE` | Era reader adapter type | `bootstrap` | - | - | -| `genesis_verification_key` | - | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key | - | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | -| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | - | -| `network_magic` | - | - | `NETWORK_MAGIC` | Cardano Network Magic number

useful for TestNet & DevNet | - | `1097911063` or `42` | - | -| `protocol_parameters` | - | - | `PROTOCOL_PARAMETERS` | Protocol parameters | - | `{ k: 5, m: 100, phi_f: 0.65 }` | - | -| `reset_digests_cache` | - | - | `RESET_DIGESTS_CACHE` | Should the immutable cache be reset or not | `false` | - | - | -| `run_interval` | - | - | `RUN_INTERVAL` | Run Interval is the interval between two runtime cycles in ms | - | `60000` | - | -| `run_mode` | `--run-mode` | `-r` | - | Run Mode | `dev` | - | - | -| `server_ip` | - | - | `SERVER_IP` | Server listening IP | `0.0.0.0` | - | - | -| `server_port` | - | - | `SERVER_PORT` | Server listening port | `8080` | - | - | -| `signed_entity_types` | - | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list). | - | `MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution` | - | -| `signer_importer_run_interval` | - | - | `SIGNER_IMPORTER_RUN_INTERVAL` | Time interval at which the signers in [Self::cexplorer_pools_url] will be imported (in minutes). | `720` | - | - | -| `snapshot_bucket_name` | - | - | `SNAPSHOT_BUCKET_NAME` | Bucket name where the snapshots are stored if snapshot_uploader_type is Gcp | - | - | - | -| `snapshot_compression_algorithm` | - | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm used for the snapshot archive artifacts. | `zstandard` | `gzip` or `zstandard` | - | -| `snapshot_directory` | - | - | `SNAPSHOT_DIRECTORY` | Directory to store snapshot | `.` | - | - | -| `snapshot_store_type` | - | - | `SNAPSHOT_STORE_TYPE` | Type of snapshot store to use | `local` | `gcp` or `local` | - | -| `snapshot_uploader_type` | - | - | `SNAPSHOT_UPLOADER_TYPE` | Type of snapshot uploader to use | `gcp` | `gcp` or `local` | - | -| `snapshot_use_cdn_domain` | - | - | `SNAPSHOT_USE_CDN_DOMAIN` | Use CDN domain to construct snapshot urls if snapshot_uploader_type is Gcp | `false` | - | - | -| `store_retention_limit` | - | - | `STORE_RETENTION_LIMIT` | Max number of records in stores.
When new records are added, oldest records are automatically deleted so
there can always be at max the number of records specified by this
setting. | - | - | - | -| `verbose` | `--verbose` | `-v` | - | Verbosity level | `0` | - | - | -| `version` | `--version` | `-V` | - | Print version | - | - | - | -| `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS` | Specific parameters when [snapshot_compression_algorithm][Self::snapshot_compression_algorithm]
is set to [zstandard][CompressionAlgorithm::Zstandard]. | - | `{ level: 9, number_of_workers: 4 }` | - | -#### mithril-aggregator genesis - -Genesis tools -```bash -Genesis tools - -Usage: genesis - -Commands: - export Genesis certificate export command - import Genesis certificate import command - sign Genesis certificate sign command - bootstrap Genesis certificate bootstrap command - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **export** | Genesis certificate export command | -| **import** | Genesis certificate import command | -| **sign** | Genesis certificate sign command | -| **bootstrap** | Genesis certificate bootstrap command | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-aggregator genesis export - -Genesis certificate export command -```bash -Genesis certificate export command - -Usage: export --target-path - -Options: - --target-path - Target Path - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `target_path` | `--target-path` | - | - | Target Path | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-aggregator genesis import - -Genesis certificate import command -```bash -Genesis certificate import command - -Usage: import --signed-payload-path - -Options: - --signed-payload-path - Signed Payload Path - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `signed_payload_path` | `--signed-payload-path` | - | - | Signed Payload Path | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-aggregator genesis sign - -Genesis certificate sign command -```bash -Genesis certificate sign command - -Usage: sign --to-sign-payload-path --target-signed-payload-path --genesis-secret-key-path - -Options: - --to-sign-payload-path - To Sign Payload Path - - --target-signed-payload-path - Target Signed Payload Path - - --genesis-secret-key-path - Genesis Secret Key Path - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `to_sign_payload_path` | `--to-sign-payload-path` | - | - | To Sign Payload Path | - | - | :heavy_check_mark: | -| `target_signed_payload_path` | `--target-signed-payload-path` | - | - | Target Signed Payload Path | - | - | :heavy_check_mark: | -| `genesis_secret_key_path` | `--genesis-secret-key-path` | - | - | Genesis Secret Key Path | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-aggregator genesis bootstrap - -Genesis certificate bootstrap command -```bash -Genesis certificate bootstrap command - -Usage: bootstrap --genesis-secret-key - -Options: - --genesis-secret-key - Genesis Secret Key (test only) - - [env: GENESIS_SECRET_KEY=] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `genesis_secret_key` | `--genesis-secret-key` | - | `GENESIS_SECRET_KEY` | Genesis Secret Key (test only) | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-aggregator era - -Era tools -```bash -Era tools - -Usage: era - -Commands: - list Era list command - generate-tx-datum Era tx datum generate command - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **list** | Era list command | -| **generate-tx-datum** | Era tx datum generate command | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-aggregator era list - -Era list command -```bash -Era list command - -Usage: list [OPTIONS] - -Options: - --json - Enable JSON output - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-aggregator era generate-tx-datum - -Era tx datum generate command -```bash -Era tx datum generate command - -Usage: generate-tx-datum [OPTIONS] --current-era-epoch --era-markers-secret-key --target-path - -Options: - --current-era-epoch - Current Era epoch - - [env: CURRENT_ERA_EPOCH=] - - --next-era-epoch - Next Era epoch start, if exists - - [env: NEXT_ERA_EPOCH=] - - --era-markers-secret-key - Era Markers Secret Key - - [env: ERA_MARKERS_SECRET_KEY=] - - --target-path - Target Path - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `current_era_epoch` | `--current-era-epoch` | - | `CURRENT_ERA_EPOCH` | Current Era epoch | - | - | :heavy_check_mark: | -| `next_era_epoch` | `--next-era-epoch` | - | `NEXT_ERA_EPOCH` | Next Era epoch start, if exists | - | - | - | -| `era_markers_secret_key` | `--era-markers-secret-key` | - | `ERA_MARKERS_SECRET_KEY` | Era Markers Secret Key | - | - | :heavy_check_mark: | -| `target_path` | `--target-path` | - | - | Target Path | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-aggregator serve - -Server runtime mode -```bash -Server runtime mode - -Usage: serve [OPTIONS] - -Options: - --server-ip - Server listening IP - - --server-port - Server TCP port - - --snapshot-directory - Directory to store snapshot Defaults to work folder - - --disable-digests-cache - Disable immutables digests cache - - --reset-digests-cache - If set the existing immutables digests cache will be reset. - - Will be ignored if set in conjunction with `--disable-digests-cache`. - - -h, --help - Print help (see a summary with '-h') - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `server_ip` | `--server-ip` | - | - | Server listening IP | - | - | - | -| `server_port` | `--server-port` | - | - | Server TCP port | - | - | - | -| `snapshot_directory` | `--snapshot-directory` | - | - | Directory to store snapshot Defaults to work folder | - | - | - | -| `disable_digests_cache` | `--disable-digests-cache` | - | - | Disable immutables digests cache | `false` | - | - | -| `reset_digests_cache` | `--reset-digests-cache` | - | - | If set the existing immutables digests cache will be reset | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | - -#### mithril-aggregator tools - -List of tools to upkeep the aggregator -```bash -List of tools to upkeep the aggregator - -Usage: tools - -Commands: - recompute-certificates-hash Load all certificates in the database to recompute their hash and update all related entities - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **recompute-certificates-hash** | Load all certificates in the database to recompute their hash and update all related entities | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-aggregator tools recompute-certificates-hash - -Load all certificates in the database to recompute their hash and update all related entities -```bash -Load all certificates in the database to recompute their hash and update all related entities. - -Since it will modify the aggregator sqlite database it's strongly recommended to backup it before running this command. - -Usage: recompute-certificates-hash - -Options: - -h, --help - Print help (see a summary with '-h') - -``` - - - -#### mithril-aggregator generate-doc - -Generate documentation -```bash -Generate documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | diff --git a/mithril-client-cli/mithril-client-command-line.md b/mithril-client-cli/mithril-client-command-line.md deleted file mode 100644 index cccc11517e8..00000000000 --- a/mithril-client-cli/mithril-client-command-line.md +++ /dev/null @@ -1,438 +0,0 @@ - - -### mithril-client - -This program shows, downloads and verifies certified blockchain artifacts. -```bash -This program shows, downloads and verifies certified blockchain artifacts. - -Usage: mithril-client [OPTIONS] - -Commands: - snapshot Snapshot management - mithril-stake-distribution Mithril Stake Distribution management (alias: msd) - cardano-transaction [unstable] Cardano transactions management (alias: ctx) - help Print this message or the help of the given subcommand(s) - -Options: - --run-mode - Run Mode - - [env: RUN_MODE=] - [default: dev] - - -v, --verbose... - Verbosity level (-v=warning, -vv=info, -vvv=debug) - - --config-directory - Directory where configuration file is located - - [default: ./config] - - --aggregator-endpoint - Override configuration Aggregator endpoint URL - - [env: AGGREGATOR_ENDPOINT=] - - --log-format-json - Enable JSON output for logs displayed according to verbosity level - - --log-output - Redirect the logs to a file - - --unstable - Enable unstable commands (Such as Cardano Transactions) - - -h, --help - Print help - - -V, --version - Print version - -``` -| Subcommand | Performed action | -|------------|------------------| -| **snapshot** | Snapshot management | -| **mithril-stake-distribution** | Mithril Stake Distribution management (alias: msd) | -| **cardano-transaction** | [unstable] Cardano transactions management (alias: ctx) | -| **generate-doc** | Generate documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - | -| `verbose` | `--verbose` | `-v` | - | Verbosity level (-v=warning, -vv=info, -vvv=debug) | `0` | - | - | -| `config_directory` | `--config-directory` | - | - | Directory where configuration file is located | `./config` | - | - | -| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Override configuration Aggregator endpoint URL | - | - | - | -| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs displayed according to verbosity level | `false` | - | - | -| `log_output` | `--log-output` | - | - | Redirect the logs to a file | - | - | - | -| `unstable` | `--unstable` | - | - | Enable unstable commands (Such as Cardano Transactions) | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | -| `version` | `--version` | `-V` | - | Print version | - | - | - | -#### mithril-client snapshot - -Snapshot management -```bash -Snapshot management - -Usage: snapshot - -Commands: - list List available snapshots - show Show detailed informations about a snapshot - download Download the snapshot and verify the certificate - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **list** | List available snapshots | -| **show** | Show detailed informations about a snapshot | -| **download** | Download the snapshot and verify the certificate | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-client snapshot list - -List available snapshots -```bash -List available snapshots - -Usage: list [OPTIONS] - -Options: - --json - Enable JSON output - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-client snapshot show - -Show detailed informations about a snapshot -```bash -Show detailed informations about a snapshot - -Usage: show [OPTIONS] - -Arguments: - - Snapshot digest. - - If `latest` is specified as digest, the command will return the latest snapshot. - -Options: - --json - Enable JSON output - - -h, --help - Print help (see a summary with '-h') - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `digest` | - | - | - | Snapshot digest | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | - -##### mithril-client snapshot download - -Download the snapshot and verify the certificate -```bash -Download the snapshot and verify the certificate - -Usage: download [OPTIONS] - -Arguments: - - Digest of the snapshot to download. Use the `list` command to get that information. - - If `latest` is specified as digest, the command will return the latest snapshot. - -Options: - --json - Enable JSON output - - --download-dir - Directory where the snapshot will be downloaded. By default, a subdirectory will be created in this directory to extract and verify the certificate - - --genesis-verification-key - Genesis Verification Key to check the certificate chain - - [env: GENESIS_VERIFICATION_KEY=] - - -h, --help - Print help (see a summary with '-h') - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `digest` | - | - | - | Digest of the snapshot to download. Use the `list` command to get that information | - | - | :heavy_check_mark: | -| `download_dir` | `--download-dir` | - | - | Directory where the snapshot will be downloaded. By default, a subdirectory will be created in this directory to extract and verify the certificate | - | - | - | -| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis Verification Key to check the certificate chain | - | - | - | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | - -#### mithril-client mithril-stake-distribution - -Mithril Stake Distribution management (alias: msd) -```bash -Mithril Stake Distribution management (alias: msd) - -Usage: mithril-stake-distribution - -Commands: - list List certified stake distributions - download Download and verify the given Mithril Stake Distribution - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **list** | List certified stake distributions | -| **download** | Download and verify the given Mithril Stake Distribution | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-client mithril-stake-distribution list - -List certified stake distributions -```bash -List certified stake distributions - -Usage: list [OPTIONS] - -Options: - --json - Enable JSON output - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -##### mithril-client mithril-stake-distribution download - -Download and verify the given Mithril Stake Distribution -```bash -Download and verify the given Mithril Stake Distribution - -Usage: download [OPTIONS] - -Arguments: - - Hash of the Mithril Stake Distribution artifact. - - If `latest` is specified as artifact_hash, the command will return the latest stake distribution. - -Options: - --download-dir - Directory where the Mithril Stake Distribution will be downloaded. By default, a subdirectory will be created in this directory to extract and verify the certificate - - --genesis-verification-key - Genesis Verification Key to check the certificate chain - - [env: GENESIS_VERIFICATION_KEY=] - - -h, --help - Print help (see a summary with '-h') - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `artifact_hash` | - | - | - | Hash of the Mithril Stake Distribution artifact | - | - | :heavy_check_mark: | -| `download_dir` | `--download-dir` | - | - | Directory where the Mithril Stake Distribution will be downloaded. By default, a subdirectory will be created in this directory to extract and verify the certificate | - | - | - | -| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis Verification Key to check the certificate chain | - | - | - | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | - -#### mithril-client cardano-transaction - -[unstable] Cardano transactions management (alias: ctx) -```bash -[unstable] Cardano transactions management (alias: ctx) - -Usage: cardano-transaction - -Commands: - sets Cardano transaction sets commands - certify Certify that a given list of transaction hashes are included in the Cardano transactions set - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **sets** | Cardano transaction sets commands | -| **certify** | Certify that a given list of transaction hashes are included in the Cardano transactions set | -| **help** | Print this message or the help of the given subcommand(s) | - -##### mithril-client cardano-transaction sets - -Cardano transaction sets commands -```bash -Cardano transaction sets commands - -Usage: sets - -Commands: - list List Cardano transaction sets - show Show Cardano transaction sets - help Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help - -``` -| Subcommand | Performed action | -|------------|------------------| -| **list** | List Cardano transaction sets | -| **show** | Show Cardano transaction sets | -| **help** | Print this message or the help of the given subcommand(s) | - -###### mithril-client cardano-transaction sets list - -List Cardano transaction sets -```bash -List Cardano transaction sets - -Usage: list [OPTIONS] - -Options: - --json - Enable JSON output - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -###### mithril-client cardano-transaction sets show - -Show Cardano transaction sets -```bash -Show Cardano transaction sets - -Usage: show [OPTIONS] - -Arguments: - - Cardano transaction sets hash. - - If `latest` is specified as hash, the command will return the latest Cardano transaction sets. - -Options: - --json - Enable JSON output - - -h, --help - Print help (see a summary with '-h') - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `hash` | - | - | - | Cardano transaction sets hash | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | - -##### mithril-client cardano-transaction certify - -Certify that a given list of transaction hashes are included in the Cardano transactions set -```bash -Certify that a given list of transaction hashes are included in the Cardano transactions set - -Usage: certify [OPTIONS] ... - -Arguments: - ... - Hashes of the transactions to certify - -Options: - --json - Enable JSON output - - --genesis-verification-key - Genesis Verification Key to check the certificate chain - - [env: GENESIS_VERIFICATION_KEY=] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `json` | `--json` | - | - | Enable JSON output | `false` | - | - | -| `genesis_verification_key` | `--genesis-verification-key` | - | `GENESIS_VERIFICATION_KEY` | Genesis Verification Key to check the certificate chain | - | - | - | -| `transactions_hashes` | - | - | - | Hashes of the transactions to certify | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-client generate-doc - -Generate documentation -```bash -Generate documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | diff --git a/mithril-relay/mithril-relay-command-line.md b/mithril-relay/mithril-relay-command-line.md deleted file mode 100644 index d62c217ccd7..00000000000 --- a/mithril-relay/mithril-relay-command-line.md +++ /dev/null @@ -1,198 +0,0 @@ - - -### mithril-relay - -This program is a relay for Mithril nodes. -```bash -This program is a relay for Mithril nodes. - -Usage: mithril-relay [OPTIONS] - -Commands: - aggregator Run a relay for a Mithril aggregator - signer Run a relay for a Mithril signer - passive Run a passive relay (just a peer in the P2P network) - help Print this message or the help of the given subcommand(s) - -Options: - --run-mode - Run Mode - - [env: RUN_MODE=] - [default: dev] - - -v, --verbose... - Verbosity level (-v=warning, -vv=info, -vvv=debug) - - --config-directory - Directory where configuration file is located - - [default: ./config] - - -h, --help - Print help - - -V, --version - Print version - -``` -| Subcommand | Performed action | -|------------|------------------| -| **aggregator** | Run a relay for a Mithril aggregator | -| **signer** | Run a relay for a Mithril signer | -| **passive** | Run a passive relay (just a peer in the P2P network) | -| **generate-doc** | Generate command line documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `run_mode` | `--run-mode` | - | `RUN_MODE` | Run Mode | `dev` | - | - | -| `verbose` | `--verbose` | `-v` | - | Verbosity level (-v=warning, -vv=info, -vvv=debug) | `0` | - | - | -| `config_directory` | `--config-directory` | - | - | Directory where configuration file is located | `./config` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | -| `version` | `--version` | `-V` | - | Print version | - | - | - | -#### mithril-relay aggregator - -Run a relay for a Mithril aggregator -```bash -Run a relay for a Mithril aggregator - -Usage: aggregator [OPTIONS] --aggregator-endpoint - -Options: - --listen-port - Peer listening port - - [env: LISTEN_PORT=] - [default: 0] - - --dial-to - Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) - - [env: DIAL_TO=] - - --aggregator-endpoint - Aggregator endpoint URL - - [env: AGGREGATOR_ENDPOINT=] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `listen_port` | `--listen-port` | - | `LISTEN_PORT` | Peer listening port | `0` | - | - | -| `dial_to` | `--dial-to` | - | `DIAL_TO` | Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) | - | - | - | -| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator endpoint URL | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-relay signer - -Run a relay for a Mithril signer -```bash -Run a relay for a Mithril signer - -Usage: signer [OPTIONS] --aggregator-endpoint - -Options: - --server-port - HTTP Server listening port - - [env: SERVER_PORT=] - [default: 3132] - - --listen-port - Peer listening port - - [env: LISTEN_PORT=] - [default: 0] - - --dial-to - Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) - - [env: DIAL_TO=] - - --aggregator-endpoint - Aggregator endpoint URL - - [env: AGGREGATOR_ENDPOINT=] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `server_port` | `--server-port` | - | `SERVER_PORT` | HTTP Server listening port | `3132` | - | - | -| `listen_port` | `--listen-port` | - | `LISTEN_PORT` | Peer listening port | `0` | - | - | -| `dial_to` | `--dial-to` | - | `DIAL_TO` | Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) | - | - | - | -| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator endpoint URL | - | - | :heavy_check_mark: | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-relay passive - -Run a passive relay (just a peer in the P2P network) -```bash -Run a passive relay (just a peer in the P2P network) - -Usage: passive [OPTIONS] - -Options: - --listen-port - Peer listening port - - [env: LISTEN_PORT=] - [default: 0] - - --dial-to - Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) - - [env: DIAL_TO=] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `listen_port` | `--listen-port` | - | `LISTEN_PORT` | Peer listening port | `0` | - | - | -| `dial_to` | `--dial-to` | - | `DIAL_TO` | Dial to peer multi-address (e.g. /ip4/0.0.0.0/tcp/1234) | - | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | - -#### mithril-relay generate-doc - -Generate command line documentation -```bash -Generate command line documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | diff --git a/mithril-signer/mithril-signer-command-line.md b/mithril-signer/mithril-signer-command-line.md deleted file mode 100644 index 657dbd48653..00000000000 --- a/mithril-signer/mithril-signer-command-line.md +++ /dev/null @@ -1,100 +0,0 @@ - - -### mithril-signer - -An implementation of a Mithril Signer -```bash -An implementation of a Mithril Signer - -Usage: mithril-signer [OPTIONS] - -Options: - -r, --run-mode - Run Mode - - [env: RUN_MODE=] - [default: dev] - - -v, --verbose... - Verbosity level, add more v to increase - - -c, --configuration-dir - Directory where the configuration file is located - - [default: ./config] - - --disable-digests-cache - Disable immutables digests cache - - --reset-digests-cache - If set the existing immutables digests cache will be reset. - - Will be ignored if set in conjunction with `--disable-digests-cache`. - - -h, --help - Print help (see a summary with '-h') - - -V, --version - Print version - -``` -| Subcommand | Performed action | -|------------|------------------| -| **generate-doc** | Generate documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `aggregator_endpoint` | - | - | `AGGREGATOR_ENDPOINT` | Aggregator endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | - | -| `cardano_cli_path` | - | - | `CARDANO_CLI_PATH` | Cardano CLI tool path | - | `cardano-cli` | - | -| `cardano_node_socket_path` | - | - | `CARDANO_NODE_SOCKET_PATH` | Path of the socket used by the Cardano CLI tool
to communicate with the Cardano node | - | `/tmp/cardano.sock` | - | -| `command` | - | - | `COMMAND` | Available commands | - | - | - | -| `configuration_dir` | `--configuration-dir` | `-c` | `CONFIGURATION_DIR` | Directory where the configuration file is located | `./config` | - | - | -| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store signer data (Stakes, Protocol initializers, ...) | - | `./mithril-signer/stores` | - | -| `db_directory` | - | - | `DB_DIRECTORY` | Directory to snapshot | - | - | - | -| `disable_digests_cache` | `--disable-digests-cache` | - | `DISABLE_DIGESTS_CACHE` | Disable immutables digests cache | `false` | - | - | -| `era_reader_adapter_params` | - | - | `ERA_READER_ADAPTER_PARAMS` | Era reader adapter parameters | - | - | - | -| `era_reader_adapter_type` | - | - | `ERA_READER_ADAPTER_TYPE` | Era reader adapter type | `bootstrap` | - | - | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | -| `kes_secret_key_path` | - | - | `KES_SECRET_KEY_PATH` | File path to the KES secret key of the pool | - | - | - | -| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | - | -| `network_magic` | - | - | `NETWORK_MAGIC` | Cardano Network Magic number
useful for TestNet & DevNet | - | `1097911063` or `42` | - | -| `operational_certificate_path` | - | - | `OPERATIONAL_CERTIFICATE_PATH` | File path to the operational certificate of the pool | - | - | - | -| `party_id` | - | - | `PARTY_ID` | Party Id | - | `pool1pxaqe80sqpde7902er5kf6v0c7y0sv6d5g676766v2h829fvs3x` | - | -| `relay_endpoint` | - | - | `RELAY_ENDPOINT` | Relay endpoint | - | - | - | -| `reset_digests_cache` | `--reset-digests-cache` | - | `RESET_DIGESTS_CACHE` | If set the existing immutables digests cache will be reset | `false` | - | - | -| `run_interval` | - | - | `RUN_INTERVAL` | Run Interval | - | `60000` | - | -| `run_mode` | `--run-mode` | `-r` | `RUN_MODE` | Run Mode | `dev` | - | - | -| `store_retention_limit` | - | - | `STORE_RETENTION_LIMIT` | Store retention limit. If set to None, no limit will be set. | - | - | - | -| `verbose` | `--verbose` | `-v` | `VERBOSE` | Verbosity level, add more v to increase | `0` | Parsed from the number of occurrences: `-v` for `Warning`, `-vv` for `Info`, `-vvv` for `Debug` and `-vvvv` for `Trace` | - | -| `version` | `--version` | `-V` | - | Print version | - | - | - | -#### mithril-signer generate-doc - -Generate documentation -```bash -Generate documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - | diff --git a/mithril-test-lab/mithril-end-to-end/mithril-end-to-end-command-line.md b/mithril-test-lab/mithril-end-to-end/mithril-end-to-end-command-line.md deleted file mode 100644 index 431572f773c..00000000000 --- a/mithril-test-lab/mithril-end-to-end/mithril-end-to-end-command-line.md +++ /dev/null @@ -1,145 +0,0 @@ - - -### mithril-end-to-end - -Tests args -```bash -Tests args - -Usage: mithril-end-to-end [OPTIONS] - -Options: - --work-directory - A directory where all logs, generated devnet artefacts, snapshots and store folder will be located. - - Optional: if not set it will default to `{system_temp_folder}/mithril-end-to-end` Exception for MacOS: default is `./mithril-end-to-end` as the length of the temporary directory's path is too long. It causes the maximum path size of the node.sock file to be exceeded. - - --devnet-scripts-directory - Directory containing scripts to boostrap a devnet - - [default: ./devnet] - - --bin-directory - Directory to the mithril binaries - - It must contains the binaries of the aggregator, signer and client. - - Defaults to current folder - - [default: .] - - --number-of-bft-nodes - Number of BFT nodes in the devnet - - [default: 1] - - --number-of-pool-nodes - Number of Pool nodes in the devnet - - [default: 2] - - --cardano-slot-length - Length of a Cardano slot in the devnet (in s) - - [default: 0.08] - - --cardano-epoch-length - Length of a Cardano epoch in the devnet (in s) - - [default: 30] - - --cardano-node-version - Cardano node version - - [default: 8.7.3] - - --cardano-hard-fork-latest-era-at-epoch - Epoch at which hard fork to the latest Cardano era will be made (starts with the latest era by default) - - [default: 0] - - --mithril-era - Mithril era to run - - [default: thales] - - --mithril-era-reader-adapter - Mithril era reader adapter - - [default: cardano-chain] - - --signed-entity-types - Signed entity types parameters (discriminants names in an ordered comma separated list) - - [default: CardanoTransactions] - - --run-only - Enable run only mode - - --use-p2p-network - Enable P2P network mode - - --skip-cardano-bin-download - Skip cardano binaries download - - -v, --verbose... - Verbosity level, add more v to increase - - -h, --help - Print help (see a summary with '-h') - -``` -| Subcommand | Performed action | -|------------|------------------| -| **generate-doc** | Generate documentation | -| **help** | Print this message or the help of the given subcommand(s) | - -The configuration parameters can be set in either of the following ways: - -1. In a configuration file, depending on the `--run-mode` parameter. If the runtime mode is `testnet`, the file is located in `./conf/testnet.json`. - -2. The value can be overridden by an environment variable with the parameter name in uppercase. - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `work_directory` | `--work-directory` | - | - | A directory where all logs, generated devnet artefacts, snapshots and store folder will be located | - | - | - | -| `devnet_scripts_directory` | `--devnet-scripts-directory` | - | - | Directory containing scripts to boostrap a devnet | `./devnet` | - | - | -| `bin_directory` | `--bin-directory` | - | - | Directory to the mithril binaries | `.` | - | - | -| `number_of_bft_nodes` | `--number-of-bft-nodes` | - | - | Number of BFT nodes in the devnet | `1` | - | - | -| `number_of_pool_nodes` | `--number-of-pool-nodes` | - | - | Number of Pool nodes in the devnet | `2` | - | - | -| `cardano_slot_length` | `--cardano-slot-length` | - | - | Length of a Cardano slot in the devnet (in s) | `0.08` | - | - | -| `cardano_epoch_length` | `--cardano-epoch-length` | - | - | Length of a Cardano epoch in the devnet (in s) | `30` | - | - | -| `cardano_node_version` | `--cardano-node-version` | - | - | Cardano node version | `8.7.3` | - | - | -| `cardano_hard_fork_latest_era_at_epoch` | `--cardano-hard-fork-latest-era-at-epoch` | - | - | Epoch at which hard fork to the latest Cardano era will be made (starts with the latest era by default) | `0` | - | - | -| `mithril_era` | `--mithril-era` | - | - | Mithril era to run | `thales` | - | - | -| `mithril_era_reader_adapter` | `--mithril-era-reader-adapter` | - | - | Mithril era reader adapter | `cardano-chain` | - | - | -| `signed_entity_types` | `--signed-entity-types` | - | - | Signed entity types parameters (discriminants names in an ordered comma separated list) | `CardanoTransactions` | - | - | -| `run_only` | `--run-only` | - | - | Enable run only mode | `false` | - | - | -| `use_p2p_network` | `--use-p2p-network` | - | - | Enable P2P network mode | `false` | - | - | -| `skip_cardano_bin_download` | `--skip-cardano-bin-download` | - | - | Skip cardano binaries download | `false` | - | - | -| `verbose` | `--verbose` | `-v` | - | Verbosity level, add more v to increase | `0` | - | - | -| `help` | `--help` | `-h` | - | Print help (see more with '--help') | - | - | - | -#### mithril-end-to-end generate-doc - -Generate documentation -```bash -Generate documentation - -Usage: generate-doc [OPTIONS] - -Options: - --output - Generated documentation file - - [default: "[PROGRAM NAME]-command-line.md"] - - -h, --help - Print help - -``` - - -| Parameter | Command line (long) | Command line (short) | Environment variable | Description | Default value | Example | Mandatory | -|-----------|---------------------|:--------------------:|----------------------|-------------|---------------|---------|:---------:| -| `output` | `--output` | - | - | Generated documentation file | `[PROGRAM NAME]-command-line.md` | - | - | -| `help` | `--help` | `-h` | - | Print help | - | - | - |