Skip to content

docs(lstk hotfix): update CLI reference to v0.18.0#808

Open
gtsiolis wants to merge 1 commit into
mainfrom
claude/zealous-davinci-n9hwn9
Open

docs(lstk hotfix): update CLI reference to v0.18.0#808
gtsiolis wants to merge 1 commit into
mainfrom
claude/zealous-davinci-n9hwn9

Conversation

@gtsiolis

Copy link
Copy Markdown
Member

Brings the lstk CLI reference up to date with the v0.18.0 release. The doc previously reflected v0.17.1 (#791); this covers the full v0.17.1..v0.18.0 range.

What changed

  • lstk logs: documented the new --tail/-n flag (last N lines, or all; default all).
  • lstk start: documented the new --type/-t flag for non-interactive emulator selection, including that it records the choice in config.toml and how switching an existing config behaves (custom image is a hard error; non-latest tag and volumes kept with a warning; positional rejected). Added it to both the start options and Global options tables.
  • Startup readiness deadline: documented the new LSTK_STARTUP_TIMEOUT env var and the per-mode behavior (20s interactive/recoverable vs 60s non-interactive/fatal; instant crash detection).
  • Snapshot merge default: documented the new LSTK_MERGE_STRATEGY env var (default merge strategy when --merge is omitted).
  • Multiple installs: noted that lstk update and the start-time notification warn when more than one lstk is found on PATH.
  • Signal forwarding: added a note that interrupting a proxied tool (aws/terraform/cdk/sam/az) forwards the signal for graceful shutdown and preserves the tool's exit code.
  • Bash completion fix: changed the recommended one-liner from source <(lstk completion bash) to eval "$(lstk completion bash)", since source <(...) is a silent no-op on stock macOS bash 3.2.

Environment-variables table gained LSTK_STARTUP_TIMEOUT and LSTK_MERGE_STRATEGY.

Note: --timeout (the flag form of the startup deadline) landed on main after the v0.18.0 tag, so it is intentionally not documented here yet.

Review

Advisable. The changes are additive and mechanically verified against the code at the v0.18.0 tag, but a few of the new notes introduce user-facing wording (the signal-forwarding behavior, the multiple-installs warning, and the startup-deadline phrasing) — worth a glance to confirm the messaging reads the way the team wants.

Cc @localstack/devx for visibility and any corrections.


Generated by Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 82b06a4
Status: ✅  Deploy successful!
Preview URL: https://e1dcd2d8.localstack-docs.pages.dev
Branch Preview URL: https://claude-zealous-davinci-n9hwn.localstack-docs.pages.dev

View logs

Copy link
Copy Markdown
Member Author

The Validate Refs check is red, but it's the branch-naming policy gate, not a problem with this change: it only allows PRs into main from aws-docs-* or snowflake-docs-* head branches. This PR is from a working branch, so that check stays red — the same as the previous lstk hotfix (#791), which merged despite it.

The meaningful check, Cloudflare Pages, is green and the preview built successfully, so the MDX and cross-references are valid. This will need a maintainer merge to land.


Generated by Claude Code

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Yes, @gtsiolis, your understanding of the broken build and it's subsequent error is correct.

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

@mmaureenliu adding you too!

@mmaureenliu mmaureenliu left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants