Skip to main content

cua (Python)

The cua SDK for Python: a thin, generated binding over the Rust cua-sdk crate (libs/cua/crates/cua-sdk). The same API runs embedded in your process or against a cua daemon that shares sandboxes, spacesd connections and credentials across processes.

import asyncio, cua

async def main():
    c = cua.embedded()
    sb = await c.sandboxes().connect_url("http://127.0.0.1:3211", "token", "dev")
    env = await sb.spacesd(None)
    print((await env.run(cua.SpacesdCommand(program="uname", args=["-a"]))).stdout.decode())
    png = await env.screenshot(None)

asyncio.run(main())

Sandboxes: any image, local or cloud

c = cua.embedded()
sb = await c.sandboxes().create(cua.SandboxCreateOptions(
    on="local",                                   # or "aws": same options
    image="python:3.12-slim",
    command=["python", "-m", "my_mcp", "--port", "8765"],
    env={"FOO": "bar"},
    services={"mcp": 8765},
    wait_for=[cua.ReadinessProbe(port=0, service="mcp", http_path="/health")],
    cloud=cua.CloudOptions(warm=True),            # optional, ignored locally
))
svc = sb.service("mcp")
r = await svc.request("POST", "/mcp", body, None, [cua.HttpHeader(name="accept", value="application/json, text/event-stream")])
url = await svc.url()                             # usable from this machine
share = await sb.public_url("mcp", 3600, None)    # shareable, expires
fwd = await sb.forward(8765)                      # loopback URL: fwd.url()
info = sb.info()  # id, phase, location, services, expires_at_unix, provider_details

public_url is a signed URL in the cloud and a loopback URL with its own token locally, served by the cua daemon (started on demand with the cua CLI, which pip install cua installs through its cua-cli dependency). await sb.mcp("mcp", None) is an MCP client for a server the sandbox serves and await sb.mcp_config("mcp", None) its URL and headers for any MCP client; neither needs cua-spacesd. cua.canonical_image("linux", None) returns ghcr.io/trycua/linux:24.04. Cloud env, sidecars (addressed by name, on gVisor and KubeVirt) and registry secrets work like local ones; cloud image layers (a remote build) are not available yet and fail with a clear error.

High-level API (optional extras)

cua replaces the former cua meta-package (0.1.x). Its convenience imports resolve lazily from optional extras:

pip install "cua[sandbox]"   # cua-sandbox: Sandbox, Image, QEMURuntime, ...
pip install "cua[agent]"     # cua-agent: ComputerAgent, cua.callbacks, cua.tools
pip install "cua[all]"       # both (the `cua` command is the Rust CLI in libs/cua)
pip install --no-deps cua    # the SDK alone, without the `cua` command (`cua-cli`)
from cua import Sandbox, Image            # cua_sandbox.Sandbox / Image
async with Sandbox.ephemeral(Image.linux(), local=True) as sb:
    print((await sb.shell.run("uname -a")).stdout)

With cua-sandbox installed, cua.Sandbox is the high-level cua_sandbox.Sandbox; the SDK's own handle type (what sandboxes().create() returns) is always cua.SandboxHandle.

  • cua._native is generated by libs/cua/scripts/generate-uniffi-bindings.mjs and must not be edited; --check fails CI when it drifts.
  • Wheels are platform wheels (build_wheel.py), one per OS/arch, each with the libcua_sdk library next to _native.py (and, on Linux, the static cua-spacesd in cua/bin/). The cua CLI is a second platform wheel, cua-cli (cli/), a dependency of cua that installs cua_cli/bin/cua[.exe]; the cua command runs it with CUA_SPACESD_STATIC set to that cua-spacesd. PyPI caps each file at 100 MB and the two together are over it.

Development

cd libs/cua
cargo build --release -p cua-sdk
scripts/build-test-fixtures.sh
node scripts/stage-uniffi-library.mjs          # copies the library here
cd python && uv run --with pytest pytest -q    # smoke tests against fixtures

