docs(lstk hotfix): update CLI reference to v0.17.1#791
Open
gtsiolis wants to merge 3 commits into
Open
Conversation
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>
gtsiolis
requested review from
HarshCasper,
quetzalliwrites and
remotesynth
as code owners
July 16, 2026 11:13
Deploying localstack-docs with
|
| Latest commit: |
f0ad421
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7a240d2e.localstack-docs.pages.dev |
| Branch Preview URL: | https://claude-determined-dirac-1000.localstack-docs.pages.dev |
| ## Structured output | ||
|
|
||
| The global `--json` flag makes a command emit a single, machine-readable JSON object on stdout instead of human-oriented text, for scripting and CI. | ||
| JSON support is being rolled out per command: today `stop`, `reset`, and `update` accept `--json`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| JSON support is being rolled out per command: today `stop`, `reset`, and `update` accept `--json`. | |
| JSON support is being rolled out per command: `stop`, `reset`, and `update` accept `--json`. |
Collaborator
There was a problem hiding this comment.
hey @gtsiolis, in technical documentation, avoids words like "today" (when used to denote a current status). Using "today" ages the document instantly.
Good documentation aims for timelessness. Instead, let's focus on what is supported.
Member
Author
There was a problem hiding this comment.
Makes sense, thanks! Applied it here and also removed a second "today" in the --json row of the Global options table so the phrasing stays timeless throughout.
Generated by Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Collaborator
|
let's get a review from @mmaureenliu too |
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.
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
--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 (0ok,1error,2pre---jsonusage error,3CONFIRMATION_REQUIRED,4AUTH_REQUIRED). Onlystop,reset, andupdateaccept--jsontoday; every other command rejects it withNOT_JSON_CAPABLE. Added short--jsonnotes to those three command sections.--jsonrow, 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.devnightly or a custom internal-mirror tag. Documented alongside the existing offline/transport-failure degradation.~/.config/colima/default/docker.sockto the list of alternative socketslstkprobes whenDOCKER_HOSTis unset.Notes for reviewers
dataschemas 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