Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.
Rust agentai-agentapplecomputer-usecomputer-use-agentcontainerizationcuadesktop-automationhacktoberfestlumemacosmanusoperatorswiftvirtualizationvirtualization-frameworkwindowswindows-sandbox
Add developer guide, renamve from /cua to /guides
Morgan Deanbbb1a2ccdcfa
diff --git a/docs/content/docs/home/cua/computer-use-agent-quickstart.mdx b/docs/content/docs/home/guides/computer-use-agent-quickstart.mdxsimilarity index 97%rename from docs/content/docs/home/cua/computer-use-agent-quickstart.mdxrename to docs/content/docs/home/guides/computer-use-agent-quickstart.mdxindex 634fca748e..015434b384 100644--- a/docs/content/docs/home/cua/computer-use-agent-quickstart.mdx+++ b/docs/content/docs/home/guides/computer-use-agent-quickstart.mdx@@ -1,5 +1,5 @@----title: Comuter-Use Agent Quickstart+title: Computer-Use Agent Quickstartdescription: Launch a computer-use agent UI interface with Docker, Dev Container, or Python.---diff --git a/docs/content/docs/home/cua/cua-usage-guide.mdx b/docs/content/docs/home/guides/cua-usage-guide.mdxsimilarity index 100%rename from docs/content/docs/home/cua/cua-usage-guide.mdxrename to docs/content/docs/home/guides/cua-usage-guide.mdxdiff --git a/docs/content/docs/home/cua/dev-container-setup.mdx b/docs/content/docs/home/guides/dev-container-setup.mdxsimilarity index 100%rename from docs/content/docs/home/cua/dev-container-setup.mdxrename to docs/content/docs/home/guides/dev-container-setup.mdxdiff --git a/docs/Developer-Guide.md b/docs/content/docs/home/guides/developer-guide.mdxsimilarity index 87%rename from docs/Developer-Guide.mdrename to docs/content/docs/home/guides/developer-guide.mdxindex 49aa82ee1c..e280b49df4 100644--- a/docs/Developer-Guide.md+++ b/docs/content/docs/home/guides/developer-guide.mdx@@ -1,10 +1,18 @@-# Getting Started+---+title: Developer Guide+description: The guide for developing within the cua repository.+---++import { GithubInfo } from 'fumadocs-ui/components/github-info';++<GithubInfo owner="trycua" repo="cua" token={process.env.GITHUB_TOKEN} />## Project StructureThe project is organized as a monorepo with these main packages:### Python+- `libs/python/core/` - Base package with telemetry support- `libs/python/computer/` - Computer-use interface (CUI) library- `libs/python/agent/` - AI agent library with multi-provider support@@ -13,10 +21,12 @@ The project is organized as a monorepo with these main packages:- `libs/python/pylume/` - Python bindings for Lume### TypeScript+- `libs/typescript/computer/` - Computer-use interface (CUI) library- `libs/typescript/agent/` - AI agent library with multi-provider support### Other+- `libs/lume/` - Lume CLIEach package has its own virtual environment and dependencies, managed through PDM.@@ -25,36 +35,36 @@ Each package has its own virtual environment and dependencies, managed through P1. Install Lume CLI:- ```bash- /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"- ```+ ```bash+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"+ ```2. Clone the repository:- ```bash- git clone https://github.com/trycua/cua.git- cd cua- ```+ ```bash+ git clone https://github.com/trycua/cua.git+ cd cua+ ```3. Create a `.env.local` file in the root directory with your API keys:- ```bash- # Required for Anthropic provider- ANTHROPIC_API_KEY=your_anthropic_key_here+ ```bash+ # Required for Anthropic provider+ ANTHROPIC_API_KEY=your_anthropic_key_here- # Required for OpenAI provider- OPENAI_API_KEY=your_openai_key_here- ```+ # Required for OpenAI provider+ OPENAI_API_KEY=your_openai_key_here+ ```4. Open the workspace in VSCode or Cursor:- ```bash- # For Cua Python development- code .vscode/py.code-workspace+ ```bash+ # For Cua Python development+ code .vscode/py.code-workspace- # For Lume (Swift) development- code .vscode/lume.code-workspace- ```+ # For Lume (Swift) development+ code .vscode/lume.code-workspace+ ```Using the workspace file is strongly recommended as it:@@ -135,27 +145,27 @@ As an alternative to installing directly on your host machine, you can use Docke1. Build the development Docker image:- ```bash- ./scripts/run-docker-dev.sh build- ```+ ```bash+ ./scripts/run-docker-dev.sh build+ ```2. Run an example in the container:- ```bash- ./scripts/run-docker-dev.sh run computer_examples.py- ```+ ```bash+ ./scripts/run-docker-dev.sh run computer_examples.py+ ```3. Get an interactive shell in the container:- ```bash- ./scripts/run-docker-dev.sh run --interactive- ```+ ```bash+ ./scripts/run-docker-dev.sh run --interactive+ ```4. Stop any running containers:- ```bash- ./scripts/run-docker-dev.sh stop- ```+ ```bash+ ./scripts/run-docker-dev.sh stop+ ```### How it Worksdiff --git a/docs/content/docs/home/cua/meta.json b/docs/content/docs/home/guides/meta.jsonsimilarity index 100%rename from docs/content/docs/home/cua/meta.jsonrename to docs/content/docs/home/guides/meta.jsondiff --git a/docs/content/docs/home/meta.json b/docs/content/docs/home/meta.jsonindex 2c71daa7b2..1ec6bb7c7c 100644--- a/docs/content/docs/home/meta.json+++ b/docs/content/docs/home/meta.json@@ -9,7 +9,7 @@"faq","telemetry","---[BookCopy]Guides---",- "...cua",+ "...guides","---[Library]Libraries---","...libraries"]