ssmenv

ssmenv

Description

Manage environment variables with the AWS SSM Parameter Store.

Usage

Prepare

In order to run ssmenv, it is necessary to complete the setting of AWS authentication and define the path of Parameter Store to store environment variables.

AWS_PROFILE=sample-profile
AWS_REGION=ap-northeast-1

SSMENV_PATH=/dotenv/development

Commands

ssmenv get

Get a environment variable.

$ ssmenv get SAMPLE_VALUE_1
SAMPLE_VALUE_1=sapmle_value

$ ssmenv get SAMPLE_VALUE_2
SAMPLE_VALUE_2="sapmle value"

ssmenv list

List environment variables.

$ ssmenv list
SAMPLE_VALUE_1=sapmle_value
SAMPLE_VALUE_2="sapmle value"

$ ssmenv list --export
export SAMPLE_VALUE_1=sapmle_value
export SAMPLE_VALUE_2="sapmle value"

ssmenv put

Set environment variables. Stored in the Parameter Store as ${SSMENV_PATH}/SAMPLE_VALUE.

$ ssmenv put -e SAMPLE_VALUE_1=update_value
$ ssmenv get SAMPLE_VALUE_1
SAMPLE_VALUE_1=update_value

$ ssmenv put -e SAMPLE_VALUE_1=update_value -e SAMPLE_VALUE_2="update value"
$ ssmenv list
SAMPLE_VALUE_1=update_value
SAMPLE_VALUE_2="update value"

$ cat .env
SAMPLE_VALUE_1=update_value_by_file
SAMPLE_VALUE_2="update value by file"
$ ssmenv put -f .env
$ ssmenv list
SAMPLE_VALUE_1=update_value_by_file
SAMPLE_VALUE_2="update value by file"

$ ssmenv put -e SAMPLE_VALUE_3=new_value --dry-run
- key: SAMPLE_VALUE_3
  old_value: <undefined>
  new_value: new_value

$ ssmenv put -e SAMPLE_VALUE_3=new_value --diff
- key: SAMPLE_VALUE_3
  old_value: <undefined>
  new_value: new_value

$ ssmenv put -f secret.env --diff=key
- key: SAMPLE_CREDENTIAL

ssmenv delete

Delete environment variables.

$ ssmenv delete -e SAMPLE_VALUE_1 -e SAMPLE_VALUE_2

$ ssmenv delete -e SAMPLE_VALUE_3 --dry-run
- key: SAMPLE_VALUE_3
  old_value: new_value
  new_value: <undefined>

$ ssmenv delete -e SAMPLE_VALUE_3 --diff
- key: SAMPLE_VALUE_3
  old_value: new_value
  new_value: <undefined>

ssmenv run

Command execution with applying environment variables.

$ ssmenv run echo $SAMPLE_VALUE_1
sapmle_value

Advanced Setting

Empty value

The value of Parameter Store require at least one character. Therefore, ssmenv judges that it is empty if it matches a specific string.

SSMENV_EMPTY_PATTERN=empty_value # default value is "🈳"

Inspired by

• https://github.com/sachaos/s3env