Skip to content

Commit

Permalink
Make --non_interactive flag visible and add notes in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hwwhww committed Mar 13, 2023
1 parent ee052fa commit 69f778d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
- [Option 1. Download binary executable file](#option-1-download-binary-executable-file)
- [Step 1. Installation](#step-1-installation)
- [Step 2. Create keys and `deposit_data-*.json`](#step-2-create-keys-and-deposit_data-json)
- [language Argument](#language-argument)
- [`language` Argument](#language-argument)
- [`--non_interactive` flag](#--non_interactive-flag)
- [Commands](#commands)
- [`new-mnemonic` Arguments](#new-mnemonic-arguments)
- [`existing-mnemonic` Arguments](#existing-mnemonic-arguments)
Expand Down Expand Up @@ -113,14 +114,22 @@ or run the following command to enter the interactive CLI and generate keys from
./deposit existing-mnemonic
```

###### language Argument
###### `language` Argument

The Launchpad offers many language/internationalization options. If you wish to select one as a CLI argument, it must be passed in before one of the commands is chosen.

| Argument | Type | Description |
| -------- | -------- | -------- |
| `--language` | String. Options: `العربية`, `ελληνικά`, `English`, `Français`, `Bahasa melayu`, `Italiano`, `日本語`, `한국어`, `Português do Brasil`, `român`, `简体中文`. Default to `English` | The language you wish to use the CLI in. |

###### `--non_interactive` flag

**Warning: with this flag, there will be no confirmation step(s) to verify the input value(s). Please use it carefully.**

| Argument | Type | Description |
| -------- | -------- | -------- |
| `--non_interactive` | Flag | Run CLI in non-interactive mode. |

###### Commands

The CLI offers different commands depending on what you want to do with the tool.
Expand Down
4 changes: 2 additions & 2 deletions staking_deposit/deposit.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ def check_python_version() -> None:
'--non_interactive',
default=False,
is_flag=True,
help='Disables interactive prompts.',
hidden=True,
help='Disables interactive prompts. Warning: with this flag, there will be no confirmation step(s) to verify the input value(s). Please use it carefully.', # noqa: E501
hidden=False,
)
def cli(ctx: click.Context, language: str, non_interactive: bool) -> None:
config.language = language
Expand Down

0 comments on commit 69f778d

Please sign in to comment.