docs(lstk): update CLI reference to v0.15.0#749
Open
gtsiolis wants to merge 1 commit into
Open
Conversation
gtsiolis
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
Deploying localstack-docs with
|
| Latest commit: |
02bc8e5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6ad9a721.localstack-docs.pages.dev |
| Branch Preview URL: | https://claude-sleepy-ritchie-lvio4k.localstack-docs.pages.dev |
Bring the lstk CLI reference up to date with the current CLI surface (last documented around v0.12/v0.13, now v0.15.0): - Document the CLI/IaC proxy tools: az (+ start/stop-interception), terraform (tf), cdk, sam. - Add setup azure; correct setup aws (now has --force and a non-interactive mode, no longer interactive-only). - Add snapshot show and S3-remote support for snapshot save/load/list (--profile, credential precedence, running-emulator requirement). - Note snapshot now works for Snowflake/Azure with an experimental warning; only reset stays AWS-only. - Add global --snapshot/--no-snapshot flags and snapshot auto-load on start; document LOCALSTACK_ env forwarding. - Add config fields image, volumes, and snapshot; add a Volume mounts section. - Add an Extensions section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QRmA1n8vtvoT3DnGQzRk87
gtsiolis
force-pushed
the
claude/sleepy-ritchie-lvio4k
branch
from
9130fa3 to
02bc8e5
Compare
Member
Author
|
Not sure why @nik-localstack and @pinzon were added above[1] as reviewers. Cc @quetzalliwrites @remotesynth |
Member
Author
|
Cc @mmaureenliu for visibility |
gtsiolis
requested review from
a team,
carole-lavillonniere and
mmaureenliu
and removed request for
nik-localstack and
pinzon
Collaborator
|
@gtsiolis hey! the reason it pings the other two folks is because our codeowner's file is going to add the engineer service owner listed |
Member
Author
|
Ah, I see. But the file mentioned[1] has nothing to do with the change in this PR, maybe it's a fallback or I guess we don't have an engineer assigned for the |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Brings the lstk CLI reference up to date with the current CLI surface. This is the first automated pass triggered by the
v0.15.0release, so it was a full audit of the live CLI (lstk --helpand every subcommand) against the doc rather than a single-release diff.The doc was last expanded around v0.12/v0.13 and had never documented several features that already shipped by then. This PR catches up the full backlog through v0.15.0.
Additions
az(incl.az start-interception/az stop-interception),terraform(aliastf),cdk, andsam: usage, the leading--region/--accountflags, offline-vs-running-emulator behavior, minimum tool versions, and supported env vars (AWS_ENDPOINT_URL,LSTK_TF_CMD,LSTK_SAM_CMD,LSTK_CDK_CMD, etc.).setup azure— isolatedAZURE_CONFIG_DIRsetup that routeslstk azto the Azure emulator.snapshot show— new subcommand (cloud-only).snapshot save/load/listnow accepts3://bucket/prefixwith a separate pod-name positional and a--profileflag; documented credential precedence and the running-emulator requirement forlist s3://….snapshotconfig field, plus global--snapshot <ref>/--no-snapshotflags.image(Docker image override),volumes(bind mounts) with a new Volume mounts section, andsnapshot.lstk-<name>dispatch and theLSTK_EXT_*runtime context.LOCALSTACK_-prefixed env vars are forwarded to the emulator on start.Corrections (stale content)
setup awsis no longer interactive-only: it now has a--forceflag and a non-interactive mode (writes the profile with defaults and exits 0). Removed the "requires an interactive terminal / no flag to auto-confirm" note.snapshotnow works for the Snowflake and Azure emulators too, with an experimental-support warning — it is no longer AWS-only. Onlyresetremains strictly AWS-only. Updated the "four subcommands" count to five.Needs a human eye
az/terraform/cdk/sam) and extensions are documented inline in the reference; if a fuller standalone guide is planned, these sections may want to link out to it later.Cc @localstack/devx for visibility and any corrections.
Generated by Claude Code