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 the static Linux 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.15.1

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.15.1
File Actions
cua-0.15.1-py3-none-win_arm64.whl Python 3 none Windows ARM64 Details for cua-0.15.1-py3-none-win_arm64.whl
cua-0.15.1-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for cua-0.15.1-py3-none-win_amd64.whl
cua-0.15.1-py3-none-manylinux_2_31_x86_64.whl Python 3 none Linux glibc 2.31+ x86-64 Details for cua-0.15.1-py3-none-manylinux_2_31_x86_64.whl
cua-0.15.1-py3-none-manylinux_2_31_aarch64.whl Python 3 none Linux glibc 2.31+ ARM64 Details for cua-0.15.1-py3-none-manylinux_2_31_aarch64.whl
cua-0.15.1-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for cua-0.15.1-py3-none-macosx_11_0_arm64.whl
cua-0.15.1-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for cua-0.15.1-py3-none-macosx_10_12_x86_64.whl

Total release size: 339.6 MB

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

Download URL cua-0.15.1-py3-none-win_arm64.whl
Size 55.1 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
7523dc94bd59bc5350afa11cf779bc09acd06da10a7da5769139b494d69748f8
BLAKE2b-256 checksum
How to use checksums
383259d66d74558bd4c117247f1621753a1842af09df8d7b01ccc3148385de20
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.15.1-py3-none-win_amd64.whl

Download URL cua-0.15.1-py3-none-win_amd64.whl
Size 59.6 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
676ecdd255a93b53042b067e11611ff89bdef7389173f2b967db6e2c2f8bf277
BLAKE2b-256 checksum
How to use checksums
1ff481833fa690c1fab8dd41fe0ecd36a59bf6a19dbc7e68bf3ba351bdd2b703
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.15.1-py3-none-manylinux_2_31_x86_64.whl

Download URL cua-0.15.1-py3-none-manylinux_2_31_x86_64.whl
Size 60.4 MB
Tags Linux glibc 2.31+ x86-64 Python 3
SHA-256 checksum
How to use checksums
e91644804997a1ab966eae152b99edb89dc5046054269276defddfc782eb1253
BLAKE2b-256 checksum
How to use checksums
4c834015637d4ccf338ff6585d0db95ceab52063850e24fcca10ef8e4110f16f
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.15.1-py3-none-manylinux_2_31_aarch64.whl

Download URL cua-0.15.1-py3-none-manylinux_2_31_aarch64.whl
Size 54.8 MB
Tags Linux glibc 2.31+ ARM64 Python 3
SHA-256 checksum
How to use checksums
6fb9c718e80d47483d3d83c17821a04207dafb811a3571fca5bf00e41d69ecb4
BLAKE2b-256 checksum
How to use checksums
633f159345d559156dbe36bb9f315e8d70b51568324603017e0d4a8059f52d08
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.15.1-py3-none-macosx_11_0_arm64.whl

Download URL cua-0.15.1-py3-none-macosx_11_0_arm64.whl
Size 52.4 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
bc6a0c6257138184bb6450562bc698ef987856c5ba72eecf24acd1e84d203870
BLAKE2b-256 checksum
How to use checksums
2e51150b77a247a8fa15bc0c1eef969fa16d5b7ba233e03c5f5ad5903fc93e90
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.15.1-py3-none-macosx_10_12_x86_64.whl

Download URL cua-0.15.1-py3-none-macosx_10_12_x86_64.whl
Size 57.4 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
6a996e4b425720a9d1073fa48b2f5f996b49764e9762836f54803208628a7d28
BLAKE2b-256 checksum
How to use checksums
80a77c9338c05bfd90254b7432beea4ccce85e5f7e7357719b62265963b1516c
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.15.1

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