Skip to content

Commit

Permalink
udpated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cwdcwd committed Nov 25, 2021
1 parent 22b61d1 commit 4ebfd14
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,19 @@ This module will:
- store and recall env vars to AWS parameter store based on env and app tags

### Install
`npm i`
`npm i -g @opentorc/config-wrapper`

### CLI Usage
`config-wrapper --help`
#### Commands
- remapKeysInEnv: take existing env vars and remap them to new env vars. ie: DEV_AWS_ACCESS_KEY_ID -> AWS_ACCESS_KEY_ID
* --outfile file to save the new env vars to
* --oldprefix prefix to be replaced
* --newprefix prefix to replace with
- saveParamsFile: save params to a file so that they can be loaded in another process via source command
* --outfile file to save the aws env vars to
* --env aws application environment
* --service aws application service

#### Tests
`npm test`
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@opentorc/config-wrapper",
"version": "1.0.1",
"version": "1.0.2",
"description": "config management wrapper",
"main": "./src/index.js",
"bin": {
Expand Down
4 changes: 3 additions & 1 deletion src/lib/awsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ async function getParametersByService(env, service, isEncrypted) {
return params
}

// TODO: add param caching and support for labels
// TODO: add param caching
// TODO: add support for labels
// TODO: add support for saving parameters

module.exports = {
constructParamPath,
Expand Down

0 comments on commit 4ebfd14

Please sign in to comment.