You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-9Lines changed: 23 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,22 +47,36 @@ LocalStack supports a growing number of AWS services, like AWS Lambda, S3, Dynam
47
47
48
48
LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack's [Cloud Developer Tools](https://docs.localstack.cloud/user-guide/tools/) for more information.
49
49
50
-
## Requirements
50
+
## Installation
51
+
The quickest way get started with LocalStack is by using the LocalStack CLI.
52
+
It allows you to start and manage the LocalStack Docker container from your command line.
53
+
Please make sure that you have a working [`docker` environment](https://docs.docker.com/get-docker/) on your machine before moving on.
51
54
52
-
*`python` (Python 3.7 up to 3.11 supported)
53
-
*`pip` (Python package manager)
54
-
*`Docker`
55
+
### Brew (MacOS or Linux with Homebrew)
56
+
Install the LocalStack CLI by using our [official LocalStack Brew Tap](https://github.com/localstack/homebrew-tap):
57
+
```
58
+
$ brew install localstack/tap/localstack-cli
59
+
```
60
+
61
+
### Binary download (MacOS, Linux, Windows)
62
+
If you do not have Brew on your machine, you can directly download the pre-built LocalStack CLI binary for your system:
63
+
- Download the latest release for your platform on [localstack/localstack-cli](https://github.com/localstack/localstack-cli/releases/latest).
64
+
- Extract the archive to a folder in your `PATH` variable:
65
+
- MacOS / Linux: ```sudo tar xvzf ~/Downloads/localstack-cli-*-darwin-*-onefile.tar.gz -C /usr/local/bin```
55
66
56
-
## Installing
67
+
### Python package (MacOS, Linux, Windows)
68
+
LocalStack is built with Python.
69
+
You can directly install the LocalStack CLI in your Python environment using `pip`.
57
70
58
-
The easiest way to install LocalStack is via `pip`:
71
+
#### Prerequisites
59
72
73
+
*`python` (Python 3.7 up to 3.11 supported)
74
+
75
+
#### Installation
60
76
```
61
-
pip install localstack
77
+
python3 -m pip install localstack
62
78
```
63
79
64
-
This installs the `localstack-cli` which is used to run the Docker image that hosts the LocalStack runtime.
65
-
66
80
> **Important**: Do not use `sudo` or run as `root` 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 with `pip install --user localstack`
0 commit comments