# @joblocal/serverless-invoke-local-environment

> Overwrite serverless environment to enable local development.

Latest version **1.1.0** (published 2021-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @joblocal/serverless-invoke-local-environment
pnpm add @joblocal/serverless-invoke-local-environment
yarn add @joblocal/serverless-invoke-local-environment
bun add @joblocal/serverless-invoke-local-environment
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-02-18 |
| First published | 2018-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Joblocal GmbH |
| Maintainers | asonnenholzner, lagerbierheld, bastianhofmann, smuehlbauer, vyuldashev |
| Keywords | serverless, environment, aws, invoke, local |

## Links

- npm: https://www.npmjs.com/package/@joblocal/serverless-invoke-local-environment
- Repository: https://github.com/joblocal/serverless-invoke-local-environment
- Homepage: https://github.com/joblocal/serverless-invoke-local-environment#readme
- Issues: https://github.com/joblocal/serverless-invoke-local-environment/issues
- npm.io page: https://npm.io/package/@joblocal/serverless-invoke-local-environment

## Dependencies (1)

- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-02-18
- 1.0.2 — 2019-09-09
- 1.0.1 — 2018-12-19
- 1.0.0 — 2018-12-19

## README

# Serverless Invoke Local Environment Plugin

This [serverless](https://serverless.com/) 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:

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

Using npm:

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

### Usage

After installation you can configure the plugin like so:

```yaml
# serverless.yml

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

custom:
  invokeLocalEnvironment: ${file(.env)}
```

```
# .env
ENVIRONMENT_VARIABLE=value
```
.env (compatible with [dotenv](https://github.com/motdotla/dotenv))

After configuration, whenever you invoke your lambda function

```sh
$ serverless invoke local -f functionName
```

your `.env` will be accessible via `process.env`.


## Built with

- [Yarn](https://yarnpkg.com/lang/en/) - Dependency Management
- [Jest](https://facebook.github.io/jest/) - Test Runner
- and ♥

## Contributing

Please read through our [contributing guidelines](https://github.com/joblocal/serverless-invoke-local-environment/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and feature requests.

## Authors

- **Joblocal GmbH** - _Initial work_ - [Joblocal](https://github.com/joblocal)

See also the list of [contributors](https://github.com/joblocal/serverless-invoke-local-environment/contributors) who participated in this project.

---
_Source: https://npm.io/package/@joblocal/serverless-invoke-local-environment · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._