docs(lstk): update CLI reference to v0.16.0#774
Conversation
Deploying localstack-docs with
|
| 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 |
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>
9a84173 to
44f51f1
Compare
|
@mmaureenliu could you take a look? |
- 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>
|
Thanks for the review! Addressed the feedback in
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 |
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>
|
Done in Generated by Claude Code |
|
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:
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 |
|
ty @gtsiolis for your contribution, you always place such detailed thought into each PR 🌈 |
|
@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 |
|
merging as a |
99db09f
into
aws-docs-release-august
|
@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 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. |
Summary
Brings the
lstkCLI 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 --helpand every subcommand's--help, plus the config/env source), so this flags stale content as well as additions.New commands / features documented
Toolsgroup in help:lstk az(Azure CLI, incl.start-interception/stop-interception),lstk terraform(aliastf),lstk cdk, andlstk sam, each with its lstk-specific flags, version requirements, and supported env vars.lstk setup azure(aliassetup az) — isolated Azure CLI config directory.snapshot show— metadata for a cloud snapshot.snapshot save/load/list(own-bucket storage,--profile, credential precedence, running-emulator requirement).snapshotconfig field and the--snapshot/--no-snapshotflags.image(custom/mirror/offline image),volumes(bind mounts + init hooks); added Custom container image and Volume mounts sections.--json,--snapshot,--no-snapshot.lstk-<name>).LOCALSTACK_CLIENT_NAME/LOCALSTACK_CLIENT_VERSION, and a note onGATEWAY_LISTENhost exposure.Stale content corrected
lstk config profilesection — that command was deleted from the CLI (lstk Upgrade Starlight and dependencies #360); replaced with a note pointing tosetup aws.setup awsno longer "requires an interactive terminal" — it now runs non-interactively (writes the profile with defaults) and gained a--forceflag. Fixed the command section and the interactive/non-interactive note.snapshot save/loadnow work for Snowflake and Azure with an "experimental" warning; onlyresetremains AWS-only. Updated the note accordingly.Notes for reviewers
:::note/:::cautiondirectives balanced, all interpolation kept inside code spans).Cc @localstack/devx for visibility and any corrections.