From 1d50d42cd70dfad35842df7568f54ab7990bc632 Mon Sep 17 00:00:00 2001 From: valefar-on-discord <124839138+valefar-on-discord@users.noreply.github.com> Date: Sun, 9 Jun 2024 11:39:09 -0500 Subject: [PATCH] Updating documentation to include command options --- docs/src/existing_mnemonic.md | 2 +- docs/src/exit_transaction_keystore.md | 2 +- docs/src/exit_transaction_mnemonic.md | 2 +- docs/src/generate_bls_to_execution_change.md | 2 +- docs/src/landing.md | 16 ++++++++++++++++ docs/src/new_mnemonic.md | 2 +- docs/src/quick_setup.md | 2 ++ 7 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/src/existing_mnemonic.md b/docs/src/existing_mnemonic.md index 1a7d4548..61b13d93 100644 --- a/docs/src/existing_mnemonic.md +++ b/docs/src/existing_mnemonic.md @@ -3,7 +3,7 @@ ## Description Uses an existing BIP-39 mnemonic phrase for key generation. -## Arguments +## Optional Arguments - **`--chain`**: The chain to use for generating the deposit data. Options are: 'mainnet', 'holesky', etc... diff --git a/docs/src/exit_transaction_keystore.md b/docs/src/exit_transaction_keystore.md index 17bb92d9..8e03c430 100644 --- a/docs/src/exit_transaction_keystore.md +++ b/docs/src/exit_transaction_keystore.md @@ -3,7 +3,7 @@ ## Description Creates an exit transaction using a keystore file. -## Arguments +## Optional Arguments - **`--chain`**: The chain to use for generating the deposit data. Options are: 'mainnet', 'holesky', etc. diff --git a/docs/src/exit_transaction_mnemonic.md b/docs/src/exit_transaction_mnemonic.md index 65a4f3b2..7dab90c0 100644 --- a/docs/src/exit_transaction_mnemonic.md +++ b/docs/src/exit_transaction_mnemonic.md @@ -3,7 +3,7 @@ ## Description Creates an exit transaction using a mnemonic phrase. -## Arguments +## Optional Arguments - **`--chain`**: The chain to use for generating the deposit data. Options are: 'mainnet', 'holesky', etc. diff --git a/docs/src/generate_bls_to_execution_change.md b/docs/src/generate_bls_to_execution_change.md index 6f0bf9ac..efb574a6 100644 --- a/docs/src/generate_bls_to_execution_change.md +++ b/docs/src/generate_bls_to_execution_change.md @@ -3,7 +3,7 @@ ## Description Generates a BLS to execution address change message. -## Arguments +## Optional Arguments - **`--bls_to_execution_changes_folder`**: The path to store the change JSON file. diff --git a/docs/src/landing.md b/docs/src/landing.md index 2a66a9be..b7ae517d 100644 --- a/docs/src/landing.md +++ b/docs/src/landing.md @@ -18,6 +18,22 @@ Here are some core recommendations: If you want to start creating validator keys, please follow the [Quick Setup Instructions](quick_setup.md) or if you would like to run locally, view the [Local Development Instructions](local_development.md). +The general usage of the CLI is: +```sh +./deposit [OPTIONS] COMMAND [ARGS] +``` + +## Command Options + +Each CLI command has a number of command options that can be provided: + +- **--language**: The language you wish to use the CLI in. Options: العربية, ελληνικά, English, Français, Bahasa melayu, Italiano, 日本語, 한국어, Português do Brasil, român, 简体中文. Default to English. + +- **--non_interactive**: Run CLI in non-interactive mode. This will skip all confirmation and internet connectivity checks. + +- **--ignore_connectivity**: Skip internet connectivity check and warning. + + ## Commands **You are not required to specify each argument when executing the command. We will prompt you for each argument for security purposes.** diff --git a/docs/src/new_mnemonic.md b/docs/src/new_mnemonic.md index 14c8ed6c..99f05f6c 100644 --- a/docs/src/new_mnemonic.md +++ b/docs/src/new_mnemonic.md @@ -3,7 +3,7 @@ ## Description Generates a new BIP-39 mnemonic along with validator keystore and deposit files depending on how many validators you wish to create. -## Arguments +## Optional Arguments - **`--mnemonic_language`**: The language of the BIP-39 mnemonic. Options are: 'chinese_simplified', 'chinese_traditional', 'czech', 'english', 'french', 'italian', 'japanese', 'korean', 'portuguese', 'spanish'. diff --git a/docs/src/quick_setup.md b/docs/src/quick_setup.md index e84b6d14..c1c3ff21 100644 --- a/docs/src/quick_setup.md +++ b/docs/src/quick_setup.md @@ -34,6 +34,8 @@ gpg --verify staking_deposit-cli-***.asc staking_deposit-cli-*** ## Step 3: Usage +**Windows users:** You should replace `./deposit` with `deposit.exe` to run properly. + **MacOS users:** In order to run from the terminal, you must first open the file to bypass MacOS code signing issues. Do so by right clicking the `deposit` file and then selecting `Open`. Determine which command best suites what you would like to accomplish: