Installation

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

With this option, you'll need to manually start the Lume API service by running lume serve in your terminal whenever you need to use tools or libraries that rely on the Lume API (such as the Computer Use Agent).

Disable Auto-Updates

If you prefer to manage updates manually, use the --no-auto-updater option:

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

You can combine options to disable both the background service and auto-updates:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" -- --no-background-service --no-auto-updater

Manual Download and Installation

You can also download the lume.pkg.tar.gz archive from the latest release, extract it, and install the package manually.

Verify Installation

After installation, verify Lume is working:

# Check version
lume --version

# List available commands
lume --help

Managing the Background Service

If you installed with the background service (default), you can manage it with these commands:

# Check if the daemon is running
launchctl list | grep com.trycua.lume_daemon

# View daemon logs
tail -f /tmp/lume_daemon.log

# Manually start the Lume API service
lume serve

Managing Auto-Updates

If you installed with auto-updates enabled (default), Lume will automatically check for and install updates at login and every 24 hours.

# Check if the auto-updater is running
launchctl list | grep com.trycua.lume_updater

# View auto-updater logs
tail -f /tmp/lume_updater.log

# Manually run an update check
~/.local/bin/lume-update

Disable Auto-Updates After Installation

To disable auto-updates after installation:

launchctl unload ~/Library/LaunchAgents/com.trycua.lume_updater.plist
rm ~/Library/LaunchAgents/com.trycua.lume_updater.plist
rm ~/.local/bin/lume-update

Uninstall Lume

Remove the Background Service

If you installed Lume with the background service, first remove the daemon:

launchctl unload ~/Library/LaunchAgents/com.trycua.lume_daemon.plist
rm ~/Library/LaunchAgents/com.trycua.lume_daemon.plist

Remove the Auto-Updater

If you installed with auto-updates enabled, remove the updater:

launchctl unload ~/Library/LaunchAgents/com.trycua.lume_updater.plist
rm ~/Library/LaunchAgents/com.trycua.lume_updater.plist
rm ~/.local/bin/lume-update

Remove Lume Binary

First, locate the Lume binary:

which lume

Then remove it:

rm $(which lume)

Clean Up VM Images

Optionally, remove downloaded VM images:

# Remove all Lume VM images
rm -rf ~/.cache/lume-images

Next Steps

Quickstart - Create your first VM
Prebuilt Images - Available images in the registry

Was this page helpful?