# 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.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.
Raw data
{
"_id": null,
"home_page": "https://github.com/localstack/aws-sam-cli-local",
"name": "aws-sam-cli-local",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "LocalStack Team",
"author_email": "info@localstack.cloud",
"download_url": "https://files.pythonhosted.org/packages/c5/6b/1ca407bce6c1a6012dde439bff5155d321ee0724b3760bc18d4b67856685/aws-sam-cli-local-1.69.0.tar.gz",
"platform": null,
"description": "# AWS SAM CLI for LocalStack\n\nThis 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).\n\n## Installation\n\nSimply use `pip` to install `samlocal` as a Python library on your machine:\n\n```\npip install aws-sam-cli-local\n```\n\n## Usage\n\nThe `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.\n\n```\nsamlocal --help\n```\n\n## Configuration\n\n* `AWS_ENDPOINT_URL`: URL at which the `boto3` client can reach LocalStack, e.g. `http://localhost.localstack.cloud:4566` (default: `http://localhost:4566`)\n* `EDGE_PORT`: **Deprecated** Port number under which the LocalStack edge service is available (default: `4566`)\n* `LOCALSTACK_HOSTNAME`: **Deprecated** Host under which the LocalStack edge service is available (default: `localhost`)\n\n## Change Log\n\n* v1.69.0: Fix repo related cli options and add support to Lambdas with `Image` type\n* v1.68.0: Support `AWS_ENDPOINT_URL` for configuring the `boto3.client` endpoint\n* v1.67.0: Patch underlying `boto3.Session.client` instead of `boto3.client`\n* v1.55.0: Fix s3 URl detection when using a nested template\n* v1.53.1: Fix logic around local URLs for ECR image repositories\n* v1.1.0.1: Minor fix, release initial version of `samlocal` command\n* v1.1.0: Initial version\n\n## License\n\nThis software library is released under the Apache License, Version 2.0.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Simple wrapper around AWS SAM CLI for use with LocalStack",
"version": "1.69.0",
"project_urls": {
"Homepage": "https://github.com/localstack/aws-sam-cli-local"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c56b1ca407bce6c1a6012dde439bff5155d321ee0724b3760bc18d4b67856685",
"md5": "224b92d9318f2cdca66f27b91bbcd0fa",
"sha256": "99987c445db4c5ccddf96e7fccf65fbf1dd934a6de8d4535605f2ecba62007e8"
},
"downloads": -1,
"filename": "aws-sam-cli-local-1.69.0.tar.gz",
"has_sig": false,
"md5_digest": "224b92d9318f2cdca66f27b91bbcd0fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8757,
"upload_time": "2024-03-12T12:39:07",
"upload_time_iso_8601": "2024-03-12T12:39:07.997265Z",
"url": "https://files.pythonhosted.org/packages/c5/6b/1ca407bce6c1a6012dde439bff5155d321ee0724b3760bc18d4b67856685/aws-sam-cli-local-1.69.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 12:39:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "localstack",
"github_project": "aws-sam-cli-local",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aws-sam-cli-local"
}
JSON
