# @stewartml/aws-profile

> Simple wrapper around aws-vault to add a local config file

Latest version **1.0.1** (published 2019-10-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @stewartml/aws-profile
pnpm add @stewartml/aws-profile
yarn add @stewartml/aws-profile
bun add @stewartml/aws-profile
```

Provides the commands `awsp`, `aws-profile`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-10-02 |
| First published | 2019-10-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 2.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Stewart Everett |
| Maintainers | stewartml |
| Keywords | aws, security, aws-vault |

## Links

- npm: https://www.npmjs.com/package/@stewartml/aws-profile
- Repository: https://github.com/stewartml/aws-profile
- Homepage: https://github.com/stewartml/aws-profile#readme
- Issues: https://github.com/stewartml/aws-profile/issues
- npm.io page: https://npm.io/package/@stewartml/aws-profile

## Dependencies (3)

- [rc-yaml](https://npm.io/package/rc-yaml.md) ^2.0.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [command-join](https://npm.io/package/command-join.md) ^3.0.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-10-02
- 1.0.0 — 2019-10-02

## README

# aws-profile

This command is a really simple wrapper around [AWS Vault](https://github.com/99designs/aws-vault) which adds a local config file to save keystrokes and help prevent mistakes. From their README:

> AWS Vault is a tool to securely store and access AWS credentials in a development environment.

To run a command (e.g. S3 list) under a "home" profile with AWS Vault, you run:

```
$ aws-vault exec home -- aws s3 ls
```

With aws-profile, you can save your profile in a `.awsprofilerc` file like so:

```yaml
profile: home
```

Then, you can just run:

```
$ aws-profile s3 ls
```

Or even:

```
$ awsp s3 ls
```

Note that it assumes you want to run the `aws` executable. If you don't, you can use a double dash (`--`):

```
$ aws-profile -- env
# runs 'env'
```

## Installation

```
$ npm install --global @stewartml/aws-profile
```

## More details

This script uses [rc-yaml](https://www.npmjs.com/package/rc-yaml) for configuration, so your `.awsprofilerc` file can be in YAML, JSON, or INI format.

You can put the config anywhere `rc` looks by [default](https://www.npmjs.com/package/rc#standards), including the `awsprofile_profile` environment variable, but not including command line options, as they would interfere with the command.

Here's what it would look like to use an environment variable:

```
$ awsprofile_profile=home awsprofile s3 ls
```

Not sure why you'd do that though...

---
_Source: https://npm.io/package/@stewartml/aws-profile · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._