# aws-sdk-config-loader

> AWS config file loader for CLI tools

Latest version **1.0.1** (published 2016-03-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-sdk-config-loader
pnpm add aws-sdk-config-loader
yarn add aws-sdk-config-loader
bun add aws-sdk-config-loader
```

## 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 | 2016-03-22 |
| First published | 2015-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | moqada |
| Maintainers | moqada |
| Keywords | aws, cli |

## Links

- npm: https://www.npmjs.com/package/aws-sdk-config-loader
- Repository: https://github.com/moqada/aws-sdk-config-loader
- Homepage: https://github.com/moqada/aws-sdk-config-loader#readme
- Issues: https://github.com/moqada/aws-sdk-config-loader/issues
- npm.io page: https://npm.io/package/aws-sdk-config-loader

## Dependencies (2)

- [os-homedir](https://npm.io/package/os-homedir.md) ^1.0.1
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.6.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-03-22
- 1.0.0 — 2016-01-03
- 0.3.1 — 2015-09-22
- 0.3.0 — 2015-09-22
- 0.2.0 — 2015-09-14
- 0.1.2 — 2015-09-10
- 0.1.1 — 2015-09-10
- 0.1.0 — 2015-09-06

## README

# aws-sdk-config-loader

[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-download-image]][npm-download-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][codecov-image]][codecov-url]
[![DevDependency Status][daviddm-dev-image]][daviddm-dev-url]
[![License][license-image]][license-url]

AWS config file loader for CLI tools.

this library load `~/.aws/config` that [aws-sdk-js](https://github.com/aws/aws-sdk-js) is not supported.


## Installation

```
npm install aws-sdk-config-loader aws-sdk
```


## Usage

API Document: https://moqada.github.io/aws-sdk-config-loader/

put following `~/.aws/credentials`

```
[default]
aws_access_key_id = default_key_id
aws_secret_access_key = default_secret_key
[foo]
aws_access_key_id = foo_key_id
aws_secret_access_key = foo_secret_key
```

put following `~/.aws/config`.

```
[default]
region = ap-northeast-1
[foo]
region = us-east-1
```


```javascript
import AWS from 'aws-sdk';
import loader from 'aws-sdk-config-loader';

loader(AWS);
// AWS.config.region === 'ap-northeast-1'
// AWS.config.credentials.accessKeyId = 'default_key_id'
// AWS.config.credentials.secretAccessKey = 'default_secret_key'

// export AWS_PROFILE=foo
loader(AWS);
// AWS.config.region === 'us-east-1'
// AWS.config.credentials.accessKeyId = 'foo_key_id'
// AWS.config.credentials.secretAccessKey = 'foo_secret_key'

// export AWS_CONFIG_FILE=/path/to/config
loader(AWS);
// set AWS.config from /path/to/config

loader(AWS, {profile: 'foo'})
// AWS.config.region === 'us-east-1'
// AWS.config.credentials.accessKeyId = 'foo_key_id'
// AWS.config.credentials.secretAccessKey = 'foo_secret_key'

loader(AWS, {profile: 'foo', noReflectCredentials: true})
// AWS.config.region === 'us-east-1'
// AWS.config.credentials.accessKeyId = 'default_key_id'
// AWS.config.credentials.secretAccessKey = 'default_secret_key'
```


[npm-url]: https://www.npmjs.com/package/aws-sdk-config-loader
[npm-image]: https://img.shields.io/npm/v/aws-sdk-config-loader.svg?style=flat-square
[npm-download-url]: https://www.npmjs.com/package/aws-sdk-config-loader
[npm-download-image]: https://img.shields.io/npm/dt/aws-sdk-config-loader.svg?style=flat-square
[travis-url]: https://travis-ci.org/moqada/aws-sdk-config-loader
[travis-image]: https://img.shields.io/travis/moqada/aws-sdk-config-loader.svg?style=flat-square
[codecov-url]: https://codecov.io/github/moqada/aws-sdk-config-loader
[codecov-image]: https://img.shields.io/codecov/c/github/moqada/aws-sdk-config-loader.svg?style=flat-square
[daviddm-dev-url]: https://david-dm.org/moqada/aws-sdk-config-loader#info=devDependencies
[daviddm-dev-image]: https://img.shields.io/david/dev/moqada/aws-sdk-config-loader.svg?style=flat-square
[license-url]: http://opensource.org/licenses/MIT
[license-image]: https://img.shields.io/npm/l/aws-sdk-config-loader.svg?style=flat-square

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