Skip to content

Commit

Permalink
chore: minor readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
chaseconey authored Jul 13, 2024
1 parent 2d604f1 commit c9af16a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A CLI tool to easily SSH into an ECS container using SSM Session Manager.

## Pre-requisites

In order to use this tool, you will need:
To use this tool, you will need:

- the [AWS CLI](https://aws.amazon.com/cli/) installed on your machine (if you are executing the command)
- the [Session Manager plugin for the CLI](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) installed
Expand All @@ -20,7 +20,7 @@ In order to use this tool, you will need:
npx @chaseconey/let-me-in
```

This will prompt you through all of your clusters, services, tasks, and containers to give you the appropriate destination.
This will prompt you through your clusters, services, tasks, and containers to give you the appropriate destination.

### Example Usage

Expand All @@ -32,7 +32,7 @@ There are quite a few options that you can pass to streamline connecting to your
npx @chaseconey/let-me-in -c prod -s app-prod-1
```

This will skip prompting for the cluster and service, and move on to the task selection automatically.
This will skip prompting for the cluster and service and move on to the task selection automatically.

Additionally, if there is only 1 task and 1 container, it will assume that is what you want and move on.

Expand All @@ -46,15 +46,15 @@ This will search for resources in the `us-west-2` region. For a list of availabl

#### Printing, Rather than Executing

Sometimes you may want to just get the full AWS CLI command with all the identifier filled in, rather than executing the interactive shell. This can be useful if you want need to login multiple times and don't want to go through the questions over and over. It can also be helpful if you want to hand the command over to someone else to use.
Sometimes, you may want to get the full AWS CLI command with all the identifiers filled in rather than executing the interactive shell. This can be useful if you need to log in multiple times and don't want to go through the questions repeatedly. It can also be helpful if you want to hand the command over to someone else to use.

```
npx @chaseconey/let-me-in --print
```

### AWS Credential Handling

This CLI uses the AWS Javascript SDK, which uses the normal "AWS Credential Provider Chain". This basically means it will try and load the credentials in many different ways, but in a specific order.
This CLI uses the AWS Javascript SDK, which uses the normal "AWS Credential Provider Chain". This means it will try and load the credentials in many different ways but in a specific order.

For more details, check out the [AWS docs](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials-chain.html#credentials-default).

Expand Down

0 comments on commit c9af16a

Please # to comment.