Guest access

Every command also accepts the global options.

lume setup#

Prepare unattended macOS setup.

Lume prepares the macOS disk offline, skips Setup Assistant, enables autologin and SSH, disables screensaver lock, verifies SSH, then stops the VM.

lume setup [OPTIONS] <name>

Examples

lume setup my-vm
lume setup my-vm --unattended sequoia

lume ssh#

Connect to a VM via SSH or execute commands remotely.

Opens an interactive shell, or runs one command and exits with its status. Password authentication is handled for you (no sshpass needed). Requires Remote Login in the guest; VMs created with --unattended have it enabled with credentials lume/lume.

lume ssh [OPTIONS] <name> [<command>...]

Examples

# Interactive shell
lume ssh my-vm
 
# Run one command
lume ssh my-vm "ls -la"
 
# A long-running command with no timeout
lume ssh my-vm --timeout 0 "cd /app && npm test"

lume sip#

Enable or disable System Integrity Protection on a macOS VM.

Boots the stopped VM normally to validate the admin credentials, runs csrutil disable (or enable) in paired recoveryOS over VNC, then boots normally once more to verify the result. The VM needs an admin account and Remote Login; VMs from unattended setup use lume/lume. Prefer --admin-password-stdin: --admin-password is visible to other processes. Requires vncdotool (pip3 install vncdotool).

lume sip [OPTIONS] <state> <name>

Examples

lume sip off my-vm --yes
 
# With another admin account, password read from stdin
lume sip on my-vm --yes --admin-user alice --admin-password-stdin

Exit codes#