Cua Docs

Serve the Lume API

Run Lume's local HTTP API for tools and scripts.

Use the Lume API when another local process needs to list, create, run, or stop VMs through HTTP.

Start the server#

Start the API on its default port:

lume serve

To use another port:

lume serve --port 7778

The API listens on localhost. Keep the server bound to the local host unless you have a specific network boundary and authentication plan for exposing it.

Check the server#

List the local VMs:

curl http://localhost:7777/lume/vms

Use the HTTP API reference for request bodies, responses, and the complete endpoint list.

Run it at login#

The standard installer starts Lume's background service at login. Install with --no-background-service when you want to manage the API process yourself:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh) --no-background-service"

After that installation, start the server explicitly with lume serve.