Built binaries for AWS SAM Local CLI - https://github.com/awslabs/aws-sam-local. 

Built binaries for AWS SAM Local CLI - https://github.com/awslabs/aws-sam-local

amzn-oss

sanathkr

aws_sam

paulmaddox

aws-sam-local

  "description":"Built binaries for AWS SAM Local CLI - https://github.com/awslabs/aws-sam-local",

    "url":"https://github.com/awslabs/aws-sam-local/releases/download/v{{version}}/sam_{{version}}_{{platform}}_{{arch}}.tar.gz"

    "url":"https://github.com/awslabs/aws-sam-local.git"

    "url":"https://github.com/awslabs/aws-sam-local/issues"

  "homepage":"https://github.com/awslabs/aws-sam-local#readme"

[![Build Status](https://travis-ci.org/awslabs/aws-sam-local.svg?branch=develop)](https://travis-ci.org/awslabs/aws-sam-local) ![Apache-2.0](https://img.shields.io/npm/l/aws-sam-local.svg?maxAge=2592000) ![Contributers](https://img.shields.io/github/contributors/awslabs/aws-sam-local.svg?maxAge=2592000) ![GitHub-release](https://img.shields.io/github/release/awslabs/aws-sam-local.svg?maxAge=2592000) ![npm-release](https://img.shields.io/npm/v/aws-sam-local.svg?maxAge=2592000) [![Join the chat at https://gitter.im/awslabs/aws-sam-local](https://badges.gitter.im/awslabs/aws-sam-local.svg)](https://gitter.im/awslabs/aws-sam-local?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

 **`sam`** is the AWS CLI tool for managing Serverless applications written with [AWS Serverless Application Model (SAM)](https://github.com/awslabs/serverless-application-model). SAM Local can be used to test functions locally, start a local API Gateway from a SAM template, validate a SAM template, and generate sample payloads for various event sources.

        - [Prerequisites](#prerequisites)

        - [Windows, Linux, macOS with NPM [Recommended]](#windows-linux-macos-with-npm-recommended)

        - [Binary release](#binary-release)

        - [Build From Source](#build-from-source)

        - [Invoke functions locally](#invoke-functions-locally)

        - [Generate sample event source payloads](#generate-sample-event-source-payloads)

        - [Run API Gateway locally](#run-api-gateway-locally)

        - [Debugging Applications](#debugging-applications)

            - [Debugging Python functions](#debugging-python-functions)

        - [Validate SAM templates](#validate-sam-templates)

        - [Package and Deploy to Lambda](#package-and-deploy-to-lambda)

    - [Getting started](#getting-started)

        - [Compiled Languages (Java)](#compiled-languages-java)

        - [IAM Credentials](#iam-credentials)

        - [Lambda Environment Variables](#lambda-environment-variables)

            - [Environment Variable file](#environment-variable-file)

            - [Shell environment](#shell-environment)

            - [Combination of Shell and Environment Variable file](#combination-of-shell-and-environment-variable-file)

        - [Identifying local execution from Lambda function code](#identifying-local-execution-from-lambda-function-code)

        - [Static Assets](#static-assets)

        - [Local Logging](#local-logging)

        - [Remote Docker](#remote-docker)

    - [A special thank you](#a-special-thank-you)

* Develop and test your Lambda functions locally with `sam local` and Docker

* Invoke functions from known event sources such as Amazon S3, Amazon DynamoDB, Amazon Kinesis, etc.

* Start local API Gateway from a SAM template, and quickly iterate over your functions with hot-reloading

Running Serverless projects and functions locally with SAM Local requires Docker to be installed and running. SAM Local will use the `DOCKER_HOST` environment variable to contact the docker daemon.

 - macOS: [Docker for Mac](https://store.docker.com/editions/community/docker-ce-desktop-mac)

 - Windows: [Docker Toolbox](https://download.docker.com/win/stable/DockerToolbox.exe)

 - Linux: Check your distro’s package manager (e.g. yum install docker)

For macOS and Windows users: SAM local requires that the project directory (or any parent directory) is listed in Docker file sharing options.

Verify that docker is working, and that you can run docker commands from the CLI (e.g. ‘docker ps’). You do not need to install/fetch/pull any containers – SAM Local will do it automatically as required.

### Windows, Linux, macOS with NPM [Recommended]

The easiest way to install **`sam`** is to use [NPM](https://www.npmjs.com).

If you get a permission error when using npm (such as `EACCES: permission denied`), please see the instructions on this page of the NPM documentation: [https://docs.npmjs.com/getting-started/fixing-npm-permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions).

To update **`sam`** once installed via npm:

We also release the CLI as binaries that you can download and instantly use. You can find them under [Releases] in this repo. In case you cannot find the version or architecture you're looking for you can refer to [Build From Source](#build-from-source) section for build details.

First, install Go (v1.8+) on your machine: [https://golang.org/doc/install](https://golang.org/doc/install), then run the following:

$ go get github.com/awslabs/aws-sam-local 

Note: You must detach your debugger in order for the result to be sent back to AWS SAM Local.

Unlike Node.JS and Java, Python requires you to enable remote debugging in your Lambda function code. If you enable debugging with `--debug-port` or `-d` for a function that uses one of the Python runtimes, SAM Local will just map through that port from your host machine through to the Lambda runtime container. You will need to enable remote debugging in your function code. To do this, use a python package such as [remote-pdb](https://pypi.python.org/pypi/remote-pdb). When configuring the host the debugger listens on in your code, make sure to use `0.0.0.0` not `127.0.0.1` to allow Docker to map through the port to your host machine.

> Please note, due to a [open bug](https://github.com/Microsoft/vscode-python/issues/71) with Visual Studio Code, you may get a `Debug adapter process has terminated unexpectedly` error when attempting to debug Python applications with this IDE. Please track the [GitHub issue](https://github.com/Microsoft/vscode-python/issues/71) for updates.

#### Passing Additional Runtime Debug Arguments

To pass additional runtime arguments when debugging your function, use the environment variable `DEBUGGER_ARGUMENTS`. This will pass a string of arguments directly into the run command SAM Local uses to start your function.

For example, if you want to load a debugger like iKPdb at runtime of your Python function, you could pass the following as `DEBUGGER_ARGUMENTS`: `-m ikpdb --ikpdb-port=5858 --ikpdb-working-directory=/var/task/ --ikpdb-client-working-directory=/myApp --ikpdb-address=0.0.0.0`. This would load iKPdb at runtime with the other arguments you've specified. In this case, your full SAM local command would be:

$ DEBUGGER_ARGUMENTS="-m ikpdb --ikpdb-port=5858 --ikpdb-working-directory=/var/task/ --ikpdb-client-working-directory=/myApp --ikpdb-address=0.0.0.0" echo {} | sam local invoke -d 5858 myFunction

You may pass debugger arguments to functions of all runtimes.

Both `sam local invoke` and `sam local start-api` support connecting the create lambda docker containers to an existing docker network.

To connect the containers to an existing docker network, you can use the `--docker-network` command-line argument or the `SAM_DOCKER_NETWORK` environment variable along with the name or id of the docker network you wish to connect to.

# Invoke a function locally and connect to a docker network

$ sam local invoke --docker-network my-custom-network <function logical id>

# Start local API Gateway and connect all containers to a docker network

$ sam local start-api --docker-network b91847306671 -d 5858

Validate your templates with `$ sam validate`.

Currently this command will validate that the template provided is valid JSON / YAML.

As with most SAM Local commands, it will look for a `template.yaml` file in your current working directory by default. You can specify a different template file/location with the `-t` or `--template` option.

Note: More in-depth functionality is currently disabled. An alternative validation route is to validate your JSON against schema for [the whole CloudFormation and SAM specification.](https://github.com/awslabs/goformation/blob/master/schema/sam.schema.json)

Once you have developed and tested your Serverless application locally, you can deploy to Lambda using `sam package` and `sam deploy` command. `package` command will zip your code artifacts, upload to S3 and produce a SAM file that is ready to be deployed to Lambda using AWS CloudFormation. `deploy` command will deploy the packaged SAM template to CloudFormation. Both `sam package` and `sam deploy` are identical to their AWS CLI equivalents commands [`aws cloudformation package`](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/package.html) and [`aws cloudformation deploy`](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html) respectively. Please consult the AWS CLI command documentation for usage.

$ sam package --template-file sam.yaml --s3-bucket mybucket --output-template-file packaged.yaml

$ sam deploy --template-file ./packaged.yaml --stack-name mystack --capabilities CAPABILITY_IAM

* Check out [HOWTO Guide](HOWTO.md) section for more details

To use SAM Local with compiled languages, such as Java that require a packaged artifact (e.g. a JAR, or ZIP), you can specify the location of the artifact with the `AWS::Serverless::Function` `CodeUri` property in your SAM template.

      Handler: com.example.HelloWorldHandler

      CodeUri: ./target/HelloWorld-1.0.jar

You should then build your JAR file using your normal build process. Please note that JAR files used with AWS Lambda should be a shaded JAR file (or uber jar) containing all of the function dependencies.

$ echo '{ "some": "input" }' | sam local invoke

You can find a full Java example in the [samples/java](samples/java) folder

		{
		"name":"aws-sam-local",
		"version":"0.2.7",
		"version":"0.2.8",
		"description":"Built binaries for AWS SAM Local CLI - https://github.com/awslabs/aws-sam-local",
		@@ -5,0 +5,0 @@ "main":"index.js",

		@@ -252,3 +252,3 @@ <p align="center">
		"remoteRoot": "/var/task",
		"protocol": "legacy"
		"protocol": "inspector"
		}
		@@ -259,2 +259,4 @@ ]

		Note: You must detach your debugger in order for the result to be sent back to AWS SAM Local.

		#### Debugging Python functions
		@@ -261,0 +263,0 @@

Improved metrics