The Serverless Framework – Build applications on AWS Lambda and other next-gen cloud services, that auto-scale and only charge you when they run. This lowers the total cost of running and operating your apps, enabling you to build more and manage less.

The Serverless Framework is a command-line tool with an easy and approachable YAML syntax to deploy both your code and cloud infrastructure needed to make tons of serverless application use-cases. It's a multi-language framework that supports Node.js, Typescript, Python, Go, Java, and more.

---

This repository is a maintained alternative to Serverless Framework v3. It exists for those that cannot upgrade to Serverless Framework v4 and is a drop-in replacement for v3.

Get started with:

npm remove -g serverless
npm install -g osls

serverless --version

The repository has been created and is maintained by Bref maintainers and contributors. The main goal of this repository is to provide continuity for Bref users, so that these Bref projects keep working for the next 5 years. No major new features are planned. However, community contributions to keep the project running (even for languages other than PHP), like adding support to new runtime versions, adapting to AWS changes, bugfixes, and other small improvements are welcome.

Changes

This repository contains the following differences with the original Serverless Framework v3:

• Up-to-date documentation for v3 (all documentation for non-AWS providers has been removed).
• Up-to-date support for new AWS Lambda runtimes.
• There is no standalone binary version, the package is only available via NPM.
• Fixed vulnerabilities in dependencies:
  • micromatch
  • braces
  • tar
• Lighter and faster CLI
  • Serverless Dashboard/Enterprise features are removed (because there is no guarantee to keep them working with v3), if you are using them you should upgrade to v4.
  • Serverless Components support have been removed: these are old and unmaintained projects, it's very unlikely you are using them. That improves the boot time of the CLI.
  • Serverless' integration for Tencent Cloud (China version of the serverless CLI) has been removed.
  • Removed unused dependencies.
  • Removed auto-updating (because it's not working anymore).
  • Removed automatic use of local serverless installation (in node_modules): this avoids surprises running the local serverless version instead of this fork.
  • Removed post-install messages.
• Fixed a node warning ("The punycode module is deprecated").

Get Started

• Setup
• Concepts
• AWS Credentials

Usage

• Deploying
• Packaging
• Testing
• Services
• Functions
• Layers
• IAM Function Permissions
• Parameters
• Variables
• Resources
• Composing services
• Workflow Tips
• Serverless.yml Reference

Function events

• Overview
• HTTP (API Gateway v2)
• REST (API Gateway v1)
• ActiveMQ
• Application Load Balancer
• Alexa Skill
• Alexa Smart Home
• CloudWatch Event
• CloudWatch Log
• CloudFront
• Cognito User Pool
• EventBridge Event
• IoT
• IoT Fleet Provisioning
• Kafka
• Kinesis & DynamoDB
• MSK
• RabbitMQ
• S3
• Schedule
• SNS
• SQS
• Websocket

CLI Reference

• Overview
• config credentials
• create
• install
• package
• deploy
• deploy function
• deploy list
• invoke
• invoke local
• logs
• metrics
• info
• rollback
• rollback function
• remove
• plugin list
• plugin search
• plugin install
• plugin uninstall
• generate event
• print

Learn More

• Upgrading to v3
• Configuration Validation
• Resolution of Environment Variables
• Deprecations

Creating Plugins

• Overview
• Creating Plugins
  • CLI Output
  • Custom Commands
  • Custom Variables
  • Extending the Configuration schema
  • Extending and overriding configuration