AWS SAM CLI for LocalStack

Warning

samlocal is deprecated. Use lstk sam instead.

samlocal no longer receives updates.

• Get started with lstk, the new LocalStack CLI: docs.localstack.cloud/.../lstk
• Switch your scripts and CI workflows to lstk sam: docs.localstack.cloud/.../lstk/migration

This project provides the samlocal command line, a simple wrapper around the AWS SAM CLI for use with LocalStack.

Installation

Simply use pip to install samlocal as a Python library on your machine:

pip install aws-sam-cli-local

Usage

The samlocal command has the exact same usage as the underlying sam command. The main difference is that for commands like samlocal deploy the operations will be executed against the LocalStack endpoints (http://localhost:4566 by default) instead of real AWS endpoints.

samlocal --help

Configuration

• AWS_ENDPOINT_URL: URL at which the boto3 client can reach LocalStack, e.g. http://localhost.localstack.cloud:4566 (default: http://localhost:4566)
• EDGE_PORT: Deprecated Port number under which the LocalStack edge service is available (default: 4566)
• LOCALSTACK_HOSTNAME: Deprecated Host under which the LocalStack edge service is available (default: localhost)
• DISABLE_DEPRECATION_NOTICE: Set to 1 to hide the deprecation notice

Change Log

• v1.71.0: Print a deprecation notice that points to lstk sam
• v1.70.1: Fix ECR repository rewrite logic
• v1.70.0: Fix regex pattern to detect ECR URLs with dashes
• v1.69.0: Fix repo related cli options and add support to Lambdas with Image type
• v1.68.0: Support AWS_ENDPOINT_URL for configuring the boto3.client endpoint
• v1.67.0: Patch underlying boto3.Session.client instead of boto3.client
• v1.55.0: Fix s3 URl detection when using a nested template
• v1.53.1: Fix logic around local URLs for ECR image repositories
• v1.1.0.1: Minor fix, release initial version of samlocal command
• v1.1.0: Initial version

License

This software library is released under the Apache License, Version 2.0.