Skip to content

DOCS: move lstk setup instructions into the CLI - #937

Open
joe4dev wants to merge 4 commits into
mainfrom
devx-821-lstk-shell-completions
Open

DOCS: move lstk setup instructions into the CLI#937
joe4dev wants to merge 4 commits into
mainfrom
devx-821-lstk-shell-completions

Conversation

@joe4dev

@joe4dev joe4dev commented Sep 10, 2026

Copy link
Copy Markdown
Member

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 completion prints them

PREVIEW:

What changed

The per-shell code tabs are gone. The section is now:

lstk includes completion scripts for bash, zsh, fish, and powershell.
If you installed via Homebrew, completions are set up automatically.

Run lstk completion to print setup instructions in your terminal.

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 Homebrew site-functions path is not on the built-in zsh's $fpath), omitted the required compinit step without which the zsh script fails with compdef: 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

@joe4dev joe4dev added the documentation Improvements or additions to documentation label Sep 10, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 10, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@joe4dev
joe4dev force-pushed the devx-821-lstk-shell-completions branch from 9fd6afb to 035b8a0 Compare September 10, 2026 19:05
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@joe4dev joe4dev changed the title Update lstk shell completions to match the CLI Point lstk shell completions at the CLI Sep 11, 2026
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@joe4dev joe4dev changed the title Point lstk shell completions at the CLI Move lstk setup instructions into the CLI Sep 11, 2026
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@joe4dev
joe4dev marked this pull request as ready for review September 11, 2026 14:49
@joe4dev
joe4dev requested a review from gtsiolis September 11, 2026 14:49
@quetzalliwrites quetzalliwrites changed the title Move lstk setup instructions into the CLI DOCS: move lstk setup instructions into the CLI Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants