docs: add kubb studio reference, guide and launch post - #201
Conversation
The kubb studio command shipped in kubb v5 with no page on kubb.dev. Adds a CLI reference covering the four actions, the flags, pairing, and the permission model, plus an integration guide for connecting a project, running headless in CI, and pointing at a self-hosted Studio. Lists the command in the commands index and notes on the integrations index that Studio is a session rather than a bundler entrypoint. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
|
◈ PR Lens
Architecture 3 components touched across 2 lanes. Data flow No data-flow sequence changed in this PR. Drill down
|
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Integrations covers unplugin bundler entrypoints, so the Studio guide does not belong there. Moves it next to the Claude Code plugin page in Going further, which already holds this kind of integration write-up, and drops the note added to the integrations index. Adds a launch post for Kubb Studio covering the local execution model, pairing, the permission defaults, and config writeback. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
@kubb/studio now ships as a dependency of @kubb/cli and the kubb meta package (kubb-labs/kubb), so `kubb studio` works on a plain `kubb` install. Removes the install sections from the command reference and the guide, and the install line from the blog post. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
Studio belongs next to the bundler entrypoints rather than in Going further, so the guide moves back and the index stops describing the section as unplugin only. The intro now covers both ways to run Kubb outside the CLI, the bundler entrypoints keep their own section, and Studio gets a short one explaining when to reach for it instead. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
Keep the shipped CLI surface (login, logout, status, --no-open) and drop the mechanism behind it: the device-code flow, token minting and hashing, the credentials file path and mode, and the machine secret. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
Cut the blog post, guide, and CLI reference down from 4-5 minutes to around 3, folding duplicate sections and dropping restated detail. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
The status example showed "Connected to ..." but the CLI's actual output is "Paired with ... as ...". The rest of the docs deliberately soften "pairing" to "connecting" in prose, but a terminal block claiming to show real output has to match what the CLI prints. Also reworded the blog's node_modules mention to describe the effect (your project's installed plugin versions) without naming the directory. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP
Changes
kubb studioshipped in kubb v5 (kubb-labs/kubb#3972) with nothing on kubb.dev. This adds three pages and links them from the existing indexes.docs/5.x/reference/commands/studio.mdis the CLI reference, following the same shape askubb mcp. It covers the four actions (connect,login,logout,status), every flag with its default, and the four permissions. Every fact comes frompackages/cli/src/commands/studio.tsandrunners/studio/run.tsrather than paraphrase, including two things worth knowing before you hit them: flags are camelCase and--allow-writeis ignored without a warning, and nothing is asked in CI or without a TTY so an unattended run cannot widen its own access. The pairing mechanism (RFC 8628, token storage, credential file paths) stays out of this page and lives in the platform repo's internalARCHITECTURE.mdinstead.docs/5.x/guide/integrations/studio.mdis the task-oriented guide, alongside the bundler entrypoints: connect a project, pick what Studio may do, run headless withKUBB_AGENT_TOKEN, and point at a self-hosted instance with--url.blog/kubb-studio.mdis the launch post. It leads with the reason the split exists (a hosted generator needs your spec, and for an internal API that is a non-starter), then walks through connecting, the read-only default and the four permissions, and config writeback as an AST patch. Kept to a 2-3 minute read.Supporting edits:
kubb studionow appears in the commands index (usage block, table, environment variables).All three pages went through the humanizer skill. The sidebar entry, blog index entry, and cover image live in the platform repo, in kubb-labs/platform#406 (merged).
Checklist
🤖 Generated with Claude Code
https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP