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.

docs(cua-driver): document mcp-config --client flag, doctor command, update --apply

Francesco Bonaccia92ef807fdce
diff --git a/docs/content/docs/cua-driver/guide/getting-started/installation.mdx b/docs/content/docs/cua-driver/guide/getting-started/installation.mdx
index 2989df6bde..042caedbe9 100644
--- a/docs/content/docs/cua-driver/guide/getting-started/installation.mdx
+++ b/docs/content/docs/cua-driver/guide/getting-started/installation.mdx
@@ -97,28 +97,41 @@ cua-driver stop
`open -n -g -a CuaDriver --args serve` is the recommended form because LaunchServices attributes the process to `CuaDriver.app`'s bundle id, which is what the user actually granted TCC against. `cua-driver serve &` also works and auto-relaunches itself via `open` when it detects the wrong TCC context.
-## Register with an MCP client
+## Register with an MCP client (optional)
-Cua Driver speaks MCP over stdio. Generate a client config snippet:
+The MCP server is one of two ways to use cua-driver — skip this section if you only want the CLI (`cua-driver list_apps`, etc.). You can register both later, MCP and CLI work side-by-side.
+
+Cua Driver speaks MCP over stdio. Pick the command for your client:
+
+### Claude Code
+
+```bash
+claude mcp add --transport stdio cua-driver -- /usr/local/bin/cua-driver mcp
+```
+
+Add `--scope project` to register only for the current repo, or `--scope global` for every project.
+
+### Codex (OpenAI)
```bash
-cua-driver mcp-config
+codex mcp add cua-driver -- /usr/local/bin/cua-driver mcp
```
-Output:
-
-```json
-{
- "mcpServers": {
- "cua-driver": {
- "command": "/Applications/CuaDriver.app/Contents/MacOS/cua-driver",
- "args": ["mcp"]
- }
- }
-}
+### Cursor / other clients
+
+Cursor has no CLI for MCP — paste the JSON into `~/.cursor/mcp.json` (or your client's equivalent):
+
+```bash
+cua-driver mcp-config --client cursor | pbcopy
+```
+
+For any other client that accepts the standard `mcpServers` shape:
+
+```bash
+cua-driver mcp-config | pbcopy
```
-Paste into `~/.claude/mcp.json` (Claude Code) or the equivalent config for your client. The client spawns `cua-driver mcp` on demand.
+The client spawns `cua-driver mcp` on demand once registered.
## Uninstall
diff --git a/docs/content/docs/cua-driver/reference/cli-reference.mdx b/docs/content/docs/cua-driver/reference/cli-reference.mdx
index 13809f61b4..c4efa92ca2 100644
--- a/docs/content/docs/cua-driver/reference/cli-reference.mdx
+++ b/docs/content/docs/cua-driver/reference/cli-reference.mdx
@@ -144,7 +144,13 @@ No flags. Use `cua-driver mcp-config` to generate a paste-able client config sni
### cua-driver mcp-config
-Print an MCP client config snippet pointing at this binary.
+Print MCP server config or a client-specific install command.
+
+**Flags:**
+
+- `--client <name>` (optional): one of `claude`, `codex`, `cursor`. Omit for the generic JSON snippet that any MCP client accepts.
+
+**Generic JSON (default):**
```bash
cua-driver mcp-config
@@ -158,7 +164,20 @@ cua-driver mcp-config
# }
```
-Paste into `~/.claude/mcp.json` (Claude Code) or the equivalent for your MCP client.
+**Client-specific install commands:**
+
+```bash
+cua-driver mcp-config --client claude
+# claude mcp add --transport stdio cua-driver -- /Applications/CuaDriver.app/Contents/MacOS/cua-driver mcp
+
+cua-driver mcp-config --client codex
+# codex mcp add cua-driver -- /Applications/CuaDriver.app/Contents/MacOS/cua-driver mcp
+
+cua-driver mcp-config --client cursor
+# JSON snippet to paste into ~/.cursor/mcp.json (Cursor has no CLI)
+```
+
+Pipe to `pbcopy` to put on the clipboard, or use the printed `claude` / `codex` commands directly.
## Trajectory recording
@@ -291,14 +310,24 @@ Use this when filing an issue about permissions or install problems.
### cua-driver update
-Trigger a manual update check and optionally apply updates. Refuses to run when auto-update is disabled.
+Check GitHub for a newer cua-driver release and optionally apply it.
+
+```bash
+cua-driver update # report what's available
+cua-driver update --apply # download and install the latest release
+```
+
+**Flags:** `--apply` — download and apply the update without prompting. Without this flag, `update` only reports the available version and the install command.
+
+### cua-driver doctor
+
+Clean up stale install bits left from older cua-driver versions (`≤ v0.0.5`) — the legacy weekly LaunchAgent and the `/usr/local/bin/cua-driver-update` companion script that v0.0.6 dropped.
```bash
-cua-driver update
-cua-driver update --silent
+cua-driver doctor
```
-**Flags:** `--silent` — apply updates silently without prompting.
+Idempotent and safe to re-run. Prints `Nothing to clean — install is up to date.` when there's nothing to do. The `~/Library/LaunchAgents/...` plist is removed automatically; the `/usr/local/bin/cua-driver-update` script (root-owned) is surfaced as a `sudo rm -f` command for the user to run manually.
## Global options