Skip to content

docs(lstk hotfix): update CLI reference to v0.17.1#791

Open
gtsiolis wants to merge 1 commit into
mainfrom
claude/determined-dirac-1000y5
Open

docs(lstk hotfix): update CLI reference to v0.17.1#791
gtsiolis wants to merge 1 commit into
mainfrom
claude/determined-dirac-1000y5

Conversation

@gtsiolis

Copy link
Copy Markdown
Member

Brings the lstk CLI reference up to date with v0.17.1. The reference was last updated for v0.16.0 (#788); all user-facing changes in this range landed in v0.17.0 (v0.17.1 is a hotfix carrying only dependency, test, and lstk-repo doc changes).

What changed

  • Structured output (--json) — new section documenting the machine-readable JSON envelope: its shape (schemaVersion, command, status, data, warnings, error), the error object (code/category/message/retryable), and the exit-code conventions (0 ok, 1 error, 2 pre---json usage error, 3 CONFIRMATION_REQUIRED, 4 AUTH_REQUIRED). Only stop, reset, and update accept --json today; every other command rejects it with NOT_JSON_CAPABLE. Added short --json notes to those three command sections.
  • Global options — corrected the stale --json row, which claimed the flag was supported "e.g. the tool proxies"; it is not. It now points to the new section and names the supported commands.
  • Offline / enterprise — the license pre-flight now defers to the emulator's own startup check (rather than failing) when the license server does not recognize the image tag format — e.g. a dev nightly or a custom internal-mirror tag. Documented alongside the existing offline/transport-failure degradation.
  • Docker socket auto-probe — added ~/.config/colima/default/docker.sock to the list of alternative sockets lstk probes when DOCKER_HOST is unset.

Notes for reviewers

  • No public-messaging decisions here — this is a straight sync of the reference to the shipped CLI surface. The one judgment call worth a look is the depth of the new Structured output section: it documents the stable envelope and exit codes but intentionally omits the per-command data schemas and the full 28-code error table (those live in the CLI's internal contract doc and are still being rolled out per command), to avoid publishing shapes that may still change.

Cc @localstack/devx for visibility and any corrections.


Generated by Claude Code

Catch the lstk CLI reference up to v0.17.1 (user-facing changes landed
in v0.17.0):

- Document the global --json structured-output flag: the envelope shape,
  error object, exit-code conventions, and the commands that support it
  today (stop, reset, update); correct the stale global-options entry
  that claimed the tool proxies support it.
- Note the license pre-flight now defers to the emulator (instead of
  failing) when the server does not recognize the image tag format
  (dev nightlies, custom internal-mirror tags).
- Add the ~/.config/colima Docker socket path to the auto-probe list.

Co-Authored-By: Claude <noreply@anthropic.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 99bf1e1
Status: ✅  Deploy successful!
Preview URL: https://5b6d613c.localstack-docs.pages.dev
Branch Preview URL: https://claude-determined-dirac-1000.localstack-docs.pages.dev

View logs

@gtsiolis gtsiolis self-assigned this Jul 16, 2026
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