⚡ Join theLocalStack Insiders programto help us shape the future of LocalStack! Test drive new features & engage in conversations with us so we can learn from your use cases ⚡
LocalStack provides an easy-to-use test/mocking framework for developing cloud applications.
Overview•
Install•
Example•
Run•
Usage•
Releases•
Contributing
📖 Docs•
💻 Pro version•
☑️ LocalStack coverage
LocalStackis a cloud service emulator that runs in a single container on your laptop or in your CI environment. With LocalStack, you can run your AWS applications or Lambdas entirely on your local machine without connecting to a remote cloud provider! Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.
LocalStack supports a growing number of AWS services, like AWS Lambda, S3, Dynamodb, Kinesis, SQS, SNS, and many more! ThePro version of LocalStacksupports additional APIs and advanced features. You can find a comprehensive list of supported APIs on our☑️ Feature Coveragepage.
LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack'sCloud Developer Toolsfor more information.
The quickest way get started with LocalStack is by using the LocalStack CLI.
It allows you to start and manage the LocalStack Docker container from your command line.
Please make sure that you have a workingdocker
environmenton your machine before moving on.
Install the LocalStack CLI by using ourofficial LocalStack Brew Tap:
$ brew install localstack/tap/localstack-cli
If you do not have Brew on your machine, you can directly download the pre-built LocalStack CLI binary for your system:
- Download the latest release for your platform onlocalstack/localstack-cli.
- Extract the archive to a folder in your
PATH
variable:- MacOS / Linux:
sudo tar xvzf ~/Downloads/localstack-cli-*-darwin-*-onefile.tar.gz -C /usr/local/bin
- MacOS / Linux:
LocalStack is built with Python.
You can directly install the LocalStack CLI in your Python environment usingpip
.
python
(Python 3.8 up to 3.11 supported)
python3 -m pip install localstack
This installs thelocalstack-cli
which is used to run the Docker image that hosts the LocalStack runtime. Theawslocal
CLI for interacting with the local AWS services is installed separately. See theawslocal
documentationfor installation instructions.
Important:Do not use
sudo
or run asroot
user. LocalStack must be installed and started entirely under a local non-root user. If you have problems with permissions in macOS High Sierra, install withpip install --user localstack
Start LocalStack inside a Docker container by running:
% localstack start -d
__ _______ __ __
/ / ____ _________ _/ / ___// /_____ ______/ /__
/ / / __ \/ ___/ __ `/ /\__ \/ __/ __ `/ ___/ //_/
/ /___/ /_/ / /__/ /_/ / /___/ / /_/ /_/ / /__/,<
/_____/\____/\___/\__,_/_//____/\__/\__,_/\___/_/|_|
💻 LocalStack CLI 2.3.0
[20:22:20] starting LocalStack in Docker mode 🐳
[20:22:21] detaching
You can query the status of respective services on LocalStack by running:
% localstack status services
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃ Service ┃ Status ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│ acm │ ✔ available │
│ apigateway │ ✔ available │
│ cloudformation │ ✔ available │
│ cloudwatch │ ✔ available │
│ config │ ✔ available │
│ dynamodb │ ✔ available │
...
To use SQS, a fully managed distributed message queuing service, on LocalStack, run:
% awslocal sqs create-queue --queue-name sample-queue
{
"QueueUrl":"http://localhost:4566/000000000000/sample-queue"
}
Learn more aboutLocalStack AWS servicesand using them with LocalStack'sawslocal
CLI.
You can run LocalStack through the following options:
To start using LocalStack, check out our documentation athttps://docs.localstack.cloud.
- LocalStack Configuration
- LocalStack in CI
- LocalStack Integrations
- LocalStack Tools
- Understanding LocalStack
- Troubleshoot
To use LocalStack with a graphical user interface, you can use the following UI clients:
Please refer toGitHub releasesto see the complete list of changes for each release. For extended release notes, please refer to theLocalStack Discuss.
If you are interested in contributing to LocalStack:
- Start by reading ourcontributing guide.
- Check out ourdeveloper guide.
- Navigate our codebase andopen issues.
We are thankful for all the contributions and feedback we receive.
To get in touch with LocalStack team for bugs/feature requests, support questions or general discussions, please use:
We are thankful to all the people who have contributed to this project.
We are also grateful to all our backers who have donated to the project. You can become a backer onOpen Collective.
You can also support this project by becoming a sponsor onOpen Collective.Your logo will show up here along with a link to your website.
Copyright (c) 2017-2023 LocalStack maintainers and contributors.
Copyright (c) 2016 Atlassian and others.
This version of LocalStack is released under the Apache License, Version 2.0 (seeLICENSE). By downloading and using this software you agree to theEnd-User License Agreement (EULA).To know about the external software we use, look at ourthird party software toolspage.