Skip to content

Commit d5c3ca9

Browse files
DOC-435: Push lstk in the docs research/writing MVP agent (#929)
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 1c796b5 commit d5c3ca9

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

agents.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ For every new doc or major change you draft, you must generate a short **Audit T
5454
- **Confidence & Gaps Assessment:** Explicitly state if data was thin or if you encountered places where LocalStack's behavior diverged from AWS. Note any features you deliberately omitted due to lack of verified local support.
5555

5656
#### Anti-Hallucination Guardrails
57-
- **Zero-Tolerance for Fictional APIs:** Never invent `awslocal` commands, CLI flags, configuration variables, or JSON output fields. If a flag or parameter is not explicitly found in active AWS documentation or LocalStack's data/source code, do not write it down.
57+
- **Zero-Tolerance for Fictional APIs:** Never invent `lstk aws`, `lstk cdk`, or `lstk terraform` commands, CLI flags, configuration variables, or JSON output fields. If a flag or parameter is not explicitly found in active AWS documentation or LocalStack's data/source code, do not write it down.
5858

5959

6060

@@ -94,7 +94,7 @@ Follow the writing conventions below. Draft the full doc, not just sections.
9494
### What to always include in a service doc
9595

9696
1. **Introduction**: What the AWS service does (2–4 sentences). What LocalStack lets you do with it. Link to the API coverage section.
97-
2. **Getting started**: A short, self-contained walkthrough using `awslocal` commands. Assume the user has LocalStack running. Show real commands with real expected output.
97+
2. **Getting started**: A short, self-contained walkthrough using [`lstk aws`](/aws/developer-tools/running-localstack/lstk/cloud-and-iac-commands/#aws) commands. Assume the user has LocalStack running. Show real commands with real expected output.
9898
3. **Feature sections**: Cover notable behaviors, limitations, or LocalStack-specific quirks. Use `:::note` or `:::tip` callouts for important caveats.
9999
4. **Resource Browser**: If the service has a LocalStack Web App Resource Browser, include a section with a screenshot and a bulleted list of actions available.
100100
5. **Examples**: Links to relevant sample apps from `github.com/localstack-samples` or tutorials on the docs site.
@@ -104,7 +104,7 @@ Follow the writing conventions below. Draft the full doc, not just sections.
104104

105105
1. **Introduction**: The problem being solved and what the reader will build.
106106
2. **Architecture diagram**: If the tutorial involves multiple services, include a diagram.
107-
3. **Prerequisites**: Bulleted list: LocalStack, awslocal, any other tools. State if Pro plan is required.
107+
3. **Prerequisites**: Bulleted list: LocalStack, `lstk` (and the relevant `lstk aws`/`lstk terraform`/`lstk cdk`/`lstk sam` proxy), any other tools. State if Pro plan is required.
108108
4. **Step-by-step tutorial**: Use `###` for each step. Each step should have a clear goal, the command(s) to run, and the expected output.
109109
5. No "Summary" section at the end: just end with the last meaningful step or a "Next steps" pointing to related content.
110110

@@ -133,7 +133,7 @@ The supported APIs are available on the [API coverage section](#api-coverage).
133133

134134
## Getting started
135135

136-
This guide is designed for users new to [Service] and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.
136+
This guide is designed for users new to [Service] and assumes basic knowledge of the AWS CLI and our [`lstk aws`](/aws/developer-tools/running-localstack/lstk/cloud-and-iac-commands/#aws) command.
137137

138138
Start your LocalStack container using your preferred method.
139139

@@ -142,7 +142,7 @@ Start your LocalStack container using your preferred method.
142142
[Explanation sentence.]
143143

144144
```bash
145-
awslocal <service> <command> --option value
145+
lstk aws <service> <command> --option value
146146
```
147147

148148
```bash title="Output"
@@ -212,7 +212,7 @@ leadimage: "tutorial-banner-filename.png"
212212
## Prerequisites
213213

214214
- [LocalStack](https://localstack.cloud/) with an [auth token](https://app.localstack.cloud/workspace/auth-tokens) (Pro plan required)
215-
- [awslocal](https://github.com/localstack/awscli-local)
215+
- [`lstk`](/aws/developer-tools/running-localstack/lstk/) and its [`lstk aws`](/aws/developer-tools/running-localstack/lstk/cloud-and-iac-commands/#aws) command
216216
- [Other tool](link)
217217

218218
## Tutorial: [Goal]
@@ -236,13 +236,13 @@ command here
236236

237237
### CLI commands
238238

239-
Always use `awslocal` (not `aws`). Every command block must:
239+
Always use `lstk aws` (not `aws`, and not the deprecated `awslocal` wrapper). For Terraform, CDK, or SAM examples, use `lstk terraform`, `lstk cdk`, or `lstk sam` respectively (not `tflocal`, `cdklocal`, or `samlocal`). Every command block must:
240240
- Show the command itself
241241
- Show the expected output in a separate block with `title="Output"`
242242

243243
````mdx
244244
```bash
245-
awslocal s3api create-bucket --bucket my-bucket
245+
lstk aws s3api create-bucket --bucket my-bucket
246246
```
247247

248248
```bash title="Output"
@@ -257,7 +257,7 @@ awslocal s3api create-bucket --bucket my-bucket
257257
Use `\` for line continuation:
258258

259259
```bash
260-
awslocal lambda create-function \
260+
lstk aws lambda create-function \
261261
--function-name my-function \
262262
--runtime python3.11 \
263263
--handler handler.handler \

0 commit comments

Comments
 (0)