diff --git a/docs/content/docs/home/libraries/core/index.mdx b/docs/content/docs/home/libraries/core/index.mdx index 6e8a96f7..a3c6dbcc 100644 --- a/docs/content/docs/home/libraries/core/index.mdx +++ b/docs/content/docs/home/libraries/core/index.mdx @@ -6,14 +6,6 @@ github: - https://github.com/trycua/cua/tree/main/libs/typescript/core --- -## ⚠️ 🚧 Under Construction 🚧 ⚠️ - -The Core API reference documentation is currently under development. - ## Overview The Core library provides foundational utilities and shared functionality across the CUA ecosystem. - -## API Documentation - -Coming soon. diff --git a/docs/content/docs/home/libraries/lume/index.mdx b/docs/content/docs/home/libraries/lume/index.mdx index fc5f6adb..28080bff 100644 --- a/docs/content/docs/home/libraries/lume/index.mdx +++ b/docs/content/docs/home/libraries/lume/index.mdx @@ -5,14 +5,6 @@ github: - https://github.com/trycua/cua/tree/main/libs/lume --- -## ⚠️ 🚧 Under Construction 🚧 ⚠️ - -The Lume API reference documentation is currently under development. - ## Overview The Lume CLI provides command line tools for managing virtual machines with Lume. - -## API Documentation - -Coming soon. diff --git a/docs/content/docs/home/libraries/lumier/index.mdx b/docs/content/docs/home/libraries/lumier/index.mdx index 98b63eed..3858504d 100644 --- a/docs/content/docs/home/libraries/lumier/index.mdx +++ b/docs/content/docs/home/libraries/lumier/index.mdx @@ -1,18 +1,69 @@ --- title: Lumier -description: Reference for the current version of the Lumeir library. +description: Reference for the current version of the Lumier library. github: - https://github.com/trycua/cua/tree/main/libs/lumier --- -## ⚠️ 🚧 Under Construction 🚧 ⚠️ - -The Lumier API reference documentation is currently under development. - ## Overview -The Lumier library provides Docker-based virtual machine management capabilities. +The Lumier library provides a Docker-based interface for creating performant macOS virtual machines. -## API Documentation +## Installation -Coming soon. +**Requirements:** +- Docker for Apple Silicon (or compatible Mac) +- Lume virtualization CLI (install with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"`) + +## Usage + +### Run a macOS VM (ephemeral) +```bash +docker run -it --rm \ + --name macos-vm \ + -p 8006:8006 \ + -e VM_NAME=macos-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + trycua/lumier:latest +``` +Access the VM in your browser at [http://localhost:8006](http://localhost:8006). + +### Persistent Storage +```bash +mkdir -p storage + +docker run -it --rm \ + --name lumier-vm \ + -p 8006:8006 \ + -v $(pwd)/storage:/storage \ + -e VM_NAME=lumier-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + -e HOST_STORAGE_PATH=$(pwd)/storage \ + trycua/lumier:latest +``` + +### Shared Folder +```bash +mkdir -p shared + +docker run -it --rm \ + --name lumier-vm \ + -p 8006:8006 \ + -v $(pwd)/storage:/storage \ + -v $(pwd)/shared:/shared \ + -e VM_NAME=lumier-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + -e HOST_STORAGE_PATH=$(pwd)/storage \ + -e HOST_SHARED_PATH=$(pwd)/shared \ + trycua/lumier:latest +``` + +--- + +See the [Lumier README](https://github.com/trycua/cua/tree/main/libs/lumier) for advanced options, Docker Compose setup, and automation scripts. \ No newline at end of file diff --git a/docs/content/docs/home/libraries/mc-server/index.mdx b/docs/content/docs/home/libraries/mcp-server/index.mdx similarity index 100% rename from docs/content/docs/home/libraries/mc-server/index.mdx rename to docs/content/docs/home/libraries/mcp-server/index.mdx diff --git a/docs/content/docs/home/libraries/som/index.mdx b/docs/content/docs/home/libraries/som/index.mdx index 1222c0b8..4a0d3b5b 100644 --- a/docs/content/docs/home/libraries/som/index.mdx +++ b/docs/content/docs/home/libraries/som/index.mdx @@ -5,13 +5,9 @@ github: - https://github.com/trycua/cua/tree/main/libs/python/som --- -## ⚠️ 🚧 Under Construction 🚧 ⚠️ - -The SOM (Set-of-Mark) API reference documentation is currently under development. - ## Overview -The SOM library provides visual element detection and interaction capabilities. +The SOM library provides visual element detection and interaction capabilities. It is based on the [Set-of-Mark](https://arxiv.org/abs/2310.11441) research paper and the [OmniParser](https://github.com/microsoft/OmniParser) model. ## API Documentation @@ -49,4 +45,12 @@ class ParseResult: """Filter elements by type ('icon' or 'text')""" ``` -More Coming soon. +### UIElement +```python +class UIElement(BaseModel): + id: Optional[int] = Field(None) # Element ID (1-indexed) + type: Literal["icon", "text"] # Element type + bbox: BoundingBox # Bounding box coordinates { x1, y1, x2, y2 } + interactivity: bool = Field(default=False) # Whether the element is interactive + confidence: float = Field(default=1.0) # Detection confidence +``` \ No newline at end of file