Metadata

Release files for cua 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for cua 0.14.0
File Actions
cua-0.14.0-py3-none-win_arm64.whl Python 3 none Windows ARM64 Details for cua-0.14.0-py3-none-win_arm64.whl
cua-0.14.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for cua-0.14.0-py3-none-win_amd64.whl
cua-0.14.0-py3-none-manylinux_2_31_x86_64.whl Python 3 none Linux glibc 2.31+ x86-64 Details for cua-0.14.0-py3-none-manylinux_2_31_x86_64.whl
cua-0.14.0-py3-none-manylinux_2_31_aarch64.whl Python 3 none Linux glibc 2.31+ ARM64 Details for cua-0.14.0-py3-none-manylinux_2_31_aarch64.whl
cua-0.14.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for cua-0.14.0-py3-none-macosx_11_0_arm64.whl
cua-0.14.0-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for cua-0.14.0-py3-none-macosx_10_12_x86_64.whl

Total release size: 287.1 MB

Release files / cua-0.14.0-py3-none-win_arm64.whl

Download URL cua-0.14.0-py3-none-win_arm64.whl
Size 42.6 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
bd23afc113b429953fe43a6704d4b2af18fe92678a22fc7436c12463ca828405
BLAKE2b-256 checksum
How to use checksums
9bc79f3c22ac4745c9c44ad90a95e7ee56b08443116807c7b6397f47400f2004
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / cua-0.14.0-py3-none-win_amd64.whl

Download URL cua-0.14.0-py3-none-win_amd64.whl
Size 46.2 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
9cbec71a3a5cd6d40eb15bf95ba58256d7e1980a674bf13362f416549eba88d0
BLAKE2b-256 checksum
How to use checksums
1561131cc72b9ecc06bc99149d888083e17cdd9db539680e3355e8fba85ebe7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / cua-0.14.0-py3-none-manylinux_2_31_x86_64.whl

Download URL cua-0.14.0-py3-none-manylinux_2_31_x86_64.whl
Size 60.1 MB
Tags Linux glibc 2.31+ x86-64 Python 3
SHA-256 checksum
How to use checksums
68de90de0d65ec0901b173151f57899c3fb51b370baee70b5183a6e432dcbeb3
BLAKE2b-256 checksum
How to use checksums
ea89a76ff5362106c625bb2e0d77d84b093da8b1895f482ae47afe0465aeabdc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / cua-0.14.0-py3-none-manylinux_2_31_aarch64.whl

Download URL cua-0.14.0-py3-none-manylinux_2_31_aarch64.whl
Size 54.5 MB
Tags Linux glibc 2.31+ ARM64 Python 3
SHA-256 checksum
How to use checksums
5f719a9f9ad3022de14122d73341eea1cd2e8f2b34adc078b00ab54330e28ec1
BLAKE2b-256 checksum
How to use checksums
fee8bcb1d8da0b8ff5db6e04a8f63543af50ca63ec48b39b2c409dcee3bd0b8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / cua-0.14.0-py3-none-macosx_11_0_arm64.whl

Download URL cua-0.14.0-py3-none-macosx_11_0_arm64.whl
Size 39.9 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
2428c3d865e7f96851903602f1b6a5df8410ea3cede1e0aa31b4faf3663915a8
BLAKE2b-256 checksum
How to use checksums
aa53608deb6fc26fd446f0f1b846bf8dc50a3be3ac0cd3048786c529c9f11cbf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / cua-0.14.0-py3-none-macosx_10_12_x86_64.whl

Download URL cua-0.14.0-py3-none-macosx_10_12_x86_64.whl
Size 43.9 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
da462cc396ef3b86d628ece646125da541d15edc0e14eaaed5ab53bd0da122d0
BLAKE2b-256 checksum
How to use checksums
9e296e793f33d41169f503fac4cf3b730560f5f549b6f3418aaf05b993a38d14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for cua 0.14.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page