mirror of
https://github.com/trycua/computer.git
synced 2026-01-06 05:20:02 -06:00
67 lines
4.5 KiB
Plaintext
67 lines
4.5 KiB
Plaintext
---
|
|
title: Home
|
|
icon: House
|
|
---
|
|
|
|
## What is C/ua?
|
|
|
|
C/ua is a collection of cross-platform libraries and tools for building Computer-Use AI agents.
|
|
|
|
## Quick Start
|
|
|
|
<Cards>
|
|
<Card
|
|
href="./home/guides/computer-use-agent-quickstart"
|
|
title="Computer-Use Agent UI">
|
|
Read our guide on getting started with a Computer-Use Agent.
|
|
</Card>
|
|
|
|
<Card href="./home/guides/cua-usage-guide" title="C/ua Usage Guide">
|
|
Get started using C/ua services on your machine.
|
|
</Card>
|
|
|
|
<Card href="./home/guides/dev-container-setup" title="Dev Container Setup">
|
|
Set up a development environment with the Dev Container.
|
|
</Card>
|
|
|
|
</Cards>
|
|
|
|
## Resources
|
|
|
|
- [How to use the MCP Server with Claude Desktop or other MCP clients](./libraries/mcp-server) - One of the easiest ways to get started with C/ua
|
|
- [How to use OpenAI Computer-Use, Anthropic, OmniParser, or UI-TARS for your Computer-Use Agent](./libraries/agent)
|
|
- [How to use Lume CLI for managing desktops](./libraries/lume)
|
|
- [Training Computer-Use Models: Collecting Human Trajectories with C/ua (Part 1)](https://www.trycua.com/blog/training-computer-use-models-trajectories-1)
|
|
- [Build Your Own Operator on macOS (Part 1)](https://www.trycua.com/blog/build-your-own-operator-on-macos-1)
|
|
|
|
## Modules
|
|
|
|
| Module | Description | Installation |
|
|
| ------------------------------------------------------ | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
| [**Lume**](./libraries/lume.mdx) | VM management for macOS/Linux using Apple's Virtualization.Framework | `curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh \| bash` |
|
|
| [**Lumier**](./libraries/lumier.mdx) | Docker interface for macOS and Linux VMs | `docker pull trycua/lumier:latest` |
|
|
| [**Computer**](./libraries/computer.mdx) | Python Interface for controlling virtual machines | `pip install "cua-computer[all]"`<br/><br/>`npm install @trycua/computer` |
|
|
| [**Agent**](./libraries/agent.mdx) | AI agent framework for automating tasks | `pip install "cua-agent[all]"` |
|
|
| [**MCP Server**](./libraries/mcp-server.mdx) | MCP server for using CUA with Claude Desktop | `pip install cua-mcp-server` |
|
|
| [**SOM**](./libs/python/som/README.md) | Self-of-Mark library for Agent | `pip install cua-som` |
|
|
| [**Computer Server**](./libraries/computer-server.mdx) | Server component for Computer | `pip install cua-computer-server` |
|
|
| [**Core**](./libraries/core.mdx) | Python Core utilities | `pip install cua-core`<br/><br/>`npm install @trycua/core` |
|
|
|
|
## Community
|
|
|
|
Join our [Discord community](https://discord.com/invite/mVnXXpdE85) to discuss ideas, get assistance, or share your demos!
|
|
|
|
## License
|
|
|
|
Cua is open-sourced under the MIT License - see the [LICENSE](https://github.com/trycua/cua/blob/main/LICENSE.md) file 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](https://github.com/microsoft/OmniParser/blob/master/LICENSE) file for details.
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions to CUA! Please refer to our [Contributing Guidelines](https://github.com/trycua/cua/blob/main/CONTRIBUTING.md) for details.
|
|
|
|
## Trademarks
|
|
|
|
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., or Microsoft Corporation.
|