โจ A cli that makes using AWS Parameter Store... as simple as the flick of a wand ๐ง
Explore the docs ยป
Report Bug
ยท
Request Feature
Many libraries deal with parameter store secrets. However, I didn't find one that suits my needs, so I created this one. I wanted to develop a library that will solve all my needs while using secrets, including exporting the key/secrets to different formats
Here's why:
- Many solutions require prefixes to store keys, making it difficult to migrate when needed.
- Support for exporting keys to widely accepted file formats such as JSON was limited.
Below is an example of instructions you can integrate into your own project's Getting Started section. You can follow these simple steps to get a local copy up and running:
- Node 8 or higher
- AWS credentials to your account. (more info here)
If you wish to use alohamora
as a standalone utility:
npm -g install alohomora
This will make the alo
command available in your terminal.
alo --help
If instead you would like to add it to a package:
npm install --only=dev alohomora
Every command accepts several options through command line or custom configuration see configuration for more
alo list --prefix my-company/my-app
alo get SECRET_KEY_NAME --prefix my-company/my-app
alo set SECRET_KEY_NAME VALUE --prefix my-company/my-app --environment development
alo delete SECRET_KEY_NAME --prefix my-company/my-app --environment production
alo export json --prefix my-company/my-app --environment production
You can configure alohomora
from several places:
-
Prefix (
--prefix
): The prefix used to store the keys (it should not start or end with a/
, ex: if the path to the secret is/my-app/[env]/secretName
, the prefix will bemy-app
) -
AWS region (
--aws-region
): The AWS region code where the secrets will be stored (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions)',default: us-east-1
-
Environment (
--environment
): It will be used to filter the secrets (production, staging, test, all),default: all
-
AWS Access Key ID (
--aws-access-key-id
): Credentials following https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html -
AWS Secret Access Key (
--aws-secret-access-key
): Credentials following https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html -
AWS Session Token (
--aws-session-token
): Credentials following https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html -
AWS Profile (
--aws-profile
): Following https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html -
CI flag (
--ci
): Removes colors to avoid odd input.default: false
If you are using alo
as a global command, you can provide all the above options via command line:
alo list --prefix my-company/my-app --aws-region us-west-2 --aws-profile myCustomAWSProfile --environment production
for more details you can invoke:
alo --help
You can also define custom configuration in your package:
{
"name": "my-package",
"alohomora": {
"prefix": "my-company/my-app",
"environment": "production",
"region": "us-west-2"
},
"scripts": {
"secrets": "alo export"
},
"devDependencies": {
"alohomora": "^1.0.0"
}
}
When the command is invoked it will look for the alohomora
configuration block.
(my-package)$ npm run secrets
Custom configuration can be defined in many places, for more information check cosmiconfig
notes about custom configuration
- If
prefix
is provided via cli, the custom configuration will be ignored. - If configuration is provided via the cli, custom configuration will be merged with the provided cli configuration (except
prefix
)
example with overrides:
"alohomora": {
"prefix": "my-company/my-app",
"region": "us-west-2",
"environment": "development",
}
alo list --environment production
result: We will use everything from the custom configuration and use environment
provided by the cli instead of the one on the custom configuration
example ignoring custom configuration:
"alohomora": {
"prefix": "my-company/my-app",
"region": "us-west-2",
"environment": "development",
}
alo list prefix "my-other-company/my-other-app"
result: We will ignore custom configuration given that prefix
was provided via cli.
See the open issues for a list of proposed features (and known issues).
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.