wehub-resource-sync
91e75e620b
CI: cua-driver distro-compat matrix / Resolve release version (push) Waiting to run
CI: cua-driver distro-compat matrix / debian:12 (glibc 2.36) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / fedora:41 (glibc 2.40) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / rockylinux:9 (glibc 2.34) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:22.04 (glibc 2.35) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:24.04 (glibc 2.39) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / Distro compat summary (push) Blocked by required conditions
CI: Nix Linux Rust source / Nix / compositor build (push) Waiting to run
CI: Nix Linux Rust source / Nix / driver package (push) Waiting to run
CI: Nix Linux Rust source / Nix / Rust unit tests (push) Waiting to run
CI: Rust Linux unit / Rust Linux unit and compile (push) Waiting to run
CI: Rust Windows unit / Rust Windows unit and compile (push) Waiting to run
CI: SPDX Headers / Check SPDX headers (warn-only) (push) Waiting to run
CD: Docs MCP Server / build (linux/amd64) (push) Waiting to run
CD: Docs MCP Server / build (linux/arm64) (push) Waiting to run
CD: Docs MCP Server / merge (push) Blocked by required conditions
109 lines
3.6 KiB
Markdown
109 lines
3.6 KiB
Markdown
# CUA CLI
|
|
|
|
Unified command-line interface for CUA (Computer-Use Agents).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install cua-cli
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Authentication
|
|
cua auth login # Authenticate via browser
|
|
cua auth login --api-key # Authenticate with API key
|
|
cua auth list # List authenticated workspaces
|
|
cua auth status # Show auth status and credits
|
|
cua auth logout # Remove active workspace credentials
|
|
cua auth logout --workspace <slug> # Remove specific workspace
|
|
cua auth logout --all # Remove all credentials
|
|
cua auth env # Export API key to .env file
|
|
|
|
# Workspace Management
|
|
cua ws set <slug> # Switch active workspace
|
|
cua ws set # Interactive workspace picker
|
|
|
|
# Sandbox Management
|
|
cua sb list # List all sandboxes
|
|
cua sb create --os linux --size medium --region north-america
|
|
cua sb get <name> # Get sandbox details
|
|
cua sb start <name> # Start a stopped sandbox
|
|
cua sb stop <name> # Stop a running sandbox
|
|
cua sb restart <name> # Restart a sandbox
|
|
cua sb suspend <name> # Suspend a sandbox
|
|
cua sb delete <name> # Delete a sandbox
|
|
cua sb vnc <name> # Open sandbox in browser
|
|
|
|
# Image Management
|
|
cua image list # List cloud images
|
|
cua image list --local # List local images
|
|
cua image push <name> # Upload image to cloud
|
|
cua image pull <name> # Download image from cloud
|
|
cua image delete <name> # Delete cloud image
|
|
|
|
# Skills Management
|
|
cua skills list # List recorded skills
|
|
cua skills read <name> # Read a skill's content
|
|
cua skills record <name> # Record a new skill
|
|
cua skills replay <name> # Replay a skill
|
|
cua skills delete <name> # Delete a skill
|
|
cua skills clean # Delete all skills
|
|
|
|
# MCP Server (for AI assistants)
|
|
cua serve-mcp # Start MCP server with all permissions
|
|
cua serve-mcp --permissions sandbox:all,computer:readonly
|
|
```
|
|
|
|
## Installation Options
|
|
|
|
```bash
|
|
# Basic installation
|
|
pip install cua-cli
|
|
|
|
# With MCP server support
|
|
pip install cua-cli[mcp]
|
|
|
|
# With skills recording (VLM captioning)
|
|
pip install cua-cli[skills]
|
|
|
|
# Full installation
|
|
pip install cua-cli[all]
|
|
```
|
|
|
|
## MCP Integration
|
|
|
|
To use CUA with Claude Code or other MCP-compatible AI assistants:
|
|
|
|
```bash
|
|
# Add CUA as an MCP server
|
|
claude mcp add cua -- cua serve-mcp
|
|
|
|
# With specific permissions
|
|
claude mcp add cua -- cua serve-mcp --permissions sandbox:all,computer:readonly
|
|
|
|
# With a default sandbox
|
|
claude mcp add cua -- cua serve-mcp --sandbox my-sandbox
|
|
```
|
|
|
|
### Available Permissions
|
|
|
|
- `all` - All permissions
|
|
- `sandbox:all` - Full sandbox management
|
|
- `sandbox:readonly` - List and get sandboxes only
|
|
- `computer:all` - Full computer control
|
|
- `computer:readonly` - Screenshots only
|
|
- `skills:all` - Full skills management
|
|
- `skills:readonly` - List and read skills only
|
|
|
|
Individual permissions: `sandbox:list`, `sandbox:create`, `sandbox:delete`, `sandbox:start`, `sandbox:stop`, `sandbox:restart`, `sandbox:suspend`, `sandbox:get`, `sandbox:vnc`, `computer:screenshot`, `computer:click`, `computer:type`, `computer:key`, `computer:scroll`, `computer:drag`, `computer:hotkey`, `computer:clipboard`, `computer:file`, `computer:shell`, `computer:window`, `skills:list`, `skills:read`, `skills:record`, `skills:delete`
|
|
|
|
## Environment Variables
|
|
|
|
- `CUA_API_KEY`: API key for authentication
|
|
- `CUA_API_BASE`: API base URL (default: `https://api.cua.ai`)
|
|
- `CUA_WEBSITE_URL`: Website URL for OAuth (default: https://cua.ai)
|
|
- `CUA_MCP_PERMISSIONS`: Default MCP permissions (comma-separated)
|
|
- `CUA_SANDBOX`: Default sandbox name for computer commands
|