https://github.com/architect/env
Manage an Architect project's environment variables
https://github.com/architect/env
Last synced: about 1 year ago
JSON representation
Manage an Architect project's environment variables
- Host: GitHub
- URL: https://github.com/architect/env
- Owner: architect
- License: apache-2.0
- Created: 2019-06-17T22:45:17.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-06T21:59:50.000Z (about 1 year ago)
- Last Synced: 2025-04-13T14:51:13.424Z (about 1 year ago)
- Language: JavaScript
- Size: 446 KB
- Stars: 5
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
# `@architect/env` [](https://github.com/architect/env/actions?query=workflow%3A%22Node+CI%22)
[@architect/env][npm] reads and writes environment variables that are made immediately available to all deployed Functions. Use this tool to ensure your team and your application's deployment targets are in sync with sensitive configuration data (such as API keys) that needs to exist outside of your codebase.
# Installation
npm install @architect/env
# Use of AWS SSM
This modules stores environment variables as [AWS SSM Parameters][param] using
[AWS SSM Parameter Store][paramstore]. [Parameters][param] are created such that:
- Each [Parameter][param]'s `Name` stores environment variables in the format `${appname}/${environment}/${variableName}`.
- Each [Parameter][param]'s `Value` stores the environment variable value.
- Each [Parameter][param]'s `Type` is set to `SecureString`.
[npm]: https://www.npmjs.com/package/@architect/env
[param]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_Parameter.html
[paramstore]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html