Cua ("koo-ah") is Docker for Computer-Use Agents - it enables AI agents to control full operating systems in virtual containers and deploy them locally or to the cloud.

With the Computer SDK, you can:

• automate Windows, Linux, and macOS VMs with a consistent, pyautogui-like API
• create & manage VMs locally or using Cua cloud

With the Agent SDK, you can:

• run computer-use models with a consistent schema
• benchmark on OSWorld-Verified, SheetBench-V2, and more with a single line of code using HUD (Notebook)
• combine UI grounding models with any LLM using composed agents
• use new UI agent models and UI grounding models from the Model Zoo below with just a model string (e.g., ComputerAgent(model="openai/computer-use-preview"))
• use API or local inference by changing a prefix (e.g., openai/, openrouter/, ollama/, huggingface-local/, mlx/, etc.)

• Clone a starter template and run the code in <1 min (⭐️ Recommended!)
• Get started with the Computer-Use Agent CLI
• Get started with the Python SDKs

pip install cua-agent[all]

from agent import ComputerAgent
agent = ComputerAgent(
 model="anthropic/claude-3-5-sonnet-20241022",
 tools=[computer],
 max_trajectory_budget=5.0
)
messages = [{"role": "user", "content": "Take a screenshot and tell me what you see"}]
async for result in agent.run(messages):
 for item in result["output"]:
 if item["type"] == "message":
 print(item["content"][0]["text"])

Cua uses the OpenAI Agent response format.

{
 "output": [
 {
 "role": "user",
 "content": "go to trycua on gh"
 },
 {
 "summary": [
 {
 "text": "Searching Firefox for Trycua GitHub",
 "type": "summary_text"
 }
 ],
 "type": "reasoning"
 },
 {
 "action": {
 "text": "Trycua GitHub",
 "type": "type"
 },
 "call_id": "call_QI6OsYkXxl6Ww1KvyJc4LKKq",
 "status": "completed",
 "type": "computer_call"
 },
 {
 "type": "computer_call_output",
 "call_id": "call_QI6OsYkXxl6Ww1KvyJc4LKKq",
 "output": {
 "type": "input_image",
 "image_url": "data:image/png;base64,..."
 }
 },
 {
 "type": "message",
 "role": "assistant",
 "content": [
 {
 "text": "Success! The Trycua GitHub page has been opened.",
 "type": "output_text"
 }
 ]
 }
 ],
 "usage": {
 "prompt_tokens": 150,
 "completion_tokens": 75,
 "total_tokens": 225,
 "response_cost": 0.01
 }
}

These are the valid model configurations for ComputerAgent(model="..."):

The following table shows which capabilities are supported by each model:

Missing a model? Create a feature request or contribute!

pip install cua-computer[all]

from computer import Computer
async with Computer(
 os_type="linux",
 provider_type="cloud",
 name="your-sandbox-name",
 api_key="your-api-key"
) as computer:
 # Take screenshot
 screenshot = await computer.interface.screenshot()
 # Click and type
 await computer.interface.left_click(100, 100)
 await computer.interface.type("Hello!")

• Cua Blog
• Cua Docs

We welcome contributions to Cua! Please refer to our Contributing Guidelines for details.

Join our Discord community to discuss ideas, get assistance, or share your demos!

Cua is open-sourced under the MIT License - see the LICENSE file for details.

Portions of this project, specifically components adapted from Kasm Technologies Inc., are also licensed under the MIT License. See libs/kasm/LICENSE for details.

Microsoft's OmniParser, which is used in this project, is licensed under the Creative Commons Attribution 4.0 International License (CC-BY-4.0). See the OmniParser LICENSE for details.

Some optional extras for this project depend on third-party packages that are licensed under terms different from the MIT License.

• The optional "omni" extra (installed via pip install "cua-agent[omni]") installs the cua-som module, which includes ultralytics and is licensed under the AGPL-3.0.

When you choose to install and use such optional extras, your use, modification, and distribution of those third-party components are governed by their respective licenses (e.g., AGPL-3.0 for ultralytics).

Apple, macOS, and Apple Silicon are trademarks of Apple Inc.
Ubuntu and Canonical are registered trademarks of Canonical Ltd.
Microsoft is a registered trademark of Microsoft Corporation.

This project is not affiliated with, endorsed by, or sponsored by Apple Inc., Canonical Ltd., Microsoft Corporation, or Kasm Technologies.

Thank you to all our supporters!

Stargazers over time

Thank you to all our GitHub Sponsors!