CLI Reference
Command Line Interface reference for Cua Driver
Cross-platform computer-use automation driver.
Tool dispatch
cua-driver list-tools
List every registered MCP tool with a one-line description.
cua-driver describe
Print a tool's full description and JSON input schema.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<tool-name> | String | Yes | Name of the MCP tool to describe. |
cua-driver call
Invoke an MCP tool directly from the shell.
Runs the same handler the MCP server uses. JSON arguments may be passed as a positional JSON object or through stdin.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<tool-name> | String | Yes | Name of the MCP tool to invoke. |
<json-args> | String | No | JSON object for the tool input schema. If omitted, stdin is read when piped. |
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--screenshot-out-file | String | — | Write the first image content block from the response to this path. |
--socket | String | — | Override the daemon socket or named-pipe path. |
Daemon management
cua-driver mcp
Run the stdio MCP server.
On macOS, shell-spawned MCP processes can auto-launch and proxy through a CuaDriver.app daemon so TCC grants attach to the bundle. On Windows and Linux, MCP proxies through an already-running daemon when one is listening.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path used by the proxy fallback. |
Flags:
| Name | Description |
|---|---|
--no-daemon-relaunch | Stay in-process instead of proxying through a daemon. |
--claude-code-computer-use-compat | Expose the Claude Code computer-use compatibility screenshot surface. |
cua-driver serve
Run Cua Driver as a long-running daemon.
The daemon owns per-process state such as element-index caches, recording state, and cursor overlay state.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path. |
--pid-file | String | — | Override the pid-file path on Unix targets. |
Flags:
| Name | Description |
|---|---|
--no-permissions-gate | Skip the macOS first-launch permissions gate. |
cua-driver stop
Ask the running daemon to exit gracefully.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path. |
cua-driver status
Report whether a Cua Driver daemon is running.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path. |
--pid-file | String | — | Override the pid-file path on Unix targets. |
cua-driver mcp-config
Print MCP server config or a client-specific install command.
Supported clients include claude, codex, cursor, antigravity, openclaw, opencode, hermes, and pi.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--client | String | — | Client name to print configuration for. |
Trajectory recording
cua-driver recording
Control trajectory recording on a running daemon.
Recording state lives in-process, so use a daemon for multi-call sessions.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path. |
cua-driver recording start
Start trajectory recording to a directory.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<output-dir> | String | Yes | Directory to write turn folders into. |
cua-driver recording stop
Stop trajectory recording.
cua-driver recording status
Print the current recording state.
cua-driver recording render
Render a recorded trajectory directory to an MP4.
This pure file-to-file path does not require a running daemon.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<input-dir> | String | Yes | Trajectory directory containing recorded turn folders. |
<out-mp4> | String | Yes | Output MP4 path. |
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--scale | Number | — | Scale factor for rendered frames. |
Flags:
| Name | Description |
|---|---|
--no-zoom | Disable cursor/action zoom effects in the rendered video. |
Configuration
cua-driver config
Read or mutate persistent driver configuration.
Without a subcommand, prints the full config.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--socket | String | — | Override the daemon socket or named-pipe path. |
cua-driver config show
Print the full config.
cua-driver config get
Print one config key.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<key> | String | Yes | Config key to read. |
cua-driver config set
Set one config key.
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
<key> | String | Yes | Config key to write. |
<value> | String | Yes | Value to store. |
cua-driver config reset
Reset config to defaults.
Diagnostics
cua-driver check-update
Check whether a newer cua-driver release is available.
Read-only. Uses the same update-state payload as the check_for_update MCP tool.
Flags:
| Name | Description |
|---|---|
--json | Emit a machine-readable JSON payload. |
--no-cache | Skip the 20-hour on-disk cache and force a GitHub request. |
cua-driver update
Check for an update and optionally apply it.
The apply path delegates to the canonical platform installer scripts.
Flags:
| Name | Description |
|---|---|
--apply | Download and install the latest release when one is available. |
--json | Emit the structured update-state payload. |
cua-driver doctor
Run platform-aware diagnostic probes.
Exit code is non-zero when any probe is an error.
Flags:
| Name | Description |
|---|---|
--json | Emit the probe report as JSON. |
cua-driver diagnose
Print a pasteable install-layout and permission-attribution report.
Other commands
cua-driver autostart
Manage platform-native daemon autostart.
Windows registers a logon Scheduled Task. macOS and Linux currently print manual-recipe guidance.
cua-driver autostart enable
Register the autostart entry.
cua-driver autostart disable
Remove the autostart entry.
cua-driver autostart status
Print whether autostart is registered and running.
cua-driver autostart kick
Start the autostart entry now without re-logging.
cua-driver skills
Install, update, inspect, or remove the optional agent skill pack.
The install script never touches agent skill directories automatically.
cua-driver skills install
Fetch the versioned skill pack and link detected agents.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--agent | String | — | Restrict linking to one agent. |
--from | String | — | Fetch from a source such as main instead of the tagged release. |
Flags:
| Name | Description |
|---|---|
--all-platforms | Keep platform-specific skill files for every platform. |
cua-driver skills update
Refresh the local skill pack and links.
cua-driver skills uninstall
Remove agent skill links.
Flags:
| Name | Description |
|---|---|
--all | Also delete the local skill-pack copy. |
cua-driver skills status
Report local skill-pack and per-agent link state.
cua-driver skills path
Print the local skill-pack path.
cua-driver dump-docs
Output machine-readable CLI and MCP documentation JSON.
Used by the docs generator to keep reference pages in sync with the live binary.
Options:
| Name | Type | Default | Description |
|---|---|---|---|
--type | String | all | Which docs to emit: all, cli, or mcp. |
Flags:
| Name | Description |
|---|---|
-p, --pretty | Pretty-print JSON. |
Global options
Available on all commands:
--help— Show help information.--version— Show version number.
Was this page helpful?