Skip to content

Commit

Permalink
feat: add docs to README and remove colon from input request
Browse files Browse the repository at this point in the history
  • Loading branch information
johnson2427 committed Jul 1, 2024
1 parent 335640c commit 862a5e5
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,37 @@ ape aws -h
To create a new key:

```bash
ape aws kms create 'KeyAlias' 'Description of new key'
ape aws kms create KeyAlias 'Description of new key'
```

To delete this key:

```bash
ape aws kms delete 'KeyAlias'
ape aws kms delete KeyAlias
```

To import an existing private key into KMS:

```bash
$ ape aws kms import KeyAlias
Enter your private key:
SUCCESS (ape-aws): Key imported successfully with ID: <key-id>
```

You can also import a private key from a file (from hex or bytes):

```bash
$ ape aws kms import KeyAlias --private-key <path-to-private-key>
INFO (ape-aws): Reading private key from <private-key-file>
SUCCESS (ape-aws): Key imported successfully with ID: <key-id>
```

You can import using a mnemonic phrase as well:

```bash
$ ape aws kms import KeyAlias --use-mnemonic
Enter your mnemonic phrase:
SUCCESS (ape-aws): Key imported successfully with ID: <key-id>
```

### IPython
Expand Down
2 changes: 1 addition & 1 deletion ape_aws/kms/_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def import_key(
private_key = account.key.hex()

else:
private_key = click.prompt("Enter your private key: ", hide_input=True)
private_key = click.prompt("Enter your private key", hide_input=True)

key_spec = ImportKeyRequest(
alias=alias_name,
Expand Down

0 comments on commit 862a5e5

Please sign in to comment.