# serverless-openfaas

> This is an OpenFaaS plugin for the Serverless Inc framework.

Latest version **1.0.0** (published 2018-05-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install serverless-openfaas
pnpm add serverless-openfaas
yarn add serverless-openfaas
bun add serverless-openfaas
```

## 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.0.0 |
| Published | 2018-05-10 |
| First published | 2018-05-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.3 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | openfaas |

## Links

- npm: https://www.npmjs.com/package/serverless-openfaas
- npm.io page: https://npm.io/package/serverless-openfaas

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0
- [extract-zip](https://npm.io/package/extract-zip.md) ^1.6.5

## Recent versions

- 1.0.0 (latest) — 2018-05-10

## README

This is an OpenFaaS plugin for the Serverless Inc framework.

# Were you looking for OpenFaaS?

You are probably looking for [OpenFaaS - openfaas/faas](https://github.com/openfaas/faas).

# serverless-openfaas

## Pre-reqs

* [Node.js 8 or newer](https://nodejs.org/en/download/)
* Serverless Inc CLI (sls)
* Docker 17.05+
* OpenFaaS & CLI (faas-cli)

Installation:

* Serverless Inc CLI (sls)

```
sudo npm i -g serverless
```

* Get the OpenFaaS CLI:

```
$ curl -sSL https://cli.openfaas.com | sudo sh
```

Or install via `brew install faas-cli`.

* Get OpenFaaS

You can deploy OpenFaaS locally or remotely with Docker Swarm or Kubernetes. [See the documentation](https://docs.openfaas.com/)

## Getting started

* Get this plugin

```
$ git clone https://github.com/openfaas/serverless-openfaas
$ ./prep.sh
```

> This will install the `serverless` npm module.

* Test all commands with a script

```
$ ./test-plugin.sh
```

* Manually test commands

Run `./test-plugin.sh` then:
```
$ cd driver/faas-func
$ sls <command>
```

## Currently supported commands

```
sls init
sls package
sls deploy
sls deploy function -f <your-function>
sls deploy list
sls invoke -f <your-function> -d <your-data> # -d flag optional
sls remove
```

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