Skip to content

Expand lstk CLI reference documentation#701

Open
gtsiolis wants to merge 1 commit into
mainfrom
pro-313-expand-lstk-cli-reference-documentation
Open

Expand lstk CLI reference documentation#701
gtsiolis wants to merge 1 commit into
mainfrom
pro-313-expand-lstk-cli-reference-documentation

Conversation

@gtsiolis

@gtsiolis gtsiolis commented Jun 12, 2026

Copy link
Copy Markdown
Member

Summary

Expands the lstk reference page from a short overview into a complete CLI reference — installation, authentication, configuration, the full command set, and troubleshooting.

What is added

  • Commands: start, stop, restart, status, logs, aws, snapshot (save / load / list / remove), reset, volume (path / clear), login, logout, setup, config (path / profile), update, completion.
  • Configuration: config-file search order, default config.toml, field reference, emulator types (AWS / Snowflake / Azure), reusable env profiles, and project-local config.
  • Authentication: keyring → env → browser resolution order, login / logout, and the file-based token fallback.
  • State & Cloud Pods: local .zip vs pod: snapshots, the --merge strategies, and listing/removing Cloud Pods.
  • Operational reference: global options, interactive vs non-interactive mode, environment variables (including container-injected), OpenTelemetry tracing, logging, shell completions, FAQ, and troubleshooting.

Notes

  • Command syntax, flags, and behavior were verified against the localstack/lstk source (cmd/*.go).
  • Follow-up (separate PR): az (Azure CLI proxy), terraform / tf (Terraform proxy), and setup azure are not yet documented.

Fix PRO-313

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4e3db9b
Status: ✅  Deploy successful!
Preview URL: https://6eba3a89.localstack-docs.pages.dev
Branch Preview URL: https://pro-313-expand-lstk-cli-refe.localstack-docs.pages.dev

View logs

@gtsiolis gtsiolis force-pushed the pro-313-expand-lstk-cli-reference-documentation branch from f02519f to 4e3db9b Compare June 12, 2026 12:24
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