Skip to content

Commit af9aeaa

Browse files
committed
Updated README.md
1 parent a09c943 commit af9aeaa

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Knox
22
> AWS credential process helper
33
4-
```
5-
$ knox select
6-
$ knox creds select
7-
$ knox creds last-used
8-
$ knox clean creds sso -a
9-
```
4+
5+
6+
## About
7+
8+
Knox is a powerful utility designed to simplify and streamline the process of managing AWS credentials. Whether you're frequently switching between different AWS profiles or managing credentials issuance in an SSO environment, Knox provides a straightforward CLI tool to handle these tasks effortlessly. Commands like `knox select`, `knox creds select`, `knox creds last-used`, and `knox clean` make it easy to navigate and manipulate your AWS credential configurations. Its configurable nature, showcased in the `~/.aws/config` setup recommendations, ensures seamless integration into your AWS workflows. Whether you're in development, staging, or production, Knox helps maintain efficient and secure AWS credential management.
109

1110
## Install
1211

@@ -99,7 +98,7 @@ $ knox clean creds sso -a
9998

10099
## Setup
101100

102-
Recommended configuration for `~/.aws/config`:
101+
Recommended configuration for `~/.aws/config`, feel free to swap out the commands to suit your needs:
103102

104103
```
105104
[default]
@@ -135,6 +134,8 @@ sso_start_url = https://d-0000000000.awsapps.com/start
135134

136135
## Example
137136

137+
Here is another use-case where this tool can come in handy. If you use SSM Session Manager to SSH into your EC2 instances, you can use knox to switch between different AWS profiles and start an interactive session with a specific instance. Here is an example of how you can achieve this:
138+
138139
```
139140
function ssh-aws () {
140141
if [[ $# -ne 1 ]]; then
@@ -145,6 +146,8 @@ function ssh-aws () {
145146
}
146147
```
147148

149+
Now you can SSH into an EC2 instance using the following command:
150+
148151
```
149152
ssh-aws i-00000000000000000
150153
```

0 commit comments

Comments
 (0)