Regenerate CLI docs and bump API reference to v0.0.1-rc48 - #228
Merged
Conversation
Regenerate `cli/commands.mdx` against the current CLI, which documents the new `sprite proxy --ssh` flag for use as an ssh ProxyCommand. Three help-parser fixes were needed to keep the regenerated output correct: - The usage block now ends at the first blank line and keeps each invocation form on its own line. Previously every following line was joined with a space, so `sprite url` rendered its usage, URL format, auth modes, and subcommands as one run-on line inside a code fence, and `sprite proxy` produced a command that doesn't exist. - Flag arguments are only recognised in placeholder form (`<name>`, `<[host]:port>`). The old pattern swallowed the first word of the description instead, giving us `-h, --help Show` - this help message across every command. - The generator writes a trailing newline so regenerations stop producing a no-newline-at-end-of-file diff. The API reference moves to v0.0.1-rc48. The schema is unchanged from rc46 apart from its version and generation stamps, so this is a version label bump only. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PaigmfRkf95qHh1T2FxdP8
Contributor
Preview Deployment
Commit: |
Contributor
Lighthouse Results
|
Contributor
E2E Test Results✅ Tests success Ran against: https://pr-228-superfly-sprites-docs.fly.dev |
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
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.
Routine refresh of the CLI reference and the API version selector.
CLI docs
Regenerated
src/content/docs/cli/commands.mdxagainst the current CLI. The only new surface issprite proxy --ssh— emulates an SSH session over stdio for use as an sshProxyCommand.Getting that line to render correctly meant fixing three bugs in
scripts/generate-cli-docs/help-parser.ts, which is where most of the diff comes from:Usage blocks now stop at the first blank line, and keep one invocation form per line. Previously every subsequent line was joined with a space, so
sprite urlrendered as one run-on line inside a code fence:sprite proxyhad the same problem and would have advertised a command that doesn't exist.Flag arguments are only recognised in placeholder form (
<name>,<[host]:port>). The old pattern grabbed the first word of the description instead, which is why every command listed`-h, --help Show` - this help message. That accounts for the repeated one-line changes throughout the file:The generator writes a trailing newline, so regenerating no longer produces a
\ No newline at end of filediff.API reference
src/lib/api-versions.tsmoves tov0.0.1-rc48. I diffed the rc46 and rc48 schemas — endpoints, types, enums, and websocket messages are identical; only theversionandgeneratedstamps changed. So this is a label bump, and the generated pages are unchanged apart from version strings. Same shape as #214.Verification
pnpm build— clean, emits/api/v001-rc48/*pnpm test:e2e— 29/29 passingpnpm lint— cleanNote for reviewers
Worth knowing, not fixed here: the CLI has moved off
v0.0.1-rcNNversioning onto date-based releases (the current binary reports2026-08-14), andrc/devchannels no longer resolve —releaseis the only channel left. The API schema still usesrcNN, hence rc48 above.cli/installation.mdxdocumentssprite upgrade --channel rc, which now errors withno such channel: rc; that needs a follow-up once the CLI versioning story settles.Also pre-existing and left alone: the generator's
parseMainHelplooks for aGlobal Options:header but the CLI printsGlobal Flags:, so the global-options section of the page has been empty for a while. Easy follow-up if we want--debugdocumented.🤖 Generated with Claude Code
https://claude.ai/code/session_01PaigmfRkf95qHh1T2FxdP8