# @serverless/enterprise-plugin

> The Serverless Dashboard plugin

Latest version **4.6.0** (published 2021-05-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @serverless/enterprise-plugin
pnpm add @serverless/enterprise-plugin
yarn add @serverless/enterprise-plugin
bun add @serverless/enterprise-plugin
```

## 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 | 4.6.0 |
| Published | 2021-05-11 |
| First published | 2019-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0 |
| Dependencies | 21 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 (+7 in 2 direct dependencies) |
| Install scripts | no |
| Author | serverless.com |
| Maintainers | serverless-main |

## Links

- npm: https://www.npmjs.com/package/@serverless/enterprise-plugin
- Repository: https://github.com/serverless/enterprise-plugin
- Homepage: https://github.com/serverless/enterprise-plugin#readme
- Issues: https://github.com/serverless/enterprise-plugin/issues
- npm.io page: https://npm.io/package/@serverless/enterprise-plugin

## Dependencies (21)

- [flat](https://npm.io/package/flat.md) ^5.0.2
- [open](https://npm.io/package/open.md) ^7.4.2
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [jszip](https://npm.io/package/jszip.md) ^3.6.0
- [ncjsm](https://npm.io/package/ncjsm.md) ^4.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [semver](https://npm.io/package/semver.md) ^7.3.5
- [yamljs](https://npm.io/package/yamljs.md) ^0.3.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.1.0
- [memoizee](https://npm.io/package/memoizee.md) ^0.4.15
- [node-dir](https://npm.io/package/node-dir.md) ^0.1.17
- [cli-color](https://npm.io/package/cli-color.md) ^2.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [simple-git](https://npm.io/package/simple-git.md) ^2.38.1
- [@serverless/utils](https://npm.io/package/@serverless/utils.md) ^4.1.0
- [child-process-ext](https://npm.io/package/child-process-ext.md) ^2.1.1
- [@serverless/event-mocks](https://npm.io/package/@serverless/event-mocks.md) ^1.1.1
- [@serverless/platform-client](https://npm.io/package/@serverless/platform-client.md) ^4.2.2

## Recent versions

- 4.6.0 (latest) — 2021-05-11
- 4.6.0-fa99403a (canary) — 2021-05-11
- 3.8.4 (major-3) — 2020-09-09
- 4.0.0-pre.070d67ca (pre-4) — 2020-08-28
- 3.6.15-6e78d237 (next) — 2020-07-10
- 4.6.0-024ad293 — 2021-05-11
- 4.6.0-ed4e12e6 — 2021-05-10
- 4.6.0-1050c612 — 2021-05-05
- 4.5.3-f774ac0a — 2021-04-09
- 4.5.3-de7ecf9d — 2021-03-30
- 4.5.3 — 2021-03-30
- 4.5.3-6d70841f — 2021-03-30
- 4.5.2-17e5b3fc — 2021-03-30
- 4.5.2-2aa00402 — 2021-03-30
- 4.5.2 — 2021-03-22
- … 482 more at https://npm.io/package/@serverless/enterprise-plugin/versions

## README

# Serverless Framework Enterprise Plugin

[![Build Status](https://travis-ci.com/serverless/enterprise-plugin.svg)](https://travis-ci.com/serverless/enterprise-plugin)
[![license](https://img.shields.io/npm/l/@serverless/enterprise-plugin.svg)](https://www.npmjs.com/package/@serverless/enterprise-plugin)
[![coverage](https://img.shields.io/codecov/c/github/serverless/enterprise-plugin.svg)](https://codecov.io/gh/serverless/enterprise-plugin)
[![Known Vulnerabilities](https://snyk.io/test/github/serverless/enterprise-plugin/badge.svg?targetFile=package.json)](https://snyk.io/test/github/serverless/enterprise-plugin?targetFile=package.json)

To enable the various features of the [Serverless Framework Enterprise](https://github.com/serverless/enterprise) for a particular Service you must deploy or redeploy that Service, using Serverless Framework open-source CLI version 1.45.1 or later.

- If you are an existing Serverless Framework Enterprise dashboard user and have a previously deployed Service that you now want to configure to use Serverless Insights, Secrets or other Enteprise features, follow these steps to [update an existing Service](https://github.com/serverless/enterprise/blob/master/docs/update.md)
- If you are new to the Serverless Framework open source CLI or Serverless Framework Enterprise simply follow the steps in this [new user getting started guide](https://github.com/serverless/enterprise/blob/master/docs/getting-started.md) to get up and running

Upon deployment, the Serverless Framwork Enteprise Plugin will automatically wrap and instrument your functions to work with the Serverless Framework Enterprise dashboard.

## Dev notes

### Install dependencies and build SDK JS

```
npm i
cd sdk-js
npm i
npm run build
cd -
```

### Test

```
npm t
cd sdk-js
npm t
cd -
```

#### Integration tests

For integration tests run you need an access to `integration` dashboard organization, and generated for it access key.

Then tests can be run as:

```
SERVERLESS_ACCESS_KEY=xxx npm run integration-test
```

### Release process

- Create a PR updating version in `package.json`
- Create a draft release on github with a change log
- Have it approved & merge (Release is automatically published via CI)

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