Skip to content

Commit 2f87126

Browse files
committed
Cleanup of the bash samples
1 parent 54a7db1 commit 2f87126

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

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

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,23 @@ or use the curl commands below:
3333

3434
For x86-64:
3535

36-
<Code code={`$ curl --output localstack-cli-${LOCALSTACK_VERSION}-linux-amd64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-linux-amd64-onefile.tar.gz`} lang="bash" />
36+
<Code code={`curl --output localstack-cli-${LOCALSTACK_VERSION}-linux-amd64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-linux-amd64-onefile.tar.gz`} lang="bash" />
3737

3838
For ARM64:
3939

40-
<Code code={`$ curl --output localstack-cli-${LOCALSTACK_VERSION}-linux-arm64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-linux-arm64-onefile.tar.gz`} lang="bash" />
40+
<Code code={`curl --output localstack-cli-${LOCALSTACK_VERSION}-linux-arm64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-linux-arm64-onefile.tar.gz`} lang="bash" />
4141

4242
Then extract the LocalStack CLI from the terminal:
4343

44-
<Code code={`$ sudo tar xvzf localstack-cli-${LOCALSTACK_VERSION}-linux-*-onefile.tar.gz -C /usr/local/bin`} lang="bash" />
44+
<Code code={`sudo tar xvzf localstack-cli-${LOCALSTACK_VERSION}-linux-*-onefile.tar.gz -C /usr/local/bin`} lang="bash" />
4545

4646
<details>
4747
<summary>Alternative: Homebrew on Linux</summary>
4848

