Skip to content

Regenerate CLI docs and bump API reference to v0.0.1-rc48 - #228

Merged
kylemclaren merged 1 commit into
mainfrom
update-cli-docs-api-rc48
Aug 20, 2026
Merged

Regenerate CLI docs and bump API reference to v0.0.1-rc48#228
kylemclaren merged 1 commit into
mainfrom
update-cli-docs-api-rc48

Conversation

@kylemclaren

Copy link
Copy Markdown
Collaborator

Routine refresh of the CLI reference and the API version selector.

CLI docs

Regenerated src/content/docs/cli/commands.mdx against the current CLI. The only new surface is sprite proxy --ssh — emulates an SSH session over stdio for use as an ssh ProxyCommand.

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 url rendered as one run-on line inside a code fence:

- sprite url                  Show sprite URL and auth setting sprite url update [flags]   Update URL authentication settings URL Format: https://<sprite-name>-<org>.sprites.app/ Authentication Modes: sprite     Allows access via browser to …
+ sprite url                  Show sprite URL and auth setting
+ sprite url update [flags]   Update URL authentication settings

sprite proxy had 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:

- - `--ssh Emulate` - an SSH session with a Sprite over stdio, for use as an ssh ProxyCommand.
+ - `--ssh` - Emulate an SSH session with a Sprite over stdio, for use as an ssh ProxyCommand.

The generator writes a trailing newline, so regenerating no longer produces a \ No newline at end of file diff.

API reference

src/lib/api-versions.ts moves to v0.0.1-rc48. I diffed the rc46 and rc48 schemas — endpoints, types, enums, and websocket messages are identical; only the version and generated stamps 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 passing
  • pnpm lint — clean

Note for reviewers

Worth knowing, not fixed here: the CLI has moved off v0.0.1-rcNN versioning onto date-based releases (the current binary reports 2026-08-14), and rc/dev channels no longer resolve — release is the only channel left. The API schema still uses rcNN, hence rc48 above. cli/installation.mdx documents sprite upgrade --channel rc, which now errors with no such channel: rc; that needs a follow-up once the CLI versioning story settles.

Also pre-existing and left alone: the generator's parseMainHelp looks for a Global Options: header but the CLI prints Global Flags:, so the global-options section of the page has been empty for a while. Easy follow-up if we want --debug documented.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PaigmfRkf95qHh1T2FxdP8

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
@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

Name URL
Preview https://pr-228-superfly-sprites-docs.fly.dev

Commit: 5934688

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟢 96 🟢 97 🟢 96 🟢 100
/cli/commands/ 🟢 100 🟢 97 🟢 100 🟢 100

@github-actions

Copy link
Copy Markdown
Contributor

E2E Test Results

✅ Tests success

Ran against: https://pr-228-superfly-sprites-docs.fly.dev

@kylemclaren
kylemclaren merged commit 1a49e26 into main Aug 20, 2026
5 checks passed
@kylemclaren
kylemclaren deleted the update-cli-docs-api-rc48 branch August 20, 2026 14:45
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