Lume

CLI and framework for macOS VMs using Apple Virtualization Framework

Lume is a lightweight CLI and local API server for creating, running, and managing macOS and Linux virtual machines with near-native performance on Apple Silicon.

Built on Apple's Virtualization.Framework, Lume was the first open-source product released by trycua - providing the foundation for the Computer Use Agent SDK.

Key Features

  • Near-native performance - Run macOS VMs at native speed using Apple's Virtualization Framework
  • Simple CLI - Create, run, and manage VMs with intuitive commands
  • Unattended setup - Automate macOS installation and configuration with YAML files
  • HTTP API - Integrate with your tools via the built-in REST API server

Quick Start

# Install Lume
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"

# Create a custom macOS VM
lume create my-vm --os macos --ipsw latest

# Run the VM
lume run my-vm

System Requirements

  • Apple Silicon Mac (M1, M2, M3, M4, etc.) - macOS 13.0 or later - At least 8GB of RAM (16GB recommended) - At least 30GB of free disk space

Next Steps

Was this page helpful?

On this page