Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.57 KB

README.md

File metadata and controls

62 lines (39 loc) · 1.57 KB
Raw

Serverless Invoke Local Environment Plugin

This serverless plugin allows you to overwrite a functions process.env when invoking locally, allowing you to simulate AWS services using docker and connect to those containers for an easier development workflow.

Installation

Using yarn:

$ yarn add --dev @joblocal/serverless-invoke-local-environment

Using npm:

$ npm install --save-dev @joblocal/serverless-invoke-local-environment

Usage

After installation you can configure the plugin like so:

# serverless.yml

plugins:
  - '@joblocal/serverless-invoke-local-environment'

custom:
  invokeLocalEnvironment: ${file(.env)}
# .env
ENVIRONMENT_VARIABLE=value

.env (compatible with dotenv)

After configuration, whenever you invoke your lambda function

$ serverless invoke local -f functionName

your .env will be accessible via process.env.

Built with

  • Yarn - Dependency Management
  • Jest - Test Runner
  • and ♥

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and feature requests.

Authors

  • Joblocal GmbH - Initial work - Joblocal

See also the list of contributors who participated in this project.