Quickstart

This guide walks you through creating and running your first macOS VM with Lume.

Registry Maintenance Notice: The prebuilt images in the trycua registry are no longer actively maintained. For new setups, we recommend building custom images using the Unattended Setup feature to configure macOS VMs according to your specific needs.

Create a Custom VM

For more control, create a VM from scratch:

# Create a new macOS VM using the latest IPSW
lume create my-vm --os macos --ipsw latest

# Run the VM
lume run my-vm

Customize Resources

# Create with custom resources
lume create my-vm --os macos --ipsw latest \
  --cpu 4 \
  --memory 8GB \
  --disk-size 100GB

Default values:

CPU: 4 cores
Memory: 8GB
Disk: 50GB

Basic VM Operations

# List all VMs
lume ls

# Get VM details
lume get my-vm

# Stop a running VM
lume stop my-vm

# Delete a VM
lume delete my-vm

Run Without Display

For headless operation (automation, CI/CD):

# Run without opening a display window
lume run my-vm --no-display

Clone a VM

Create a copy of an existing VM:

lume clone my-vm my-vm-copy

Automate VM Configuration

Use unattended setup to automatically run through the macOS Setup Assistant:

# Create VM and auto-configure with the tahoe preset
lume create my-vm --os macos --ipsw latest --unattended tahoe

This creates a VM with user lume (password: lume) and configures common settings automatically. See Unattended Setup for custom configurations.

Next Steps

VM Management - Learn more VM operations
Unattended Setup - Automate VM configuration
CLI Reference - Full command reference

Was this page helpful?