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

Total release size: 330.2 MB

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

Download URL cua-0.22.0-py3-none-win_arm64.whl
Size 53.9 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
a39efe6dbdcc05a8ad5774ad9b5524442c6ba23a1adf65f177bccff4f55cbc2e
BLAKE2b-256 checksum
How to use checksums
fff618dee307aec187a254a23c1181753be063acc0f8060aa9021882f141ebbd
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.22.0-py3-none-win_amd64.whl

Download URL cua-0.22.0-py3-none-win_amd64.whl
Size 58.2 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
72255f23140c9bc985cf21919f32e5a93f94a90dbfcb7e373548e3d23394ed3a
BLAKE2b-256 checksum
How to use checksums
f067c05eb52f60f04d598f9866c33a62e5921fdd4703ec34cfde181ac1462507
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.22.0-py3-none-manylinux_2_31_x86_64.whl

Download URL cua-0.22.0-py3-none-manylinux_2_31_x86_64.whl
Size 57.9 MB
Tags Linux glibc 2.31+ x86-64 Python 3
SHA-256 checksum
How to use checksums
e39e6f3923290d4a772f31211c5b6ed05143777068ddc29ec8920e45fc951c44
BLAKE2b-256 checksum
How to use checksums
f5602de3876d84af9b2ec4073e32d6e5ea339ba394990afa5f42f7682979c2e1
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.22.0-py3-none-manylinux_2_31_aarch64.whl

Download URL cua-0.22.0-py3-none-manylinux_2_31_aarch64.whl
Size 53.3 MB
Tags Linux glibc 2.31+ ARM64 Python 3
SHA-256 checksum
How to use checksums
54593b78f9f9e1cdba955121c70c675833ab70222c3b135d006d31087b2c0198
BLAKE2b-256 checksum
How to use checksums
9e87cca83d588e603ab3f3ca52535e4c0dcf0d876b9e0599bf555d3ffaa92d4c
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.22.0-py3-none-macosx_11_0_arm64.whl

Download URL cua-0.22.0-py3-none-macosx_11_0_arm64.whl
Size 51.0 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
25462e631b36b6749d9d99db7a6439afb57a14d1b318e26d53b16aae8e93e5ab
BLAKE2b-256 checksum
How to use checksums
4526b97d5f0655e1708aad0810c29c35ba21ee029c0d1e60ea401253effd9b06
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.22.0-py3-none-macosx_10_12_x86_64.whl

Download URL cua-0.22.0-py3-none-macosx_10_12_x86_64.whl
Size 55.9 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
7cc87e587aacbe2fc727a6b01ccb2a21a945a84d6232263cdfd6a4bce480fa57
BLAKE2b-256 checksum
How to use checksums
3856292eb5747ef7bf69fc036a3d3292cc205c4a7991e581cd5946d806644e6d
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.22.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