README.md

AWS SAM CLI

Installation | Blogs | Videos | AWS Docs | Roadmap | Try It Out | Slack Us

The AWS Serverless Application Model (SAM) CLI is an open-source CLI tool that helps you develop serverless applications containing Lambda functions, Step Functions, API Gateway, EventBridge, SQS, SNS and more. Some of the features it provides are:

• Initialize serverless applications in minutes with AWS-provided infrastructure templates with sam init
• Compile, build, and package Lambda functions with provided runtimes and with custom Makefile workflows, for zip and image types of Lambda functions with sam build
• Locally test a Lambda function and API Gateway easily in a Docker container with sam local commands on SAM and CDK applications
• Sync and test your changes in the cloud with sam sync in your developer environments
• Deploy your SAM and CloudFormation templates using sam deploy
• Quickly create pipelines with prebuilt templates with popular CI/CD systems using sam pipeline init
• Tail CloudWatch logs and X-Ray traces with sam logs and sam traces

Recent blogposts and workshops

• Speeding up incremental changes with AWS SAM Accelerate and Nested Stacks - Read blogpost here.

• Develop Node projects with SAM CLI using esbuild - and use SAM Accelerate on Typescript projects. Read blogpost here.

• Speed up development with SAM Accelerate - quickly test your changes in the cloud. Read docs here.

• AWS Serverless Developer Experience Workshop: A day in a life of a developer - This advanced workshop provides you with an immersive experience as a serverless developer, with hands-on experience building a serverless solution using AWS SAM and SAM CLI.

• The Complete SAM Workshop- This workshop is a great way to experience the power of SAM and SAM CLI.

• Getting started with CI/CD? SAM pipelines can help you get started - This workshop walks you through the basics.

• Get started with Serverless Application development using SAM CLI - This workshop walks you through the basics.

Get Started

To get started with building SAM-based applications, use the SAM CLI. SAM CLI provides a Lambda-like execution environment that lets you locally build, test, debug, and deploy AWS serverless applications.

• Install SAM CLI
• Build & Deploy a "Hello World" Web App
• Install AWS Toolkit to use SAM with your favorite IDEs
• Tutorials and Workshops
• Powertools for AWS Lambda is a developer toolkit to implement Serverless best practices and increase developer velocity. Available for Python, Java, TypeScript and .NET.

Next Steps: Learn to build a more complex serverless application.

• Extract text from images and store it in a database using Amazon S3 and Amazon Rekognition services.
• Detect when records are added to a database using Amazon DynamoDB database and asynchronous stream processing.
• Explore popular patterns

What is this Github repository? 💻

This Github repository contains source code for SAM CLI. Here is the development team talking about this code:

SAM CLI code is written in Python. Source code is well documented, very modular, with 95% unit test coverage. It uses this awesome Python library called Click to manage the command line interaction and uses Docker to run Lambda functions locally. We think you'll like the code base. Clone it and run make pr or ./Make -pr on Windows!

Related Repositories and Resources

• SAM Transform Open source template specification that provides shorthand syntax for CloudFormation
• SAM CLI application templates Get started quickly with predefined application templates for all supported runtimes and languages, used by sam init
• Lambda Builders Lambda builder tools for supported runtimes and custom build workflows, used by sam build
• Build and local emulation images for CI/CD tools Build container images to use with CI/CD tasks

Contribute to SAM

We love our contributors ❤️ We have over 100 contributors who have built various parts of the product. Read this testimonial from @ndobryanskyy to learn more about what it was like contributing to SAM.

Depending on your interest and skill, you can help build the different parts of the SAM project;

Enhance the SAM Specification

Make pull requests, report bugs, and share ideas to improve the full SAM template specification. Source code is located on Github at aws/serverless-application-model. Read the SAM Specification Contributing Guide to get started.

Strengthen SAM CLI

Add new commands, enhance existing ones, report bugs, or request new features for the SAM CLI. Source code is located on Github at aws/aws-sam-cli. Read the SAM CLI Contributing Guide to get started.

Update SAM Developer Guide

SAM Developer Guide provides a comprehensive getting started guide and reference documentation. Source code is located on Github at awsdocs/aws-sam-developer-guide. Read the SAM Documentation Contribution Guide to get started.

Join the SAM Community on Slack

Join the SAM developers channel (#samdev) on Slack to collaborate with fellow community members and the AWS SAM team.