Skip to content

Commit

Permalink
chore: add pre-reqs, additional example to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chaseconey committed Jul 13, 2024
1 parent 45a5c7a commit 2d604f1
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ A CLI tool to easily SSH into an ECS container using SSM Session Manager.

[![asciicast](./demo.gif)](https://asciinema.org/a/ao7mlvJMdkfon36QhInqBK78I)

## Pre-requisites

In order 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
- your task/service to have the `enable-execute-command` flag set

## Quickstart

```
Expand Down Expand Up @@ -36,6 +44,14 @@ npx @chaseconey/let-me-in -r us-west-2

This will search for resources in the `us-west-2` region. For a list of available regions, check out the [AWS docs](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/).

#### 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.

```
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.
Expand Down

0 comments on commit 2d604f1

Please # to comment.