Get started with Serverless Framework’s open-source CLI and AWS in minutes.
serverless CLI via NPM:
npm install -g serverless
You can upgrade the CLI later by running the same command:
npm install -g serverless.
To upgrade to a specific major version, specify it like this:
npm install -g serverless@2. If you installed
serverless as a standalone binary, read this documentation instead.
To create your first project, run the command below and follow the prompts:
# Create a new serverless project serverless # Move into the newly created directory cd your-service-name
serverless command will guide you to:
- create a new project
- configure AWS credentials
- optionally set up a free Serverless Dashboard account to monitor and troubleshoot your project
Note: users based in China get a setup centered around the chinese Tencent provider. To use AWS instead, set the following environment variable:
Your new serverless project should contain a
serverless.yml file. This file defines what will be deployed to AWS: functions, events, resources and more. You can learn more about this in the Core Concepts documentation.
If the templates proposed by
serverless do not fit your needs, check out the project examples from Serverless Inc. and our community. You can install any example by passing a GitHub URL using the
If you haven't done so already within the
serverless command, you can deploy the project at any time by running:
The deployed functions, resources and URLs will be displayed in the command output.
If you deployed an API, querying its URL will trigger the associated Lambda function. You can find that URL in the
serverless deploy output, or retrieve it later via
If you deployed a function that isn't exposed via a URL, you can invoke it via:
serverless invoke -f hello # Invoke and display logs: serverless invoke -f hello --log
All logs generated by a function's invocation are automatically stored in AWS CloudWatch. Retrieve those logs in the CLI via:
serverless logs -f hello # Tail logs serverless logs -f hello --tail
You can monitor and debug Lambda functions and APIs via the Serverless Dashboard.
To set it up, run the following command in an existing project and follow the prompts:
If you want to delete your service, run
serverless remove. This will delete all the AWS resources created by your project and ensure that you don't incur any unexpected charges. It will also remove the service from Serverless Dashboard.
Now that Serverless Framework is installed, here is what you can do next: