Skip to content

Commit eb2cfce

Browse files
authored
DOCS (hotfix): remove legacy LocalStack CLI mentions from installation section in Getting Started guide (#832)
1 parent 9e477f0 commit eb2cfce

16 files changed

Lines changed: 67 additions & 80 deletions

File tree

src/content/docs/aws/customization/advanced/arm64-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This manifest contains links to a Linux AMD64 as well as a Linux ARM64 image.
1212

1313
## Pulling the LocalStack image
1414

15-
With the multi-arch Docker manifest, your Docker client (and therefore the [LocalStack CLI](/aws/getting-started/installation/#localstack-cli)) now automatically selects the image according to your platform:
15+
With the multi-arch Docker manifest, your Docker client (and therefore [`lstk`](/aws/getting-started/installation/#lstk)) now automatically selects the image according to your platform:
1616

1717
```bash
1818
docker pull localstack/localstack

src/content/docs/aws/developer-tools/aws-replicator/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A valid `LOCALSTACK_AUTH_TOKEN` must be configured to start the LocalStack for A
2626

2727
:::note
2828
The Replicator is available from LocalStack CLI version 4.2.0.
29-
If you encounter issues, update your [LocalStack CLI](/aws/getting-started/installation/#update-localstack-cli).
29+
If you encounter issues, update your [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation).
3030
:::
3131

3232
### Retrieve credentials to access AWS
@@ -86,7 +86,7 @@ Two options apply regardless of strategy:
8686
#### Using the LocalStack CLI
8787

8888
The Replicator CLI is part of the LocalStack CLI.
89-
Follow the [installation instructions](/aws/getting-started/installation/#install-localstack-cli) to set it up.
89+
Follow the [installation instructions](/aws/developer-tools/running-localstack/localstack-cli/#installation) to set it up.
9090

9191
Trigger a job with `localstack replicator start`, identifying the resource by its ARN:
9292

src/content/docs/aws/developer-tools/cloud-sandbox/ephemeral-instances.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ If you have created a Cloud Pod from an older version of LocalStack, you need to
8787

8888
## Ephemeral Instances CLI
8989

90-
The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#install-localstack-cli), so no additional installations are needed to start using it.
90+
The Ephemeral Instances CLI is included in the [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation), so no additional installations are needed to start using it.
9191
If you're a licensed user, setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable is recommended to access all features of the Ephemeral Instances CLI.
9292

9393
Access the Ephemeral Instances CLI by running the `localstack ephemeral` command from your terminal.

src/content/docs/aws/developer-tools/running-localstack/lstk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Running `lstk` with no arguments takes you through the entire startup flow autom
2323
## Prerequisites
2424

2525
- [Docker](https://docs.docker.com/get-docker/) installed and running.
26-
- A [LocalStack account](https://www.localstack.cloud/pricing) with a [license](/aws/getting-started/auth-token/#managing-your-license), and `lstk` handles authentication for you (see [Authentication](#authentication)).
26+
- A [LocalStack account](https://www.localstack.cloud/pricing) with a [license](/aws/getting-started/auth-token/#license-assignment), and `lstk` handles authentication for you (see [Authentication](#authentication)).
2727

2828
## Installation
2929

src/content/docs/aws/developer-tools/security-testing/custom-tls-certificates.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ They all can be summarised as:
3030

3131
## Creating a custom docker image
3232

33-
If you run LocalStack in a docker container (which includes using [the CLI](/aws/getting-started/installation/#install-localstack-cli), [docker](/aws/getting-started/installation/#docker-compose), [docker-compose](/aws/getting-started/installation/#docker-compose), or [helm](/aws/customization/kubernetes/deploy-helm-chart)), to include a custom TLS root certificate a new docker image should be created.
33+
If you run LocalStack in a docker container (which includes using [`lstk`](/aws/getting-started/installation/#lstk), [Docker Compose](/aws/getting-started/installation/#docker-compose), or [Helm](/aws/getting-started/installation/#helm-kubernetes)), to include a custom TLS root certificate a new docker image should be created.
3434

3535
Create a `Dockerfile` containing the following commands:
3636

src/content/docs/aws/developer-tools/snapshots/cloud-pods.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You can save and load the persistent state of Cloud Pods, you can use the [Cloud
2828
LocalStack provides a remote storage backend that can be used to store the state of your running application and share it with your team members.
2929
You can interact with the Cloud Pods over the storage backend via the LocalStack Web Application.
3030

31-
Cloud Pods CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#install-localstack-cli), so there's no need for additional installations to begin using it.
31+
Cloud Pods CLI is included in the [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation), so there's no need for additional installations to begin using it.
3232
If you're a licensed user, we suggest setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable.
3333
This enables you to access the complete range of LocalStack Cloud Pods features.
3434

@@ -451,7 +451,7 @@ localstack pod list s3-storage-aws
451451

452452
:::note
453453
Full S3 remotes support is available in the CLI from version 3.2.0.
454-
If you experience any difficulties, update your [LocalStack CLI](/aws/getting-started/installation/#update-localstack-cli).
454+
If you experience any difficulties, update your [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation).
455455
:::
456456

457457
### ORAS remote storage

src/content/docs/aws/getting-started/ai-workflows.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This is useful when you want to:
2121

2222
There are three common ways to use LocalStack in AI-assisted development:
2323

24-
- Use the [LocalStack MCP Server](/aws/tooling/mcp-server/) when your AI assistant supports MCP clients such as Cursor, Claude, Codex, or OpenCode.
24+
- Use the [LocalStack MCP Server](/aws/developer-tools/running-localstack/mcp-server/) when your AI assistant supports MCP clients such as Cursor, Claude, Codex, or OpenCode.
2525
- Use [LocalStack Skills](https://github.com/localstack/skills) when you want reusable agent instructions for deploying and testing AWS architectures against LocalStack.
2626
- Use LocalStack with `tflocal`, `cdklocal`, or `awslocal` when you want the agent to generate infrastructure code or commands that you review and run locally.
2727

@@ -48,7 +48,7 @@ npx -y @localstack/localstack-mcp-server init
4848
```
4949

5050
:::note
51-
The MCP server runs locally and talks to a LocalStack instance. Your AI assistant is the MCP client. For full installation instructions, detailed setup, and the full tool reference, see the [LocalStack MCP Server guide](/aws/tooling/mcp-server/).
51+
The MCP server runs locally and talks to a LocalStack instance. Your AI assistant is the MCP client. For full installation instructions, detailed setup, and the full tool reference, see the [LocalStack MCP Server guide](/aws/developer-tools/running-localstack/mcp-server/).
5252

5353
You need a valid [Auth Token](/aws/getting-started/auth-token/) to configure the server.
5454
:::
@@ -103,6 +103,6 @@ Before applying changes to AWS, check that:
103103

104104
## Next steps
105105

106-
- Configure the [LocalStack MCP Server](/aws/tooling/mcp-server/) if your AI assistant supports MCP.
106+
- Configure the [LocalStack MCP Server](/aws/developer-tools/running-localstack/mcp-server/) if your AI assistant supports MCP.
107107
- Review [LocalStack Skills](https://github.com/localstack/skills) for reusable agent workflows.
108108
- Browse the [LocalStack for AWS services](/aws/services/) reference, or check the [Getting Started FAQ](/aws/getting-started/faq/) for common setup questions.

src/content/docs/aws/getting-started/ci-cd.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
5858
LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
5959
```
6060
61-
See the [GitHub Actions guide](/aws/integrations/continuous-integration/github-actions/) for the full setup.
61+
See the [GitHub Actions guide](/aws/ci-pipelines/github-actions/) for the full setup.
6262
6363
</TabItem>
6464
<TabItem label="CircleCI">
@@ -88,7 +88,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
8888
localstack wait -t 60
8989
```
9090
91-
See the [CircleCI guide](/aws/integrations/continuous-integration/circleci/) for the full setup.
91+
See the [CircleCI guide](/aws/ci-pipelines/circleci/) for the full setup.
9292
9393
</TabItem>
9494
<TabItem label="Bitbucket">
@@ -116,7 +116,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
116116
- localstack wait -t 60
117117
```
118118
119-
See the [Bitbucket Pipelines guide](/aws/integrations/continuous-integration/bitbucket/) for the full setup.
119+
See the [Bitbucket Pipelines guide](/aws/ci-pipelines/bitbucket/) for the full setup.
120120
121121
</TabItem>
122122
<TabItem label="CodeBuild">
@@ -133,7 +133,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
133133
- localstack wait -t 30
134134
```
135135
136-
See the [CodeBuild guide](/aws/integrations/continuous-integration/codebuild/) for the full setup.
136+
See the [CodeBuild guide](/aws/ci-pipelines/codebuild/) for the full setup.
137137
138138
</TabItem>
139139
<TabItem label="GitLab CI">
@@ -162,7 +162,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
162162
- awslocal s3 mb s3://test-bucket
163163
```
164164
165-
See the [GitLab CI guide](/aws/integrations/continuous-integration/gitlab-ci/) for the full setup.
165+
See the [GitLab CI guide](/aws/ci-pipelines/gitlab-ci/) for the full setup.
166166
167167
</TabItem>
168168
<TabItem label="Travis CI">
@@ -183,12 +183,12 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
183183
- localstack wait -t 30
184184
```
185185
186-
See the [Travis CI guide](/aws/integrations/continuous-integration/travis-ci/) for the full setup.
186+
See the [Travis CI guide](/aws/ci-pipelines/travis-ci/) for the full setup.
187187
188188
</TabItem>
189189
</Tabs>
190190
191-
You can also start from the [CI integrations overview](/aws/integrations/continuous-integration/) if you want a broader explanation of the CI workflow.
191+
You can also start from the [CI integrations overview](/aws/ci-pipelines/) if you want a broader explanation of the CI workflow.
192192
193193
## Authentication in CI
194194
@@ -202,9 +202,9 @@ Most CI jobs should start with a clean LocalStack instance. A fresh instance mak
202202

203203
If your pipeline needs state across jobs or workflow stages, use one of the state management options documented outside this getting started page:
204204

205-
- [Cloud Pods](/aws/capabilities/state-management/cloud-pods/) to save and restore named LocalStack state snapshots.
206-
- [State export and import](/aws/capabilities/state-management/export-import-state/) to move state through artifacts or caches.
207-
- [Persistence](/aws/capabilities/state-management/persistence/) when the same runner keeps a mounted LocalStack volume.
205+
- [Cloud Pods](/aws/developer-tools/snapshots/cloud-pods/) to save and restore named LocalStack state snapshots.
206+
- [State export and import](/aws/developer-tools/snapshots/export-import-state/) to move state through artifacts or caches.
207+
- [Persistence](/aws/developer-tools/snapshots/persistence/) when the same runner keeps a mounted LocalStack volume.
208208

209209
## Next steps
210210

src/content/docs/aws/getting-started/installation.mdx

Lines changed: 39 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,17 @@ LocalStack for AWS features require an [Auth Token](/aws/getting-started/auth-to
2323

2424
**Requirement:** You must have a working [Docker installation](https://docs.docker.com/get-docker/) before proceeding.
2525

26-
2726
### Install lstk
2827

2928
<Tabs>
3029
<TabItem label="Homebrew">
31-
```bash
32-
brew install localstack/tap/lstk
33-
```
34-
</TabItem>
35-
<TabItem label="npm">
36-
```bash
37-
npm install -g @localstack/lstk
38-
```
30+
```bash brew install localstack/tap/lstk ```
3931
</TabItem>
32+
<TabItem label="npm">```bash npm install -g @localstack/lstk ```</TabItem>
4033
<TabItem label="Binary">
41-
Download the binary for your platform from the [GitHub Releases](https://github.com/localstack/lstk/releases) and add it to your `PATH`.
34+
Download the binary for your platform from the [GitHub
35+
Releases](https://github.com/localstack/lstk/releases) and add it to your
36+
`PATH`.
4237
</TabItem>
4338
</Tabs>
4439

@@ -138,78 +133,70 @@ Install the [official extension](https://hub.docker.com/extensions/localstack/lo
138133

139134
## Troubleshooting
140135

141-
#### The LocalStack CLI installation is successful, but I cannot execute `localstack`
142-
143-
If you can successfully install LocalStack using `pip` but you cannot use it in your terminal, you most likely haven't set up your operating system's / terminal's `PATH` variable (in order to tell them where to find programs installed via `pip`).
136+
Installation issues typically fall into one of three areas: getting your chosen install method working, activating your license, or reaching LocalStack over the network. This section will guide you to the appropriate guide that contains detailed fixes based on your installation method.
144137

145-
- If you are using Windows, you can enable the `PATH` configuration when installing Python, [as described in the official docs of Python](https://docs.python.org/3/using/windows.html#finding-the-python-executable).
146-
- If you are using a MacOS or Linux operating system, please make sure that the `PATH` is correctly set up - either system wide, or in your terminal.
138+
### lstk
147139

148-
As a workaround you can call the LocalStack CLI python module directly:
149-
150-
```bash
151-
python3 -m localstack.cli.main
152-
```
140+
If you installed via [`lstk`](#lstk) and LocalStack fails to start, authenticate, or pull its image, see [lstk troubleshooting](/aws/developer-tools/running-localstack/lstk/#troubleshooting).
153141

154-
#### The `localstack` CLI does not start the LocalStack container
142+
For first-run authentication (browser login, keyring tokens, or `LOCALSTACK_AUTH_TOKEN` in CI), refer to [Authentication](/aws/developer-tools/running-localstack/lstk/#authentication) and the [Auth Token guide](/aws/getting-started/auth-token/).
155143

156-
If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
144+
### Docker Compose and Docker CLI
157145

158-
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](/aws/customization/networking/dns-server#system-dns-configuration) to disable it.
159-
- Start LocalStack with a specific DNS address:
146+
If you started LocalStack with [Docker Compose](#docker-compose) or the [Docker CLI](#docker-cli):
160147

161-
```bash
162-
DNS_ADDRESS=0 localstack start
163-
```
148+
- **License or credential errors**: see [Auth Token troubleshooting](/aws/getting-started/auth-token/#troubleshooting).
149+
- **Container exits during startup, proxy/DNS/TLS issues, or port conflicts**: see [Startup Troubleshooting FAQs](/aws/getting-started/faq/#startup-troubleshooting-faqs).
150+
- **DNS server or port conflicts**: see the [DNS Server guide](/aws/customization/networking/dns-server/).
164151

165-
- Remove port 53 as indicated in our [standard `docker-compose.yml` file](https://github.com/localstack/localstack/blob/main/docker-compose-pro.yml).
152+
Ensure you have exported `LOCALSTACK_AUTH_TOKEN` in your shell before running `docker compose up` or `docker run`.
166153

167-
#### How should I access the LocalStack logs on my local machine?
154+
### View logs
168155

169-
You can now avail logging output and error reporting using LocalStack logs.
170-
To access the logs, run the following command:
156+
Stream container logs using the command that matches your install method:
171157

172158
<Tabs>
173159
<TabItem label="lstk">
160+
174161
```bash
175162
lstk logs
176163
```
177-
</TabItem>
178-
</Tabs>
179164

180-
AWS requests are now logged uniformly in the INFO log level (set by default or when `DEBUG=0`).
181-
The format is:
165+
For `lstk` CLI diagnostics (separate from container logs), see [Logging](/aws/developer-tools/running-localstack/lstk/#logging).
166+
167+
</TabItem>
168+
<TabItem label="Docker Compose">
182169

183-
```text
184-
AWS <service>.<operation> => <http-status> (<error type>)
170+
```bash
171+
docker compose logs -f localstack
185172
```
186173

187-
Requests to HTTP endpoints are logged in a similar way:
174+
</TabItem>
175+
<TabItem label="Docker CLI">
188176

189-
```text
190-
2022-09-12T10:39:21.165 INFO --- [ asgi_gw_0] localstack.request.aws : AWS s3.ListBuckets => 200
191-
2022-09-12T10:39:41.315 INFO --- [ asgi_gw_0] localstack.request.aws : AWS s3.CreateBucket => 200
192-
2022-09-12T10:40:04.662 INFO --- [ asgi_gw_0] localstack.request.aws : AWS s3.PutObject => 200
193-
2022-09-12T11:01:55.799 INFO --- [ asgi_gw_0] localstack.request.http : GET / => 200
177+
```bash
178+
docker logs -f localstack-main
194179
```
195180

196-
#### How should I share the LocalStack logs for troubleshooting?
181+
Use the container name from your `docker run --name` flag if you set one.
197182

198-
You can share the LocalStack logs with us to help us identify issues.
199-
To share the logs, call the diagnostic endpoint:
183+
</TabItem>
184+
<TabItem label="Helm">
200185

201186
```bash
202-
curl -s localhost:4566/_localstack/diagnose | gzip -cf > diagnose.json.gz
187+
kubectl logs -f deployment/localstack
203188
```
204189

205-
Ensure that the diagnostic endpoint is run after you have tried reproducing the affected task.
206-
After running the task, run the diagnostic endpoint and share the archive file with your team members or LocalStack Support.
190+
The deployment name follows your Helm release name (default: `localstack`).
191+
192+
</TabItem>
193+
</Tabs>
207194

208-
#### My application cannot reach LocalStack over the network
195+
To enable verbose startup logging, capture logs from a failed container, or share a diagnose bundle with support, see [How do I capture and share LocalStack container logs for troubleshooting?](/aws/getting-started/faq/#how-do-i-capture-and-share-localstack-container-logs-for-troubleshooting).
209196

210-
We have extensive network troubleshooting documentation available [here](/aws/customization/networking/).
197+
### Network connectivity
211198

212-
If this does not solve your problem then please [reach out to LocalStack Support](/aws/help-support/get-help/).
199+
If your application cannot reach LocalStack after installation, see the [networking documentation](/aws/customization/networking/).
213200

214201
## Next steps
215202

src/content/docs/aws/getting-started/local-development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ Stop your LocalStack container to remove all emulated resources. LocalStack is e
271271
272272
{/* prettier-ignore-end */}
273273
274-
To persist resource state, like S3 buckets or DynamoDB tables, across restarts, check out our [state management tools](/aws/capabilities/state-management/).
274+
To persist resource state, like S3 buckets or DynamoDB tables, across restarts, check out our [state management tools](/aws/developer-tools/snapshots/).
275275
276276
Remove the local files you created in this guide:
277277

0 commit comments

Comments
 (0)