lume

A lightweight CLI and local API server to build, run and manage macOS VMs.

lume [OPTIONS] <COMMAND>

Run lume <command> --help for the build you have.

Commands#

Create, run, inspect, change, clone and delete virtual machines. Reference.

Command	Description
`lume create`	Create a new virtual machine.
`lume run`	Run a virtual machine.
`lume attach`	Open a viewer for a running virtual machine.
`lume stop`	Stop a virtual machine.
`lume shutdown`	Gracefully shut down a virtual machine.
`lume restart`	Gracefully restart a virtual machine.
`lume ls`	List virtual machines.
`lume get`	Get detailed information about a virtual machine.
`lume set`	Set new values for CPU, memory, and disk size of a virtual machine.
`lume clone`	Clone an existing virtual machine.
`lume delete`	Delete a virtual machine.

Pull, push and convert VM images, find restore images, and prune the cache. Reference.

Command	Description
`lume images`	List available macOS images from local cache.
`lume pull`	Pull a prebuilt or custom macOS image from an OCI-compatible registry.
`lume push`	Push a macOS VM to an OCI-compatible registry.
`lume convert`	Convert a legacy Lume image to OCI-compliant format.
`lume ipsw`	Get macOS restore image IPSW URL.
`lume prune`	Remove cached images.

Prepare unattended setup, open SSH sessions and change SIP in a guest. Reference.

Command	Description
`lume setup`	Prepare unattended macOS setup.
`lume ssh`	Connect to a VM via SSH or execute commands remotely.
`lume sip`	Enable or disable System Integrity Protection on a macOS VM.

Run the HTTP API and MCP server, read its logs, and dump the CLI and API definitions. Reference.

Command	Description
`lume serve`	Start the VM management server.
`lume logs`	View lume serve logs.
`lume logs info`	View info logs from the daemon.
`lume logs error`	View error logs from the daemon.
`lume logs all`	View both info and error logs from the daemon.
`lume dump-docs`	Output CLI and API documentation as JSON for tooling and integrations.

Storage locations, the image cache and telemetry settings. Reference.

Command	Description
`lume config`	Get or set lume configuration.
`lume config get`	Get current configuration.
`lume config storage`	Manage VM storage locations.
`lume config storage add`	Add a new VM storage location.
`lume config storage remove`	Remove a VM storage location.
`lume config storage list`	List all VM storage locations.
`lume config storage default`	Set the default VM storage location.
`lume config cache`	Manage image cache settings.
`lume config cache dir`	Get or set cache directory.
`lume config cache enable`	Enable image caching.
`lume config cache disable`	Disable image caching.
`lume config cache status`	Show cache status and directory.
`lume config telemetry`	Manage pseudonymous telemetry settings.
`lume config telemetry status`	Show current telemetry status.
`lume config telemetry enable`	Enable pseudonymous telemetry.
`lume config telemetry disable`	Disable pseudonymous telemetry.
`lume config telemetry reset-id`	Delete the pseudonymous installation ID and registration markers.
`lume config registry`	Manage container registry settings.
`lume config registry status`	Show current registry configuration.
`lume config registry type`	Get or set registry type.
`lume config registry ghcr`	Configure GitHub Container Registry settings.
`lume config registry gcs`	Configure GCS registry settings.
`lume config network`	Manage network settings.
`lume config network interfaces`	List available network interfaces for bridged networking.

Check for, apply and choose the channel of Lume updates. Reference.

Command	Description
`lume check-update`	Check whether a newer Lume release is available.
`lume update`	Check for a Lume update and optionally apply it.
`lume channel`	Inspect or change the stable/nightly update channel; selection does not install.
`lume channel status`	Show selected and current release channels.
`lume channel set`	Save stable or nightly as the update channel.

--help prints help for any command; --version prints the version.

Code	Meaning
`0`	Success.
`1`	The command failed (for example the VM does not exist or the operation errored).
`64`	Usage error: an unknown command or option, a missing argument, or an invalid value.