4949
If you are using [Homebrew for Linux](https://docs.brew.sh/Homebrew-on-Linux), you can install the LocalStack CLI directly from our official LocalStack tap:
5050

5151
```bash
52-
$ brew install localstack/tap/localstack-cli
52+
brew install localstack/tap/localstack-cli
5353
```
5454
</details>
5555

@@ -60,7 +60,7 @@ $ brew install localstack/tap/localstack-cli
6060
You can install the LocalStack CLI using Brew directly from our official LocalStack tap:
6161

6262
```bash
63-
$ brew install localstack/tap/localstack-cli
63+
brew install localstack/tap/localstack-cli
6464
```
6565

6666
<details>
@@ -72,11 +72,11 @@ You may download the binary for your architecture using the link below:
7272

7373
or use the following curl command:
7474

75-
<Code code={`$ curl --output localstack-cli-${LOCALSTACK_VERSION}-darwin-amd64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-darwin-amd64-onefile.tar.gz`} lang="bash" />
75+
<Code code={`curl --output localstack-cli-${LOCALSTACK_VERSION}-darwin-amd64-onefile.tar.gz \n --location https://github.com/localstack/localstack-cli/releases/download/v${LOCALSTACK_VERSION}/localstack-cli-${LOCALSTACK_VERSION}-darwin-amd64-onefile.tar.gz`} lang="bash" />
7676

7777
Then extract the LocalStack CLI from the terminal:
7878

79-
<Code code={`$ sudo tar xvzf localstack-cli-${LOCALSTACK_VERSION}-darwin-*-onefile.tar.gz -C /usr/local/bin`} lang="bash" />
79+
<Code code={`sudo tar xvzf localstack-cli-${LOCALSTACK_VERSION}-darwin-*-onefile.tar.gz -C /usr/local/bin`} lang="bash" />
8080

8181
</details>
8282
</TabItem>
@@ -102,14 +102,14 @@ Please make sure to install the following before moving ahead:
102102
Next install the LocalStack CLI in your Python environment by running:
103103

104104
```bash
105-
$ python3 -m pip install --upgrade localstack
105+
python3 -m pip install --upgrade localstack
106106
```
107107

108108
:::note
109109
To download a specific version of LocalStack, replace `<version>` with the required version from [release page](https://github.com/localstack/localstack/releases).
110110

111111
```bash
112-
$ python3 -m pip install localstack==<version>
112+
python3 -m pip install localstack==<version>
113113
```
114114
:::
115115

@@ -118,7 +118,7 @@ $ python3 -m pip install localstack==<version>
118118
If you have problems with permissions in MacOS X Sierra, install with:
119119

120120
```bash
121-
$ python3 -m pip install --user localstack
121+
python3 -m pip install --user localstack
122122
```
123123
:::
124124

@@ -133,12 +133,11 @@ It should be installed and started entirely under a local non-root user.
133133
### Starting LocalStack
134134

135135
To verify that the LocalStack CLI was installed correctly, you can check the version in your terminal:
136-
```bash
137-
$ localstack --version
138-
${LOCALSTACK_VERSION}
139-
```
136+
137+
<Code code={`$ localstack --version\n${LOCALSTACK_VERSION}`} lang="bash" />
140138

141139
You are all set!
140+
142141
You can now start LocalStack with the following command:
143142

144143
```bash
@@ -170,6 +169,7 @@ Afterwards, check out our [Quickstart guide](/aws/getting-started/quickstart) to
170169

171170
The LocalStack CLI allows you to easily update the different components of LocalStack.
172171
To check the various options available for updating, run:
172+
173173
```bash
174174
$ localstack update --help
175175
Usage: localstack update [OPTIONS] COMMAND [ARGS]...
@@ -286,7 +286,7 @@ services:
286286
Start the container by running the following command:
287287
288288
```bash
289-
$ docker compose up
289+
docker compose up
290290
```
291291

292292
:::note
@@ -314,8 +314,7 @@ Please note that there are a few pitfalls when configuring your stack manually v
314314
We recommend using the LocalStack CLI to validate your configuration, which will print warning messages in case it detects any potential misconfigurations:
315315

316316
```bash
317-
$ localstack config validate
318-
...
317+
localstack config validate
319318
```
320319

321320
### Docker
@@ -337,7 +336,7 @@ You can start the Docker container simply by executing the following `docker run
337336

338337
<TabItem label="Community" >
339338
```bash
340-
$ docker run \
339+
docker run \
341340
--rm -it \
342341
-p 127.0.0.1:4566:4566 \
343342
-p 127.0.0.1:4510-4559:4510-4559 \
@@ -348,7 +347,7 @@ $ docker run \
348347

349348
<TabItem label="Pro" >
350349
```bash
351-
$ docker run \
350+
docker run \
352351
--rm -it \
353352
-p 127.0.0.1:4566:4566 \
354353
-p 127.0.0.1:4510-4559:4510-4559 \
@@ -397,8 +396,8 @@ If you want to deploy LocalStack in your [Kubernetes](https://kubernetes.io) clu
397396

398397
You can deploy LocalStack in a Kubernetes cluster by running these commands:
399398
```bash
400-
$ helm repo add localstack-repo https://helm.localstack.cloud
401-
$ helm upgrade --install localstack localstack-repo/localstack
399+
helm repo add localstack-repo https://helm.localstack.cloud
400+
helm upgrade --install localstack localstack-repo/localstack
402401
```
403402

404403
The Helm charts are not maintained in the main repository, but in a [separate one](https://github.com/localstack/helm-charts).
@@ -426,7 +425,7 @@ If you can successfully install LocalStack using `pip` but you cannot use it in
426425

427426
As a workaround you can call the LocalStack CLI python module directly:
428427
```bash
429-
$ python3 -m localstack.cli.main
428+
python3 -m localstack.cli.main
430429
```
431430

432431
#### The `localstack` CLI does not start the LocalStack container
@@ -435,7 +434,7 @@ If you are using the `localstack` CLI to start LocalStack, but the container is
435434
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings****Resources****Network**) or follow the steps in our [documentation](https://docs.localstack.cloud/user-guide/tools/dns-server/#system-dns-configuration) to disable it.
436435
- Start LocalStack with a specific DNS address:
437436
```bash
438-
$ DNS_ADDRESS=0 localstack start
437+
DNS_ADDRESS=0 localstack start
439438
```
440439
- Remove port 53 as indicated in our [standard `docker-compose.yml` file](https://github.com/localstack/localstack/blob/master/docker-compose-pro.yml).
441440

@@ -445,7 +444,7 @@ You can now avail logging output and error reporting using LocalStack logs.
445444
To access the logs, run the following command:
446445

447446
```bash
448-
$ localstack logs
447+
localstack logs
449448
```
450449

451450
AWS requests are now logged uniformly in the INFO log level (set by default or when `DEBUG=0`).
@@ -470,7 +469,7 @@ You can share the LocalStack logs with us to help us identify issues.
470469
To share the logs, call the diagnostic endpoint:
471470

472471
```bash
473-
$ curl -s localhost:4566/_localstack/diagnose | gzip -cf > diagnose.json.gz
472+
curl -s localhost:4566/_localstack/diagnose | gzip -cf > diagnose.json.gz
474473
```
475474

476475
Ensure that the diagnostic endpoint is run after you have tried reproducing the affected task.

0 commit comments

Comments
 (0)