Installation

Table of contents

1. Create Serverless Project
   1. Usage
      1. Options
   2. Providers
      1. AWS-Lambda
         1. Features
         2. Examples
2. Manual installation

The easiest way of starting a new project is by using create-sf.

Create Serverless Project

npx @serverless-framework/create-sf

Using global installation:

npm install -G @serverless-framework/create-sf
npx create-sf

When no arguments are given, the wizard will be used to gather some information.

Usage

npx @serverless-framework/create-sf <project-directory> <provider> [features]

Options

--features a comma separated list of addons. See Providers for more information.

Providers

AWS-Lambda

npx @serverless-framework/create-sf . aws-lambda [features]

Features

• serverless
• localstack

Examples

npx @serverless-framework/create-sf ./api aws-lambda --features serverless
npx @serverless-framework/create-sf ./api aws-lambda --features serverless,localstack
npx @serverless-framework/create-sf ./api aws-lambda --features localstack

Manual installation

npm install @serverless-framework/core @serverless-framework/aws-lambda

In the future we will also support the following providers:

• @serverless-framework/google-cloud-functions
• @serverless-framework/azure-functions