FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(lstk): update CLI reference to v0.16.0 by gtsiolis · Pull Request #774 · localstack/localstack-docs · GitHub

/ localstack-docs Public

docs(lstk): update CLI reference to v0.16.0 - #774

Merged
quetzalliwrites merged 4 commits into
aws-docs-release-augustfrom
claude/wonderful-lovelace-f8t49h
Jul 14, 2026
ConversationCommits (4)ChecksFiles changed
Merged

docs(lstk): update CLI reference to v0.16.0#774
quetzalliwrites merged 4 commits into
aws-docs-release-augustfrom
claude/wonderful-lovelace-f8t49h

Conversation

gtsiolis commented Jul 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

Brings the lstk CLI reference up to date with the current CLI. The doc previously reflected roughly v0.13.0 (last meaningfully expanded in localstack-docs #701, merged 2026-06-24). This PR catches up the full backlog through the latest release, v0.16.0 — covering v0.14.0, v0.14.1, v0.15.0, and v0.16.0.

Rather than trust a diff, I walked the live CLI surface (lstk --help and every subcommand's --help, plus the config/env source), so this flags stale content as well as additions.

New commands / features documented

  • Developer tool proxies — the Tools group in help: lstk az (Azure CLI, incl. start-interception/stop-interception), lstk terraform (alias tf), lstk cdk, and lstk sam, each with its lstk-specific flags, version requirements, and supported env vars.
  • lstk setup azure (alias setup az) — isolated Azure CLI config directory.
  • snapshot show — metadata for a cloud snapshot.
  • S3 remotes for snapshot save / load / list (own-bucket storage, --profile, credential precedence, running-emulator requirement).
  • Snapshot auto-load on start — the snapshot config field and the --snapshot / --no-snapshot flags.
  • New config fields — image (custom/mirror/offline image), volumes (bind mounts + init hooks); added Custom container image and Volume mounts sections.
  • Global flags — --json, --snapshot, --no-snapshot.
  • New sections — Offline and enterprise environments (graceful degradation, local-image fallback, ESC-to-abort pull) and Extensions (Git-style lstk-<name>).
  • Container-injected vars — LOCALSTACK_CLIENT_NAME / LOCALSTACK_CLIENT_VERSION, and a note on GATEWAY_LISTEN host exposure.

Stale content corrected

  • Removed the lstk config profile section — that command was deleted from the CLI (lstk Upgrade Starlight and dependencies #360); replaced with a note pointing to setup aws.
  • setup aws no longer "requires an interactive terminal" — it now runs non-interactively (writes the profile with defaults) and gained a --force flag. Fixed the command section and the interactive/non-interactive note.
  • Snapshots are no longer AWS-only — snapshot save/load now work for Snowflake and Azure with an "experimental" warning; only reset remains AWS-only. Updated the note accordingly.

Notes for reviewers

  • No public-messaging wording changes; all edits describe existing shipped behavior and keep the doc's structure and voice.
  • The Cloudflare Pages preview builds cleanly, and the new MDX mirrors the patterns already used in this file (:::note/:::caution directives balanced, all interpolation kept inside code spans).
  • One thing worth a human eye: the Snowflake/Azure snapshot support is described as "experimental and not fully tested" (matching the CLI's own warning text) — confirm that's the messaging you want in public docs.

Cc @localstack/devx for visibility and any corrections.

cloudflare-workers-and-pages Bot commented Jul 9, 2026 •
edited
Loading

Copy link
Copy Markdown

Deploying localstack-docs with    Cloudflare Pages

Latest commit: 076b02c
Status: ✅  Deploy successful!
Preview URL: https://65d8c703.localstack-docs.pages.dev
Branch Preview URL: https://claude-wonderful-lovelace-f8.localstack-docs.pages.dev

View logs

gtsiolis changed the base branch from main to aws-docs-release-august July 9, 2026 11:43
docs(lstk): update CLI reference to v0.16.0
44f51f1 
Bring the lstk CLI reference up to date with releases v0.14.0 through
v0.16.0 (doc previously reflected ~v0.13.0). Changes:

- Document the Azure CLI proxy (lstk az) with global interception, and
  the IaC tool proxies lstk terraform (alias tf), lstk cdk, and lstk sam.
- Add lstk setup azure and correct lstk setup aws: it now runs
  non-interactively (writes defaults) and gained a --force flag.
- Remove the deleted lstk config profile command.
- Document snapshot show, S3 remotes for save/load/list, and that
  snapshot save/load now work (experimentally) for Snowflake and Azure.
- Document snapshot auto-load on start (snapshot config field,
  --snapshot / --no-snapshot flags).
- Add config fields image, volumes, and snapshot; add Custom container
  image and Volume mounts sections.
- Add global flags --json, --snapshot, --no-snapshot.
- Add Offline and enterprise environments and Extensions sections.
- Document LOCALSTACK_CLIENT_NAME/VERSION injected vars and GATEWAY_LISTEN
  host exposure.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
gtsiolis force-pushed the claude/wonderful-lovelace-f8t49h branch from 9a84173 to 44f51f1 Compare July 9, 2026 11:56

gtsiolis commented Jul 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

@mmaureenliu could you take a look?
Cc @quetzalliwrites for aiming to merge this before Thursday's (Jul 16) release if possible.

gtsiolis requested a review from mmaureenliu July 13, 2026 10:07
mmaureenliu requested changes Jul 14, 2026
View reviewed changes

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for the effort!

Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk.mdx Outdated
docs(lstk): address review feedback
bdf0a8e 
- Intro: drop the "*local wrapper" phrasing; say tools run directly.
- Emulator types: clarify the default aws emulator is used
  non-interactively only when no config file is found; drop snapshot
  from the AWS-only command list (it now works for all emulators).
- az interception caution: soften "Prefer" to "Use" to match the Azure
  docs, which treat interception as the preferred mode.
- terraform: note that lstk terraform currently targets AWS only.
- Remove the Extensions section (deferred).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

gtsiolis commented Jul 14, 2026

Copy link
Copy Markdown
Member Author

Thanks for the review! Addressed the feedback in bdf0a8e:

  • Intro (L23): dropped the "*local wrapper" phrasing — tools now just "run directly against LocalStack".
  • Emulator types (L218): reworded to "the default aws emulator is used if no config file is found".
  • AWS-only list (L221): removed snapshot (it now works for all emulators).
  • az interception (L577): changed "Prefer" → "Use" so it doesn't conflict with the Azure docs' preferred mode.
  • terraform (L580): added a note that lstk terraform currently targets AWS only, pointing to the relevant emulator docs otherwise.
  • Extensions section (L1231): removed (deferred).

One I left as-is: the intro/notes duplication (L17) — you wanted @quetzalliwrites's take first, so I haven't touched it pending that.

Generated by Claude Code

docs(lstk): simplify intro, drop duplicated note
f5b86f7 
Delete the introductory note component and keep only its tool-proxy
sentence as a plain paragraph, per review feedback (the first sentence
duplicated the lifecycle description above).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

gtsiolis commented Jul 14, 2026

Copy link
Copy Markdown
Member Author

Done in f5b86f7 — deleted the intro note component and kept only its second sentence (the tool-proxy list) as a plain paragraph. That was the last open item from the review; all threads should now be addressed. Thanks @quetzalliwrites, @mmaureenliu!

Generated by Claude Code

gtsiolis commented Jul 14, 2026

Copy link
Copy Markdown
Member Author

Small heads-up on the dash→parenthesis change (intro, line 18): the closing em-dash was doing double duty as the clause separator, so the sentence now needs a comma after the parenthesis:

It can also save and load emulator state (as local snapshots or Cloud Pods), reset running state, run AWS CLI commands against the emulator, and manage the on-disk volume.

Happy to push that one-character fix if you'd prefer, or leave it to your style pass — your call, @quetzalliwrites.

Generated by Claude Code

quetzalliwrites commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

ty @gtsiolis for your contribution, you always place such detailed thought into each PR 🌈

quetzalliwrites commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

@gtsiolis let me get back to you before eod on merging this PR, i agree this can/should go live before end of month july aws release

quetzalliwrites changed the base branch from aws-docs-release-august to main July 14, 2026 14:10

quetzalliwrites commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

merging as a hotfix since this is not aws release dependent

gtsiolis changed the base branch from main to aws-docs-release-august July 14, 2026 14:12
quetzalliwrites merged commit 99db09f into aws-docs-release-august Jul 14, 2026
1 of 2 checks passed
quetzalliwrites deleted the claude/wonderful-lovelace-f8t49h branch July 14, 2026 14:12

quetzalliwrites commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

@gtsiolis Holaaa George, a quick reminder regarding PR coordination: When I am actively preparing PRs and managing branch movements, do not make mid-process updates to those branches.

Your recent update accidentally caused this PR to merge into the August release branch instead of main. I know you were likely trying to fix it thinking I mistakenly targetted the main branch, but it disrupted the release flow, and I now have to revert and restart the process.

Moving forward, if you see me actively working on or merging docs PRs, check in with me before making any adjustments so we don't override active work. Thanks for understanding.

gtsiolis restored the claude/wonderful-lovelace-f8t49h branch July 14, 2026 15:01
This was referenced Jul 14, 2026
Merged
Merged
quetzalliwrites pushed a commit that referenced this pull request Jul 15, 2026
Revert "docs(lstk): update CLI reference to v0.16.0 (#774)" (#787)
c4e8275 
Co-authored-by: Claude <noreply@anthropic.com>
quetzalliwrites deleted the claude/wonderful-lovelace-f8t49h branch July 15, 2026 12:47
gtsiolis self-assigned this Jul 28, 2026
gtsiolis mentioned this pull request Aug 6, 2026
Closed
peter-smith-phd mentioned this pull request Aug 25, 2026
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

quetzalliwrites quetzalliwrites approved these changes
remotesynth Awaiting requested review from remotesynth remotesynth is a code owner
HarshCasper Awaiting requested review from HarshCasper HarshCasper is a code owner
mmaureenliu Awaiting requested review from mmaureenliu

Assignees

gtsiolis

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL