Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
castrapel committed Nov 4, 2020
1 parent 312b7fa commit 561b6e7
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ variables for your AWS needs.

## Configuration

Weep gets its configuration from a YAML-formatted file. We've included an example config file in
[example-config.yaml](example-config.yaml).
Weep can be compiled with an embedded configuration (See the Building section below), or it can get its configuration
from a YAML-formatted file. We've included an example config file in [example-config.yaml](example-config.yaml).

Weep searches for a configuration file in the following locations:

Expand All @@ -22,6 +22,8 @@ You can also specify a config file as a CLI arg:
weep --config somethingdifferent.yaml list
```



## Routing traffic

### Mac
Expand Down Expand Up @@ -171,6 +173,21 @@ profile you wanted to use. Example:
AWS_PROFILE=role1 aws s3 ls
```

#### Generating Credential Process Commands

Weep can also generate credential process commands and populate your ~/.aws/config file.

**CAUTION**

AWS SDKs appear to be analyzing your ~/.aws/config file on each API call
and this could drastically slow you down if your ~/.aws/config file is too large. We strongly recommend using Weep's
ECS credential provider to avoid this issue.

```bash
# Please read the caveat above before running this command. The size of your ~/.aws/config file may negatively impact
# the rate of your AWS API calls.
weep generate_credential_process_config
```
## Shell Completion

### Bash
Expand Down

0 comments on commit 561b6e7

Please sign in to comment.