Skip to content

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

Open
gtsiolis wants to merge 1 commit into
aws-docs-release-augustfrom
claude/wonderful-lovelace-f8t49h
Open

docs(lstk): update CLI reference to v0.16.0#774
gtsiolis wants to merge 1 commit into
aws-docs-release-augustfrom
claude/wonderful-lovelace-f8t49h

Conversation

@gtsiolis

@gtsiolis gtsiolis commented Jul 9, 2026

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 fieldsimage (custom/mirror/offline image), volumes (bind mounts + init hooks); added Custom container image and Volume mounts sections.
  • Global flags--json, --snapshot, --no-snapshot.
  • New sectionsOffline and enterprise environments (graceful degradation, local-image fallback, ESC-to-abort pull) and Extensions (Git-style lstk-<name>).
  • Container-injected varsLOCALSTACK_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-onlysnapshot 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

cloudflare-workers-and-pages Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 44f51f1
Status: ✅  Deploy successful!
Preview URL: https://6086fb66.localstack-docs.pages.dev
Branch Preview URL: https://claude-wonderful-lovelace-f8.localstack-docs.pages.dev

View logs

@gtsiolis gtsiolis changed the base branch from main to aws-docs-release-august July 9, 2026 11:43
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 gtsiolis force-pushed the claude/wonderful-lovelace-f8t49h branch from 9a84173 to 44f51f1 Compare July 9, 2026 11:56
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.

1 participant