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.

Updated readme with dev container

Dillon DuPont594e741ae964
diff --git a/README.md b/README.md
index 1465276959..763e14b4ac 100644
--- a/README.md
+++ b/README.md
@@ -54,48 +54,42 @@
### Option 1: Fully-managed install (recommended)
-*I want to be totally guided in the process*
+*Guided install for quick use*
**macOS/Linux/Windows (via WSL):**
```bash
# Requires Python 3.11+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/scripts/playground.sh)"
```
+This script will guide you through setup and launch the Computer-Use Agent UI.
-This script will:
-- Ask if you want to use local VMs or C/ua Cloud Containers
-- Install necessary dependencies (Lume CLI for local VMs)
-- Download VM images if needed
-- Install Python packages
-- Launch the Computer-Use Agent UI
+---
-### Option 2: Key manual steps
-<details>
-<summary>If you are skeptical running one-install scripts</summary>
+### Option 2: [Dev Container](./.devcontainer/README.md)
+*Best for contributors and development*
-**For C/ua Agent UI (any system, cloud VMs only):**
-```bash
-# Requires Python 3.11+ and C/ua API key
-pip install -U "cua-computer[all]" "cua-agent[all]"
-python -m agent.ui.gradio.app
-```
+This repository includes a [Dev Container](./.devcontainer/README.md) configuration that simplifies setup to a few steps:
-**For Local macOS/Linux VMs (Apple Silicon only):**
-```bash
-# 1. Install Lume CLI
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"
+1. **Install Dev Containers extension** in VS Code
+2. **Clone and open in container:**
+ - Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac)
+ - Type `Dev Containers: Clone Repository in Container Volume...`
+ - Paste the repository URL: `https://github.com/trycua/cua.git`
+ - Open the `.vscode/py.code-workspace` workspace
+3. **Run the Agent UI example:** Once the container builds, you're ready to run the Agent UI example!
-# 2. Pull macOS image
-lume pull macos-sequoia-cua:latest
-# 3. Start VM
-lume run macos-sequoia-cua:latest
+The Gradio UI will be available at `http://localhost:7860` and will automatically forward to your host machine.
-# 4. Install packages and launch UI
-pip install -U "cua-computer[all]" "cua-agent[all]"
-python -m agent.ui.gradio.app
+**Environment Variables:**
+You'll need to add your API keys to `.env.local`:
+```bash
+# Required for Anthropic provider
+ANTHROPIC_API_KEY=your_anthropic_key_here
+
+# Required for OpenAI provider
+OPENAI_API_KEY=your_openai_key_here
```
-</details>
---