# circleci-aws

> Configure CircleCI with AWS keys

Latest version **1.0.0** (published 2016-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install circleci-aws
pnpm add circleci-aws
yarn add circleci-aws
bun add circleci-aws
```

Provides the command `circleci-aws`.

## 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.0 |
| Published | 2016-09-26 |
| First published | 2016-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | circleci, ci, aws, config, credentials, access, key, secret |

## Links

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

## Dependencies (3)

- [got](https://npm.io/package/got.md) ~6.5.0
- [meow](https://npm.io/package/meow.md) ~3.7.0
- [snakecase-keys](https://npm.io/package/snakecase-keys.md) ~1.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-09-26

## README

# circleci-aws [![Build Status](https://travis-ci.org/bendrucker/circleci-aws.svg?branch=master)](https://travis-ci.org/bendrucker/circleci-aws)

> Configure CircleCI with AWS keys


## Install

```
$ npm install --save circleci-aws
```


## Usage

### API

```js
var circleCiAws = require('circleci-aws')

circleCiAws.set({
  access_key_id: 'beep',
  secret_access_key: 'boop',
  username: 'u',
  project: 'p',
  circle_token: 'c'
})
.then(() => circleCiAws.get({
  username: 'u',
  project: 'p',
  circle_token: 'c'
}))
.then(console.log)
//=> {access_key_id...}
.then(() => circleCiAws.remove({
  username: 'u',
  project: 'p',
  circle_token: 'c'
}))
.then(console.log)
//=> null
```

### CLI

```sh
# set
circleci-aws set --username u --project p --circle-token c --access-key-id beep --secret-access-key boop
# get
circleci-aws --username u --project p --circle-token c
# remove
circleci-aws remove --username u --project p --circle-token c
```


## API

#### `circleCiAws.get(data)` -> `promise`
#### `circleCiAws.set(data)` -> `promise`
#### `circleCiAws.remove(data)` -> `promise`

##### data

*Required*  
Type: `object`

An object that always must contain the `username`, `project`, and `circle_token` and will contain `access_key_id` and `secret_access_key` when setting new values.

The returned promise will resolve with the parsed response body from Circle. This will be `null` in all cases except when calling `get` with an existing keypair.


## License

MIT © [Ben Drucker](http://bendrucker.me)

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