diff --git a/README.md b/README.md index 6a0c615d..100c6541 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,58 @@ [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white)](https://discord.com/invite/mVnXXpdE85) -# Cua +Cua (pronounced "koo-ah", short for Computer-Use Agent) is an open-source framework that combines high-performance virtualization with AI agent capabilities to enable secure, isolated environments for AI systems to interact with desktop applications. -Create and run high-performance macOS and Linux VMs on Apple Silicon, with built-in support for AI agents. +## What is Cua? -## Libraries +Cua offers two primary capabilities in a single integrated framework: + +1. **High-Performance Virtualization** - Create and run macOS/Linux virtual machines on Apple Silicon with near-native performance (up to 90% of native speed) using `Apple's Virtualization.Framework`. + +2. **Computer-Use Interface & Agent** - A framework that allows AI systems to observe and control these virtual environments - interacting with applications, browsing the web, writing code, and performing complex workflows. + +## Why Use Cua? + +- **Security & Isolation**: Run AI agents in fully isolated virtual environments instead of giving them access to your main system +- **Performance**: [Near-native performance](https://browser.geekbench.com/v6/cpu/compare/11283746?baseline=11102709) on Apple Silicon +- **Flexibility**: Run macOS or Linux environments with the same framework +- **Reproducibility**: Create consistent, deterministic environments for AI agent workflows +- **LLM Integration**: Built-in support for connecting to various LLM providers + +## System Requirements + +- Mac with Apple Silicon (M1/M2/M3/M4 series) +- macOS 14 (Sonoma) or newer +- Python 3.10+ (for Computer and Agent libraries) +- Disk space for VM images (40GB+ recommended) + +## Quick Start + +### Option 1: Lume CLI Only (VM Management) +If you only need the virtualization capabilities: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" +``` + +For Lume usage instructions, refer to the [Lume documentation](./libs/lume/README.md). + +### Option 2: Full Computer-Use Agent Capabilities +If you want to use AI agents with virtualized environments: + +1. Install the Lume CLI: + ```bash + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" + ``` + +2. Install the Python libraries: + ```bash + pip install cua-computer cua-agent + ``` + +Check out our [Getting Started Guide](./docs/Getting-Started.md) or explore the [Notebooks](./notebooks/) for interactive examples. + +## Monorepo Libraries | Library | Description | Installation | Version | |---------|-------------|--------------|---------| @@ -25,14 +72,6 @@ Create and run high-performance macOS and Linux VMs on Apple Silicon, with built | [**Computer**](./libs/computer/README.md) | Computer-Use Interface (CUI) framework for interacting with macOS/Linux sandboxes | `pip install cua-computer` | [![PyPI](https://img.shields.io/pypi/v/cua-computer?color=333333)](https://pypi.org/project/cua-computer/) | | [**Agent**](./libs/agent/README.md) | Computer-Use Agent (CUA) framework for running agentic workflows in macOS/Linux dedicated sandboxes | `pip install cua-agent` | [![PyPI](https://img.shields.io/pypi/v/cua-agent?color=333333)](https://pypi.org/project/cua-agent/) | -## Lume - -**Originally looking for Lume?** If you're here for the original Lume project, it's now part of this monorepo. Simply install with our one-line installer script and refer to its [documentation](./libs/lume/README.md): - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" -``` - ## Docs For the best onboarding experience with the packages in this monorepo, we recommend starting with the [Computer](./libs/computer/README.md) documentation to cover the core functionality of the Computer sandbox, then exploring the [Agent](./libs/agent/README.md) documentation to understand Cua's AI agent capabilities, and finally working through the Notebook examples. diff --git a/docs/Developer-Guide.md b/docs/Getting-Started.md similarity index 99% rename from docs/Developer-Guide.md rename to docs/Getting-Started.md index 96c19a98..cd93ac3c 100644 --- a/docs/Developer-Guide.md +++ b/docs/Getting-Started.md @@ -1,4 +1,4 @@ -## Developer Guide +## Getting Started ### Project Structure