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: agents.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ For every new doc or major change you draft, you must generate a short **Audit T
54
54
-**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.
55
55
56
56
#### 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.
58
58
59
59
60
60
@@ -94,7 +94,7 @@ Follow the writing conventions below. Draft the full doc, not just sections.
94
94
### What to always include in a service doc
95
95
96
96
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.
98
98
3.**Feature sections**: Cover notable behaviors, limitations, or LocalStack-specific quirks. Use `:::note` or `:::tip` callouts for important caveats.
99
99
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.
100
100
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.
104
104
105
105
1.**Introduction**: The problem being solved and what the reader will build.
106
106
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.
108
108
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.
109
109
5. No "Summary" section at the end: just end with the last meaningful step or a "Next steps" pointing to related content.
110
110
@@ -133,7 +133,7 @@ The supported APIs are available on the [API coverage section](#api-coverage).
133
133
134
134
## Getting started
135
135
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.
137
137
138
138
Start your LocalStack container using your preferred method.
139
139
@@ -142,7 +142,7 @@ Start your LocalStack container using your preferred method.
-[`lstk`](/aws/developer-tools/running-localstack/lstk/) and its [`lstk aws`](/aws/developer-tools/running-localstack/lstk/cloud-and-iac-commands/#aws) command
216
216
-[Other tool](link)
217
217
218
218
## Tutorial: [Goal]
@@ -236,13 +236,13 @@ command here
236
236
237
237
### CLI commands
238
238
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:
240
240
- Show the command itself
241
241
- Show the expected output in a separate block with `title="Output"`
0 commit comments