serverless-export-env

⚡️ Serverless Export Env Plugin

About

This Serverless plugin exports the environment variables defined in serverless.yml into a distinct .env file. This allows you to access these environment variables from local scripts such as for integration tests. You will find the .env file in the root folder of your project.

It will collect the global environment variables of the poject as well as all environment variables of the functions. It will also add API_ENDPOINT and IS_OFFLINE to your environment if you run the plugin via serverless offline.

Environment variables referencing CloudFormation resources (e.g. Ref: MyDynamoDbTable), or import values (e.g. Fn::ImportValue: MyExportedValue) are automatically resolved to their respective values. This, however, requires the stack to be deployed before the plugin can access any of these variables.

This plugin is based on the serverless-dotenv Plugin by Jimdo but largely rewritten to fit our needs.

Usage

Add the npm package to your project:

# Via yarn
$ yarn add arabold/serverless-export-env

# Via npm
$ npm install arabold/serverless-export-env --save-dev

Add the plugin to your serverless.yml:

plugins:
  - serverless-export-env

That's it! You can now call serverless export-env in your terminal to generate the .env file based on your Serverless configuration. Alternative you can just start serverless offline to generate it.

Provided lifecycle events

• export-env:collect - Collect environment variables from Serverless
• export-env:resolve - Resolve CloudFormation references and import variables
• export-env:write - Write environment variables to file

Example

serverless export-env

This example will export all environment variables into a .env file in your project root folder.

Releases

1.0.0

• This is the initial release with all basic functionality
• TODO: Write some tests!