Skip to content

docs: drop the manual cua-driver serve step from the first-app tutorial - #2087

Merged
f-trycua merged 2 commits into
mainfrom
docs/tutorial-drop-serve-step
Jul 1, 2026
Merged

docs: drop the manual cua-driver serve step from the first-app tutorial#2087
f-trycua merged 2 commits into
mainfrom
docs/tutorial-drop-serve-step

Conversation

@f-trycua

@f-trycua f-trycua commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

The first-app tutorial told users to run cua-driver serve (macOS: open -n -g -a CuaDriver --args serve) by hand in each install tab. That's unnecessary — the CLI (doctor/call) and the agent's MCP connection start the daemon automatically. Removed the daemon-start blocks from all three tabs; macOS keeps permissions grant (which launches CuaDriver itself). pnpm build + link-check pass.

Publishing: goes live on cua.ai/docs once the website docs-source ref is bumped to include this commit (see trycua/cloud #5308).

Summary by CodeRabbit

  • Documentation
    • Updated the “Install Cua Driver” tutorial with simpler, platform-specific setup guidance.
    • Clarified macOS permission steps by noting that granting Accessibility and Screen Recording launches CuaDriver and shows the prompts from it.
    • Streamlined Windows and Linux instructions by keeping only the installer commands and removing extra follow-up steps.

…rst-app tutorial

The tutorial told users to start the daemon by hand (`cua-driver serve`, or on
macOS `open -n -g -a CuaDriver --args serve`) in each install tab. That's not
needed: the CLI (`doctor`/`call`) and the agent's MCP connection start the daemon
automatically. Removed the daemon-start blocks from the macOS/Windows/Linux tabs;
macOS keeps `permissions grant` (which launches CuaDriver itself for the TCC
prompts). Section 2's verify step is unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011BJPGdRQxiBPTQhjwZsQ8G
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 1, 2026 3:20pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental 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: Pro

Run ID: bd985dde-b2f7-4a84-9054-c5e7ee89a338

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
📝 Walkthrough

Walkthrough

Documentation update to the "Install Cua Driver" tutorial section. macOS instructions simplified to state that granting Accessibility and Screen Recording permissions launches CuaDriver. Windows and Linux tabs had follow-up manual daemon-start instructions (including cua-driver serve) removed.

Changes

Tutorial install instructions update

Layer / File(s) Summary
Simplify install/permission steps
docs/content/docs/tutorials/drive-your-first-app.mdx
macOS guidance now states granting Accessibility and Screen Recording launches CuaDriver and attributes prompts to it; Windows and Linux follow-up steps to manually start the daemon with cua-driver serve were removed.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • trycua/cua#1368: Related change to macOS install script that starts the daemon so permission prompts are attributed to CuaDriver, matching this tutorial's guidance.
  • trycua/cua#1766: Also updates macOS tutorial/install docs reflecting the same permission-granting and always-on CuaDriver behavior.

Poem

A hop, a skip, fewer steps to take,
No more commands to type or fake,
CuaDriver wakes on its own accord,
Permissions granted, prompts restored,
This bunny cheers for docs so lean! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: removing the manual cua-driver serve step from the first-app tutorial.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/tutorial-drop-serve-step

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/content/docs/tutorials/drive-your-first-app.mdx (1)

31-46: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Keep the daemon startup step for Windows/Linux. cua-driver doctor and cua-driver call do not start the daemon, so the tutorial needs an explicit cua-driver serve/autostart step or users will hit a dead end on fresh installs.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/content/docs/tutorials/drive-your-first-app.mdx` around lines 31 - 46,
The platform-specific install sections for Windows/Linux are missing the daemon
startup step, so update the tutorial in the drive-your-first-app doc to include
an explicit `cua-driver serve` or autostart instruction after the install
commands. Keep the existing Windows and Linux tabs, and add the startup guidance
near the `cua-driver doctor`/`cua-driver call` workflow so users can get a
running daemon on fresh installs.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@docs/content/docs/tutorials/drive-your-first-app.mdx`:
- Around line 31-46: The platform-specific install sections for Windows/Linux
are missing the daemon startup step, so update the tutorial in the
drive-your-first-app doc to include an explicit `cua-driver serve` or autostart
instruction after the install commands. Keep the existing Windows and Linux
tabs, and add the startup guidance near the `cua-driver doctor`/`cua-driver
call` workflow so users can get a running daemon on fresh installs.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 77102464-ea7a-4784-bdd3-e642670030fa

📥 Commits

Reviewing files that changed from the base of the PR and between 62b3a7e and 04a8671.

📒 Files selected for processing (1)
  • docs/content/docs/tutorials/drive-your-first-app.mdx

…d pnpm 9)

The docs slimming's pnpm 11 install dropped the `overrides:` block from
docs/pnpm-lock.yaml, so CI's pinned pnpm 9 (`packageManager: pnpm@9.0.4`) failed
`pnpm install --frozen-lockfile` with ERR_PNPM_LOCKFILE_CONFIG_MISMATCH (breaking
the docs link-check + Vercel builds on main). Regenerated the lockfile with
pnpm 9 (`install --lockfile-only`) so package.json's overrides match; frozen
install now passes.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011BJPGdRQxiBPTQhjwZsQ8G
@f-trycua
f-trycua merged commit c39109d into main Jul 1, 2026
7 checks passed
f-trycua added a commit that referenced this pull request Jul 1, 2026
…n-start step (#2097)

#2087 removed the manual `open -n -g -a CuaDriver --args serve` step from the
macOS install tab on the theory that `cua-driver permissions grant` performs the
same LaunchServices launch. In practice, launching the daemon through the app
bundle is what makes the TCC grant attribute to CuaDriver.app (com.trycua.driver)
and register in System Settings — so the step is load-bearing on macOS and is
restored. Windows/Linux stay as-is (no TCC).


Claude-Session: https://claude.ai/code/session_011BJPGdRQxiBPTQhjwZsQ8G

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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