https://github.com/localstack/aws-sam-cli-local
Simple wrapper around AWS SAM CLI for use with LocalStack
https://github.com/localstack/aws-sam-cli-local
Last synced: 2 months ago
JSON representation
Simple wrapper around AWS SAM CLI for use with LocalStack
- Host: GitHub
- URL: https://github.com/localstack/aws-sam-cli-local
- Owner: localstack
- License: apache-2.0
- Created: 2020-08-28T08:55:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-08-11T17:34:25.000Z (5 months ago)
- Last Synced: 2025-08-31T06:41:44.722Z (4 months ago)
- Language: Python
- Size: 35.2 KB
- Stars: 64
- Watchers: 16
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS SAM CLI for LocalStack
This project provides the `samlocal` command line, a simple wrapper around the [AWS SAM CLI](https://github.com/aws/aws-sam-cli) for use with [LocalStack](https://github.com/localstack/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`)
## Change Log
* 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.