Mention the lstk CLI in the localstack CLI docs#700
Conversation
gtsiolis
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
Deploying localstack-docs with
|
| Latest commit: |
83eab98
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5d817ed6.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
|
cc @mmaureenliu for visibility since she is just now logging tickets for this doc too :) |
| Both tools can start, stop, and manage the LocalStack emulator. | ||
| `lstk` is a newer CLI built in Go with a TUI, while the `localstack` CLI is the established Python-based tool with support for Cloud Pods, Extensions, Ephemeral Instances, and other advanced features. | ||
| Both tools can start, stop, and manage the LocalStack emulator, and both work with Cloud Pods — `lstk` via its `snapshot` command and the [`localstack` CLI](/aws/tooling/localstack-cli/) via its `pod` command. | ||
| `lstk` is a newer CLI built in Go with a TUI; the `localstack` CLI is the established Python-based tool that additionally supports Extensions, Ephemeral Instances, and other advanced features `lstk` doesn't cover yet. |
There was a problem hiding this comment.
@gtsiolis considering that we will deprecate localstack without adding support for things like Extensions and Ephemeral Instances to lstk, do we really want to highlight it?
When we deprecate localstack, we'll update docs to only mention the webapp route of using those features not supported in lstk (e.g. Ephemeral Instance, Extensions) and just don't say anything CLI.
There was a problem hiding this comment.
You're right, probably not worth highlighting.
For context, the goal was to make lstk discoverable from the localstack CLI page.
I will remove ephemeral instances and extensions mention next week, but you are also welcome to take this over and push any changes or merge before that.
3 participants
Summary
Adds a short note to the top of the LocalStack CLI reference pointing readers to
lstk, our new Go-based CLI, and aligns thelstkpage so the two pages describelstkconsistently.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 and the "difference betweenlstkand thelocalstackCLI" FAQ to reflect thatlstknow covers lifecycle, monitoring, and storage (snapshot), and that both CLIs work with Cloud Pods (lstkviasnapshot,localstackviapod). This supersedes the earlier early-release note (Update the lstk early release note #698); snapshot/Cloud Pods support has since shipped.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