Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

docs(lume): document offline vanilla setup

Francesco Bonacci2dffcdada6fa
diff --git a/README.md b/README.md
index 9c216efaba..0cfec3cb0c 100644
--- a/README.md
+++ b/README.md
@@ -149,6 +149,14 @@ lume create macos-sequoia --ipsw ~/Downloads/macos.ipsw --unattended sequoia
lume run macos-sequoia
```
+The `--unattended` option prepares the installed guest offline. The built-in
+`sequoia` and `tahoe` presets create the `lume` user, enable SSH, configure
+autologin, and disable sleep and screen locking. The default credentials are
+`lume` / `lume`.
+
+The Tahoe flow is E2E verified. Sequoia may still open the Accessibility step
+of Setup Assistant on its first display boot; see [issue #2155](https://github.com/trycua/cua/issues/2155).
+
**[Get Started](https://cua.ai/docs/lume)** | **[FAQ](https://cua.ai/docs/lume/guide/getting-started/faq)** | **[CLI Reference](https://cua.ai/docs/lume/reference/cli-reference)**
---
diff --git a/docs/content/docs/how-to-guides/lume/install-lume.mdx b/docs/content/docs/how-to-guides/lume/install-lume.mdx
index 2fb4e14bce..a0177884c2 100644
--- a/docs/content/docs/how-to-guides/lume/install-lume.mdx
+++ b/docs/content/docs/how-to-guides/lume/install-lume.mdx
@@ -58,6 +58,14 @@ lume create macos-sequoia --ipsw ~/Downloads/macos.ipsw --unattended sequoia
lume run macos-sequoia
```
+The built-in `sequoia` and `tahoe` presets create the `lume` user, enable SSH,
+configure autologin, and disable sleep and screen locking without GUI
+automation. The default SSH credentials are `lume` / `lume`.
+
+The Tahoe flow is E2E verified from a local IPSW. Sequoia can still present
+the Accessibility step of Setup Assistant on its first display boot; see
+[issue #2155](https://github.com/trycua/cua/issues/2155).
+
<Callout title="Security Note">
The unattended VM uses `lume`/`lume` for initial SSH and login access. Change
the password immediately with the `passwd` command.
diff --git a/docs/content/docs/reference/lume/cli-reference.mdx b/docs/content/docs/reference/lume/cli-reference.mdx
index d1485983ef..3e29f958bf 100644
--- a/docs/content/docs/reference/lume/cli-reference.mdx
+++ b/docs/content/docs/reference/lume/cli-reference.mdx
@@ -7,31 +7,15 @@ description: Command Line Interface reference for Lume
AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
Generated by: npx tsx scripts/docs-generators/lume.ts
Source: lume dump-docs --type cli
- Version: 0.3.10
+ Version: 0.3.11
*/}
A lightweight CLI and local API server to build, run and manage macOS VMs.
-Documented against Lume **0.3.10**. Run `lume --version` for your installed version.
+Documented against Lume **0.3.11**. Run `lume --version` for your installed version.
For installation steps, see [Install Lume](/how-to-guides/lume/install-lume).
-## Update Lume
-
-```bash
-# Check whether a newer release is available
-lume check-update
-
-# Apply an available update
-lume update --apply
-```
-
-`lume check-update --json` returns the current version, latest version, update availability,
-release notes URL, and install command. `lume update` only applies an update when `--apply` is
-provided.
-
-The MCP server also exposes a read-only `check_for_update` tool with the same update-state payload.
-
## VM Management
### lume create
@@ -360,6 +344,28 @@ View lume serve logs
- `lume logs all` - View both info and error logs
- `-n, --lines` - Number of lines to display
+### lume check-update
+
+Check whether a newer Lume release is available
+
+**Flags:**
+
+| Name | Default | Description |
+| ---- | ------- | ----------- |
+| `--json` | false | Emit the structured update-state payload as JSON |
+| `--no-cache` | false | Bypass the local update-check cache |
+
+### lume update
+
+Check for a Lume update and optionally apply it
+
+**Flags:**
+
+| Name | Default | Description |
+| ---- | ------- | ----------- |
+| `--apply` | false | Apply the update by re-running the official installer |
+| `--json` | false | Emit the structured update-state payload as JSON |
+
## Global Options
These options are available for all commands:
diff --git a/docs/content/docs/reference/lume/http-api.mdx b/docs/content/docs/reference/lume/http-api.mdx
index 51afe52900..a886e00267 100644
--- a/docs/content/docs/reference/lume/http-api.mdx
+++ b/docs/content/docs/reference/lume/http-api.mdx
@@ -7,14 +7,14 @@ description: HTTP API reference for Lume server
AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
Generated by: npx tsx scripts/docs-generators/lume.ts
Source: lume dump-docs --type api
- Version: 0.3.10
+ Version: 0.3.11
*/}
import { Tabs, Tab } from 'fumadocs-ui/components/tabs';
HTTP API for managing macOS and Linux virtual machines
-Documented against Lume **0.3.10**. Run `lume --version` for your installed version.
+Documented against Lume **0.3.11**. Run `lume --version` for your installed version.
## Default URL
@@ -568,7 +568,7 @@ const data = await response.json();
---
-### Pull a prebuilt or custom VM image from a container registry
+### Pull a VM image from a container registry
Pull a VM image from a container registry
@@ -592,7 +592,7 @@ Pull a VM image from a container registry
curl -X POST "http://localhost:7777/lume/pull" \
-H "Content-Type: application/json" \
-d '{
- "image": "my-macos-snapshot:latest"
+ "image": "macos-tahoe-vanilla:latest"
}'
```
</Tab>
@@ -601,7 +601,7 @@ curl -X POST "http://localhost:7777/lume/pull" \
import requests
data = {
- "image": "my-macos-snapshot:latest",
+ "image": "macos-tahoe-vanilla:latest",
}
response = requests.post("http://localhost:7777/lume/pull", json=data)
@@ -614,7 +614,7 @@ const response = await fetch(`http://localhost:7777/lume/pull`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
- image: "my-macos-snapshot:latest",
+ image: "macos-tahoe-vanilla:latest",
}),
});
const data = await response.json();
diff --git a/libs/lume/Development.md b/libs/lume/Development.md
index f991a49eea..f36468c68b 100644
--- a/libs/lume/Development.md
+++ b/libs/lume/Development.md
@@ -53,3 +53,18 @@ This workspace is preconfigured with Swift language support, build tasks, and de
- Reference to any related issues
- Screenshots or logs if relevant
3. Respond to any feedback from maintainers
+
+## Testing Offline Unattended Setup
+
+Use a local Apple restore image to exercise the vanilla macOS flow end to end:
+
+```bash
+lume create macos-tahoe --ipsw ~/Downloads/macos-tahoe.ipsw --unattended tahoe
+lume run macos-tahoe
+lume ssh macos-tahoe 'id -un'
+```
+
+The guest should report `lume`, accept SSH with the default `lume` password,
+and boot without Setup Assistant. Tahoe is the currently verified preset;
+Sequoia's remaining Accessibility-step issue is tracked in
+[#2155](https://github.com/trycua/cua/issues/2155).
diff --git a/libs/lume/README.md b/libs/lume/README.md
index a6045ffd00..61dfb00b8b 100644
--- a/libs/lume/README.md
+++ b/libs/lume/README.md
@@ -3,3 +3,25 @@
CLI and framework for macOS and Linux VMs using Apple Virtualization Framework.
**[Documentation](https://cua.ai/docs/lume)** - Installation, guides, and API reference.
+
+## Vanilla macOS VMs
+
+Create a fresh macOS VM from an Apple restore image with the offline unattended
+setup enabled:
+
+```bash
+lume create macos-tahoe --ipsw ~/Downloads/macos-tahoe.ipsw --unattended tahoe
+lume run macos-tahoe
+```
+
+The built-in `sequoia` and `tahoe` presets configure the installed guest
+without GUI automation. They create the `lume` user, enable SSH, configure
+autologin, and disable sleep and screen locking. The default SSH credentials
+are `lume` / `lume`.
+
+Tahoe is E2E verified from a local IPSW. Sequoia can still present the
+Accessibility step of Setup Assistant on its first display boot; this is
+tracked in [#2155](https://github.com/trycua/cua/issues/2155).
+
+To use the other built-in preset, replace `tahoe` with `sequoia` in the
+`--unattended` option and choose a matching VM name.