Skip to content

docs: add kubb studio reference, guide and launch post - #201

Merged
stijnvanhulle merged 7 commits into
mainfrom
claude/kubb-stacked-prs-24tb0y
Sep 4, 2026
Merged

docs: add kubb studio reference, guide and launch post#201
stijnvanhulle merged 7 commits into
mainfrom
claude/kubb-stacked-prs-24tb0y

Conversation

@stijnvanhulle

@stijnvanhulle stijnvanhulle commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Changes

kubb studio shipped 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.md is the CLI reference, following the same shape as kubb mcp. It covers the four actions (connect, login, logout, status), every flag with its default, and the four permissions. Every fact comes from packages/cli/src/commands/studio.ts and runners/studio/run.ts rather than paraphrase, including two things worth knowing before you hit them: flags are camelCase and --allow-write is 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 internal ARCHITECTURE.md instead.

docs/5.x/guide/integrations/studio.md is the task-oriented guide, alongside the bundler entrypoints: connect a project, pick what Studio may do, run headless with KUBB_AGENT_TOKEN, and point at a self-hosted instance with --url.

blog/kubb-studio.md is 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 studio now 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

  • I have followed the steps in the Contributing guide.
  • I am using USA English (serialize, color, center, canceled, analyze, license).
  • I ran the humanizer check on any new documentation I wrote.

🤖 Generated with Claude Code

https://claude.ai/code/session_018oTZxx4JE5oY1Wb6NC4ojP

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
@changeset-bot

changeset-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c7dae6e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coldtea-pr-lens

coldtea-pr-lens Bot commented Sep 4, 2026

Copy link
Copy Markdown

◈ PR Lens

🟢 +1 new · 🟠 ~2 changed · 🔴 -0 removed · 0 flows · 5 files · commit c7dae6e


Architecture

Architecture diagram for kubb-labs/docs at c7dae6e

3 components touched across 2 lanes.

Open full size


Data flow

No data-flow sequence changed in this PR.


Drill down
Core Documentation — 3 components
🟡 CHANGED Concepts & Integration Guides

Explains architectural concepts and tool integrations, adding guides for connecting and configuring Kubb Studio sessions.

🟡 CHANGED CLI Commands Reference

Reference documentation for CLI commands and shared options, adding the `kubb studio` command reference, actions, flags, and environment variables.

🟢 NEW Blog & Announcements

Contains announcements and release posts, adding the launch article introducing Kubb Studio's browser-driven local generation workflow.


View

  • Architecture lens
  • Data flow lens
  • Expand every detail
  • Show unchanged neighbours

Tip

The diagrams follow your GitHub theme, so dark mode gets the dark render and light mode the light one, and the moving dots show this pull request's data in motion.

🪧 More tips
  • Run PR Lens on your own machine: npx skills add coldteadotai/pr-lens installs the agent skill. Then tell your coding agent: "Diagram the change you just made with PR Lens and attach it to the pull request."
  • Draw a diff before it is even a pull request: npx @coldtea/pr-lens-cli analyze --base origin/main reads the diff with your own model key, and npx @coldtea/pr-lens-cli render .pr-lens/graph.json draws the same lenses on your machine.
  • The boxes under View are live. Tick Architecture lens or Data flow lens to choose which diagrams appear, or Expand every detail to open every drill-down at once. The comment redraws in place a few seconds later.
  • Show unchanged neighbours lists the components this change did not touch alongside the ones it did, so the drill-down shows what the changed code sits next to.
  • GitHub will not let you zoom an image in a comment. The link under each diagram opens it full size on a page of its own, where you can.
  • The CLI's render picks up .github/pr-lens.yml automatically and applies your corrections (renames, exclusions, lane pins) at draw time.
  • Would you rather run it from CI on a key of your own? Add .github/workflows/pr-lens.yml with coldteadotai/pr-lens/packages/action@v0 and a model key in your repository secrets, say GEMINI_API_KEY. The Action asks Gemini by default, or OpenAI and any endpoint speaking /chat/completions through its provider input.
  • PR Lens is free for open source. A star on the repository is what keeps it going.
  • Push a new commit and the whole comment re-renders for the new head. An older run never overwrites a newer one, so a slow render cannot put a stale diagram back.

◈ Rendered by PR Lens · crafted with ❤️ by the Coldtea team · Come say hi on Discord

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 64e0be5e-1e22-4f29-bcf9-4985a61b4910

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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
@stijnvanhulle stijnvanhulle changed the title docs: add kubb studio command reference and integration guide docs: add kubb studio reference, guide and launch post Sep 4, 2026
@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
@stijnvanhulle
stijnvanhulle merged commit d938429 into main Sep 4, 2026
3 checks passed
@stijnvanhulle
stijnvanhulle deleted the claude/kubb-stacked-prs-24tb0y branch September 4, 2026 10:13
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.

2 participants