Skip to content

README.md

Latest commit

 

History

History
75 lines (53 loc) · 2.95 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.95 KB
Raw

Shows my svg

Swift 6 macOS Discord

lume is a lightweight Command Line Interface and local API server to create, run and manage macOS and Linux virtual machines (VMs) with near-native performance on Apple Silicon, using Apple's Virtualization.Framework.

Run prebuilt macOS images in just 1 step

lume cli 
lume run macos-sequoia-vanilla:latest

Quickstart

Install and run a prebuilt macOS VM in two commands:

# Install Lume
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"
# Pull & start a macOS image
lume run macos-sequoia-vanilla:latest
All prebuilt images use the default password `lume`. Change this immediately after your first login using the `passwd` command.

System Requirements:

  • Apple Silicon Mac (M1, M2, M3, etc.)
  • macOS 13.0 or later
  • At least 8GB of RAM (16GB recommended)
  • At least 50GB of free disk space

Development

To get set up with Lume for development, read these instructions.

Docs

Contributing

We welcome and greatly appreciate contributions to lume! Whether you're improving documentation, adding new features, fixing bugs, or adding new VM images, your efforts help make lume better for everyone. For detailed instructions on how to contribute, please refer to our Contributing Guidelines.

Join our Discord community to discuss ideas or get assistance.

License

lume is open-sourced under the MIT License - see the LICENSE file for details.

Trademarks

Apple, macOS, and Apple Silicon are trademarks of Apple Inc. Ubuntu and Canonical are registered trademarks of Canonical Ltd. This project is not affiliated with, endorsed by, or sponsored by Apple Inc. or Canonical Ltd.