Skip to content

Commit

Permalink
update usage, remove unnecessary default values
Browse files Browse the repository at this point in the history
  • Loading branch information
@Esgrove
Esgrove committed Oct 26, 2024
1 parent f056bce commit df961b7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 31 deletions.
60 changes: 29 additions & 31 deletions python-pyo3/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,35 @@ See the [root readme](../README.md) for more general information.
```console
Usage: vault [OPTIONS] COMMAND [ARGS]...

Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --bucket -b TEXT Override the bucket name [env var: VAULT_BUCKET] [default: None] │
│ --key-arn -k TEXT Override the KMS key ARN [env var: VAULT_KEY] [default: None] │
│ --prefix -p TEXT Optional prefix for key name [env var: VAULT_PREFIX] [default: None] │
│ --region -r TEXT Specify AWS region for the bucket [env var: AWS_REGION] [default: None] │
│ --vault-stack TEXT Specify CloudFormation stack name to use [env var: VAULT_STACK] │
│ [default: None] │
│ --quiet -q Suppress additional output and error messages │
│ --version -v Print version and exit │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the │
│ installation. │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ all | a | list | ls List available secrets │
│ decrypt Directly decrypt given value │
│ delete Delete an existing key from the store │
│ describe Describe CloudFormation stack parameters for current configuration │
│ encrypt Directly encrypt given value │
│ exists Check if a key exists │
│ id Print AWS user account information │
│ info Print vault information │
│ init Initialize a new KMS key and S3 bucket │
│ lookup Output secret value for given key │
│ status Print vault stack information │
│ store Store a new key-value pair │
│ update Update the vault CloudFormation stack │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Nitor Vault CLI, see https://github.com/nitorcreations/vault for usage examples

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --bucket -b TEXT Override the bucket name [env var: VAULT_BUCKET] │
│ --key-arn -k TEXT Override the KMS key ARN [env var: VAULT_KEY] │
│ --prefix -p TEXT Optional prefix for key name [env var: VAULT_PREFIX] │
│ --region -r TEXT Specify AWS region for the bucket [env var: AWS_REGION] │
│ --vault-stack TEXT Specify CloudFormation stack name to use [env var: VAULT_STACK] │
│ --quiet -q Suppress additional output and error messages │
│ --version -v Print version and exit │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help -h Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ all | a | list | ls List available secrets │
│ decrypt | y Directly decrypt given value │
│ delete | d Delete an existing key from the store │
│ describe Print CloudFormation stack parameters for current configuration │
│ encrypt | e Directly encrypt given value │
│ exists Check if a key exists │
│ id Print AWS user account information │
│ info Print vault information │
│ init | i Initialize a new KMS key and S3 bucket │
│ lookup | l Output secret value for given key │
│ status Print vault stack information │
│ store | s Store a new key-value pair │
│ update | u Update the vault CloudFormation stack │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Development
Expand Down
5 changes: 5 additions & 0 deletions python-pyo3/python/n_vault/vault.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,33 +58,38 @@ def main(
"-b",
envvar="VAULT_BUCKET",
help="Override the bucket name",
show_default=False,
),
key_arn: str | None = typer.Option(
None,
"--key-arn",
"-k",
envvar="VAULT_KEY",
help="Override the KMS key ARN",
show_default=False,
),
prefix: str | None = typer.Option(
None,
"--prefix",
"-p",
envvar="VAULT_PREFIX",
help="Optional prefix for key name",
show_default=False,
),
region: str | None = typer.Option(
None,
"--region",
"-r",
envvar="AWS_REGION",
help="Specify AWS region for the bucket",
show_default=False,
),
vault_stack: str | None = typer.Option(
None,
"--vault-stack",
envvar="VAULT_STACK",
help="Specify CloudFormation stack name to use",
show_default=False,
),
quiet: bool = typer.Option(
False,
Expand Down

0 comments on commit df961b7

Please sign in to comment.