Mention the lstk CLI in the localstack CLI docs#700
Open
gtsiolis wants to merge 5 commits into
Open
Conversation
gtsiolis
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
Deploying localstack-docs with
|
| Latest commit: |
36ef67b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://64d29bef.localstack-docs.pages.dev |
| Branch Preview URL: | https://pro-312-mention-lstk-cli-in.localstack-docs.pages.dev |
gtsiolis
force-pushed
the
pro-312-mention-lstk-cli-in-localstack-cli-docs
branch
from
4be89f2 to
83eab98
Compare
Collaborator
|
cc @mmaureenliu for visibility since she is just now logging tickets for this doc too :) |
mmaureenliu
reviewed
Jun 12, 2026
The Developer Tools restructure (#691) moved the localstack-cli and lstk pages under /aws/developer-tools/running-localstack/. Update the cross-links in the generated CLI doc, its generator, and the lstk FAQ to match. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
gtsiolis
force-pushed
the
pro-312-mention-lstk-cli-in-localstack-cli-docs
branch
from
83eab98 to
e22353c
Compare
Keep the lstk doc focused only on lstk. With the localstack CLI being deprecated, the doc shouldn't compare against it or highlight features (Extensions, Ephemeral Instances) that lstk won't add. Discoverability of lstk still flows from the localstack CLI page note, which is unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Member
Author
|
Can someone take another look? 👀 |
mmaureenliu
approved these changes
Jun 16, 2026
mmaureenliu
left a comment
mmaureenliu
left a comment
There was a problem hiding this comment.
I did a complete re-read of the entire article and left quite a few comments/questions. None are blocking so I've approved already, but I do want them addressed at some point.
- Prerequisites: require a license (not just an Auth Token); lstk handles auth - Quick start: simplify the auth wording - CI: use a CI Auth Token, linked to the CI auth-token docs - Config: document the snowflake/azure emulator types and per-project emulator config - MAIN_CONTAINER_NAME: clarify it is derived and not configurable - FAQ: "require a license" instead of "auth token" - Troubleshooting: link the corporate-proxy FAQ; point "Getting help" to Get Help Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Member
Author
|
Thanks for taking a closer look, @mmaureenliu! Addressed comments in 36ef67b. Could a |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a short note to the top of the LocalStack CLI reference pointing readers to
lstk, our new Go-based CLI, and updates thelstkpage itself — keeping its positioninglstk-only and addressing the review feedback left on it.It also replaces the auto-generated "This documentation was auto-generated from LocalStack CLI version
…" note, which wasn't useful and was reliably out of date. That version is captured only when the monthlyupdate-cli-docsworkflow runs (the 15th), so it always trails the actual release — the page read2026.4.0while2026.5.xhad been on PyPI for weeks (2026.5.0shipped 5 days after the last regeneration). A stamp that's accurate for ~1 day a month is worse than none.Changes
The LocalStack CLI page is auto-generated by
scripts/generate_cli_docs.py, so that change is made in the generator and mirrored into the current output:scripts/generate_cli_docs.py— replace the version provenance:::notewith a pointer tolstk; remove the now-dead version plumbing (thelocalstack --versioncall + unused parameter).localstack-cli.md— the regenerated note.lstk.mdx— update the top note to reflect thatlstkcovers lifecycle, monitoring, and storage (snapshot), and remove the "difference betweenlstkand thelocalstackCLI" FAQ so the page stays focused onlstk(thelocalstackCLI is being deprecated).Rendered notes:
Follow-up
Documenting the
lstksnapshotcommand in detail and theterraform/az/setupproxy commands is tracked separately and will land in its own PR.Fix PRO-312