AWS secrets parser

Fetch and parse JSON from AWS secrets manager.

!Review
!Version
!Downloads
!Size
!Quality
!Coverage

Motivation

If I have a JSON secret:

``json
{
"username": "*",
"password": "*"
}
`

I want to programmatically retrieve and parse it into an object:

`ts
import { retrieve } from "aws-secrets-parser";

retrieve("database-secret", "us-east-1").then(({ username, password }) => { ... });
`

I also want to format and export the values to environment variables:

`bash
> source <(aws-secrets-parser database-secret --naming constant --prefix DATABASE)
> printenv

DATABASE_USERNAME=*
DATABASE_PASSWORD=*
`

I also want to format and export them to a .env file:

`bash
> aws-secrets-parser database-secret --naming constant --prefix DATABASE --output dotenv > .env
`

This produces a .env file with:

`dotenv
DATABASE_USERNAME=*
DATABASE_PASSWORD=*
`

Installing

`bash
npm install aws-secrets-parser
`

To make the cli accessible install the package globally with the -g flag or invoke it with npx.

Usage

Fetch and parse a JSON secret:

`ts
import { retrieve } from "aws-secrets-parser";

retrieve("database-secret", "us-east-1");
`

$3

`bash
aws-secrets-parser

Fetch and parse JSON from AWS secrets manager.

Positionals:
name The secret name [string]

Options:
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
-r, --region Set the AWS region [string] [default: "us-east-1"]
-n, --naming Set the key naming format [string] [choices: "preserve", "constant", "pascal"] [default: "preserve"]
-p, --prefix Add a prefix to the keys [string]
-o, --output Set the output format [string] [choices: "export", "dotenv"] [default: "export"]
`

Naming formats:

- preserve → No formatting
- constant → CONSTANT_CASE
- pascal → PascalCase

Output formats:

- export → export key='value'
- dotenv → key=value

#### Examples

`bash
> aws-secrets-parser database-secret --naming constant --prefix DATABASE

export DATABASE_USERNAME='*'
export DATABASE_PASSWORD='*'
`

The cli prints export statements since you can't set environment variables from a script directly. Running the cli with source will consume them:

`bash
> source <(aws-secrets-parser database-secret --naming constant --prefix DATABASE)
> printenv

DATABASE_USERNAME=*
DATABASE_PASSWORD=*
`

You can also output them in dotenv format to consume later:

`bash
> aws-secrets-parser database-secret --naming constant --prefix DATABASE --output dotenv > .env
`

This produces a .env file with:

`dotenv
DATABASE_USERNAME=*
DATABASE_PASSWORD=*
`

Tooling

$3

To install dependencies:

`bash
yarn install
`

$3

To run tests:

`bash
yarn test
`

$3

To generate the documentation locally:

`bash
yarn docs
`

$3

To run linters:

`bash
yarn lint
`

$3

To run formatters:

`bash
yarn format
`

Contributing

Please read this repository's Code of Conduct which outlines our collaboration standards and the Changelog for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit SemVer.

Bump2version is used to version and tag changes. For example:

`bash
bump2version patch
``

$3

- Joel Lefkowitz - Initial work

Remarks

Lots of love to the open source community!