DOCS: move lstk setup instructions into the CLI - #937
Open
joe4dev wants to merge 4 commits into
Open
Conversation
2 tasks
Deploying localstack-docs with
|
| Latest commit: |
ef5a822
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://76eac27c.localstack-docs.pages.dev |
| Branch Preview URL: | https://devx-821-lstk-shell-completi.localstack-docs.pages.dev |
joe4dev
force-pushed
the
devx-821-lstk-shell-completions
branch
from
September 10, 2026 19:05
9fd6afb to
035b8a0
Compare
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
joe4dev
marked this pull request as ready for review
September 11, 2026 14:49
joe4dev
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
September 11, 2026 14:49
lstk setup instructions into the CLI
gtsiolis
approved these changes
Sep 11, 2026
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
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.
Replaces the Shell completions setup instructions with a pointer to
lstk completion, which prints them itself.Companion to localstack/lstk#495, which moves the instructions into the CLI:
lstk completionprints themPREVIEW:
What changed
The per-shell code tabs are gone. The section is now:
Net effect across both pages: +2 / −101 lines.
Why
Pro: the CLI becomes the single source of truth. The same instructions currently live in three places — the CLI, this AWS page, and the Azure page — and they had already drifted. What was here recommended two zsh recipes that do not work (
${fpath[1]}is root-owned on stock macOS; the Homebrewsite-functionspath is not on the built-in zsh's$fpath), omitted the requiredcompinitstep without which the zsh script fails withcompdef: command not found, and had no PowerShell instructions at all. Pointing at the command removes the sync burden rather than fixing three copies and hoping they stay aligned.Con: old versions can't be corrected. Instructions now ship with the binary, so a mistake reaches users until they upgrade — whereas a docs page can be fixed for everyone at once, including people on older releases.
Con: less pretty and less accessible. Terminal output has no tabbed code blocks, no copy button, and no syntax highlighting, and the instructions are no longer readable from the browser, searchable on the docs site, or linkable from elsewhere.
Docs ticket
https://linear.app/localstack/issue/DOC-455/docs-move-lstk-setup-instructions-into-the-cli
Related
lstk PR: localstack/lstk#495
Relevant discussion: localstack/lstk#495 (comment)
🤖 Generated with Claude Code