Skip to content

[codex] Document Codex cua-driver onboarding - #2107

Merged
f-trycua merged 2 commits into
mainfrom
codex/codex-cua-driver-onboarding-docs
Jul 5, 2026
Merged

[codex] Document Codex cua-driver onboarding#2107
f-trycua merged 2 commits into
mainfrom
codex/codex-cua-driver-onboarding-docs

Conversation

@f-trycua

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

Copy link
Copy Markdown
Collaborator

Summary

  • update Codex MCP setup docs to use cua-driver mcp-config --client codex
  • mention that Codex needs a fresh session after MCP registration
  • document the optional Codex skill-pack directory fallback
  • point macOS permission verification at cua-driver permissions status

Why

These notes cover friction hit during a real first-run setup: PATH-sensitive MCP registration, session reload expectations, and the missing ~/.agents/skills directory for the optional skill pack.

Validation

  • reviewed docs diff for secrets and local machine details
  • pnpm exec prettier --check docs/content/docs/how-to-guides/driver/connect-your-agent.mdx docs/content/docs/tutorials/drive-your-first-app.mdx
  • docs-only change; no runtime tests run

Summary by CodeRabbit

  • Documentation
    • Updated the agent connection guides with the latest macOS permission check command.
    • Improved Codex setup steps to generate the correct registration command automatically, including support for an installed binary path.
    • Added clearer guidance for restarting Codex after registration so new tools appear.
    • Expanded setup instructions to verify the Cua Driver skill and handle missing Codex skill directories.

@vercel

vercel Bot commented Jul 5, 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 5, 2026 4:27pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6c6598d7-b653-4b48-a4d0-dda09f643b59

📥 Commits

Reviewing files that changed from the base of the PR and between 73fe822 and 98acf8c.

📒 Files selected for processing (2)
  • docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
  • docs/content/docs/tutorials/drive-your-first-app.mdx

📝 Walkthrough

Walkthrough

This PR updates two documentation files. It changes the macOS permissions verification command, replaces the hardcoded Codex MCP registration command with a generated command using an absolute binary path, and adds Codex restart and Cua Driver skills installation steps.

Changes

Cua Driver documentation updates

Layer / File(s) Summary
Permissions command update
docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
Changes macOS permissions verification command from cua-driver call check_permissions to cua-driver permissions status.
Codex MCP registration flow
docs/content/docs/how-to-guides/driver/connect-your-agent.mdx, docs/content/docs/tutorials/drive-your-first-app.mdx
Replaces hardcoded Codex registration command with a generated flow via cua-driver mcp-config --client codex, using an absolute installed binary path in both docs.
Codex post-setup and skills installation
docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
Adds restart/fresh-session instructions and new steps to install/verify Cua Driver skills, with a fallback to create the skills directory if missing.

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

Possibly related PRs

  • trycua/cua#1681: Both PRs update MCP client registration docs to use cua-driver mcp-config --client <client> and copy the printed registration command.
  • trycua/cua#2089: Both PRs update the same macOS documentation to verify permissions via cua-driver permissions status instead of cua-driver call check_permissions.
  • trycua/cua#1766: Both PRs steer macOS documentation toward the cua-driver permissions status workflow for permission verification.

Poem

A rabbit hops through docs with glee,
New commands set our permissions free,
Codex restarts, skills install with care,
Absolute paths now everywhere,
Hop, hop, hooray for docs done right! 🐇📖

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/codex-cua-driver-onboarding-docs

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.

@f-trycua
f-trycua marked this pull request as ready for review July 5, 2026 16:26
@cursor

cursor Bot commented Jul 5, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@f-trycua
f-trycua merged commit 4c4b7b6 into main Jul 5, 2026
5 of 7 checks passed
@f-trycua
f-trycua deleted the codex/codex-cua-driver-onboarding-docs branch July 5, 2026 16:26
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