Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

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

Francesco Bonacci4c4b7b664107
diff --git a/docs/content/docs/how-to-guides/driver/connect-your-agent.mdx b/docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
index c266bb3417..0384ef32aa 100644
--- a/docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
+++ b/docs/content/docs/how-to-guides/driver/connect-your-agent.mdx
@@ -12,7 +12,7 @@ import { Callout } from 'fumadocs-ui/components/callout';
</Callout>
<Callout type="warn">
- Grant the required permissions before you connect an agent. On macOS, grant Accessibility and Screen Recording. Verify them with `cua-driver call check_permissions`.
+ Grant the required permissions before you connect an agent. On macOS, grant Accessibility and Screen Recording. Verify them with `cua-driver permissions status`.
</Callout>
The helper command prints the exact registration snippet for each supported client:
@@ -60,10 +60,16 @@ This registers the server under the key `cua-computer-use` at user scope, so it
## Codex
-Register the stdio server:
+Print the Codex registration command:
```bash
-codex mcp add cua-driver -- cua-driver mcp
+cua-driver mcp-config --client codex
+```
+
+It emits a command with the absolute installed binary path, which avoids PATH issues in app-launched Codex sessions:
+
+```bash
+codex mcp add cua-driver -- /Users/you/.local/bin/cua-driver mcp
```
Verify:
@@ -72,6 +78,22 @@ Verify:
codex mcp list
```
+Restart Codex or open a fresh Codex session after adding the MCP server so the new tools appear.
+
+For the best experience, also install the Cua Driver skill:
+
+```bash
+cua-driver skills install
+cua-driver skills status
+```
+
+If the Codex agent skills directory is missing, create it and install again:
+
+```bash
+mkdir -p ~/.agents/skills
+cua-driver skills install
+```
+
## Cursor
Generate the Cursor snippet:
diff --git a/docs/content/docs/tutorials/drive-your-first-app.mdx b/docs/content/docs/tutorials/drive-your-first-app.mdx
index 4e07c1f5a2..40e6b3e847 100644
--- a/docs/content/docs/tutorials/drive-your-first-app.mdx
+++ b/docs/content/docs/tutorials/drive-your-first-app.mdx
@@ -103,11 +103,13 @@ Register Cua Driver with your agent harness once.
cua-driver mcp-config --client codex
```
- It prints a command you run to register the server:
+ It prints a command you run to register the server. The emitted command uses the absolute installed binary path:
```bash
- codex mcp add cua-driver -- cua-driver mcp
+ codex mcp add cua-driver -- /Users/you/.local/bin/cua-driver mcp
```
+
+ Restart Codex or open a fresh Codex session after registration so the new tools appear.
</Tab>
<Tab value="Hermes">
Print the Hermes snippet: