LogoCua Documentation

Lumier

Reference for the current version of the Lumier library.

Overview

The Lumier library provides a Docker-based interface for creating performant macOS virtual machines.

Installation

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)

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.

Persistent Storage

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

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 for advanced options, Docker Compose setup, and automation scripts.

HTTP Server API

Lume exposes a local HTTP API server that listens at localhost for programatic management of VMs.

MCP Server

Reference for the current version of the MCP Server library.