Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/trycua/cua/llms.txt

Use this file to discover all available pages before exploring further.

Lume is a single binary that you install once and update in place. The standard installer places the binary in ~/.local/bin, registers a background service that starts at login, and removes any legacy auto-updater cron jobs or LaunchAgents from earlier versions.

​
Requirements

Before installing, confirm your machine meets these requirements:
  • Apple Silicon Mac — M1, M2, M3, or any later chip (Intel is not supported)
  • macOS 14 Sonoma or later on the host
  • At least 8 GB of RAM (16 GB recommended for macOS guests)
  • At least 50 GB of free disk space

​
Install Lume

1

Run the installer

Paste this one-line command into your terminal:
/bin/bash -c "$(curl -fsSL https://cua.ai/lume/install.sh)"
The installer downloads the latest Lume binary, installs it to ~/.local/bin/lume, and starts the background service.
2

Verify the installation

Confirm the binary is on your PATH and print the installed version:
lume --version
If your shell does not find lume, add ~/.local/bin to your PATH:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
The installer starts a background service (lume serve) that makes the HTTP API available at http://localhost:7777 on login. Pass --no-background-service to skip that step and manage the server process yourself.

​
Update Lume

1

Check for an available update

lume check-update
2

Apply the update

lume update --apply
This re-runs the official installer and replaces the binary in place. Alternatively, re-run the one-line installer at any time to get the latest release:
/bin/bash -c "$(curl -fsSL https://cua.ai/lume/install.sh)"

​
Manual installation

If you prefer not to use the script, download the lume.pkg.tar.gz archive from the latest release on GitHub, extract it, and install the package manually: 
tar -xzf lume.pkg.tar.gz
installer -pkg lume.pkg -target CurrentUserHomeDirectory

​
Uninstall Lume

1

Run the uninstall script

Download and run the official uninstaller:
/bin/bash -c "$(curl -fsSL https://cua.ai/lume/uninstall.sh)"
A standard uninstall removes the binary and background service but preserves your VMs, configuration, and the pseudonymous telemetry ID so a reinstall is recognized as a returning installation.
2

Purge all data (optional)

To remove VMs, configuration, cache, and the telemetry ID as well, pass --purge:
/bin/bash -c "$(curl -fsSL https://cua.ai/lume/uninstall.sh)" -- --purge
--purge permanently deletes all local VMs and their disk images. Back up any VMs you want to keep before running this command.

​
Telemetry

Lume telemetry is enabled by default. It records pseudonymous event metadata only — no prompts, VM names, file paths, or VM contents. To check the status or disable it: 
lume config telemetry status
lume config telemetry disable

​
Next steps

Manage VMs

Create your first macOS or Linux VM and learn the everyday lifecycle commands.

Advanced topics

Expand disks, enable Metal GPU capabilities, configure SIP, and run the HTTP API.

Build docs developers (and LLMs) love

Get started for freeTalk to us