From 1be96220c16cb60a6fa9b0a8881fbda54d1fc7c6 Mon Sep 17 00:00:00 2001 From: James Murdza Date: Wed, 27 Aug 2025 21:01:30 -0400 Subject: [PATCH] Add Installation page to Lume docs --- .../docs/libraries/lume/cli-reference.mdx | 45 ------------------- docs/content/docs/libraries/lume/index.mdx | 4 +- .../docs/libraries/lume/installation.mdx | 45 +++++++++++++++++++ docs/content/docs/libraries/lume/meta.json | 7 +++ 4 files changed, 53 insertions(+), 48 deletions(-) create mode 100644 docs/content/docs/libraries/lume/installation.mdx create mode 100644 docs/content/docs/libraries/lume/meta.json diff --git a/docs/content/docs/libraries/lume/cli-reference.mdx b/docs/content/docs/libraries/lume/cli-reference.mdx index 90edf035..8c4b2c61 100644 --- a/docs/content/docs/libraries/lume/cli-reference.mdx +++ b/docs/content/docs/libraries/lume/cli-reference.mdx @@ -5,51 +5,6 @@ description: Command Line Interface reference for Lume import { Callout } from 'fumadocs-ui/components/callout'; -Lume is a lightweight Command Line Interface and local API server for creating, running and managing **macOS and Linux virtual machines** with near-native performance on Apple Silicon, using Apple's [Virtualization.Framework](https://developer.apple.com/documentation/virtualization). - -## Quick Start - -Install and run a prebuilt macOS VM in two commands: - -```bash -# 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 - -## Install - -Install with a single command: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" -``` - -By default, Lume is installed as a background service that starts automatically on login. If you prefer to start the Lume API service manually when needed, you can use the `--no-background-service` option: - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh) --no-background-service" -``` - - -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). - - -You can also download the `lume.pkg.tar.gz` archive from the [latest release](https://github.com/trycua/cua/releases?q=lume&expanded=true), extract it, and install the package manually. - -## Using Lume - Once installed, you can start using Lume with these common workflows: ### Run a Prebuilt VM diff --git a/docs/content/docs/libraries/lume/index.mdx b/docs/content/docs/libraries/lume/index.mdx index 28080bff..d62c80e0 100644 --- a/docs/content/docs/libraries/lume/index.mdx +++ b/docs/content/docs/libraries/lume/index.mdx @@ -5,6 +5,4 @@ github: - https://github.com/trycua/cua/tree/main/libs/lume --- -## Overview - -The Lume CLI provides command line tools for managing virtual machines with Lume. +Lume is a lightweight Command Line Interface and local API server for creating, running and managing **macOS and Linux virtual machines** with near-native performance on Apple Silicon, using Apple's [Virtualization.Framework](https://developer.apple.com/documentation/virtualization). \ No newline at end of file diff --git a/docs/content/docs/libraries/lume/installation.mdx b/docs/content/docs/libraries/lume/installation.mdx new file mode 100644 index 00000000..dac0df75 --- /dev/null +++ b/docs/content/docs/libraries/lume/installation.mdx @@ -0,0 +1,45 @@ +--- +title: Installation +description: Installation instructions for the current version of the Lume CLI. +--- + +## Quick Start + +Install and run a prebuilt macOS VM in two commands: + +```bash +# 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 + +## Install + +Install with a single command: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)" +``` + +By default, Lume is installed as a background service that starts automatically on login. If you prefer to start the Lume API service manually when needed, you can use the `--no-background-service` option: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh) --no-background-service" +``` + + +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). + + +You can also download the `lume.pkg.tar.gz` archive from the [latest release](https://github.com/trycua/cua/releases?q=lume&expanded=true), extract it, and install the package manually. \ No newline at end of file diff --git a/docs/content/docs/libraries/lume/meta.json b/docs/content/docs/libraries/lume/meta.json new file mode 100644 index 00000000..dbca49ea --- /dev/null +++ b/docs/content/docs/libraries/lume/meta.json @@ -0,0 +1,7 @@ +{ + "pages": [ + "installation", + "cli-reference", + "http-api" + ] +}