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

Total release size: 330.4 MB

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

Download URL cua-0.18.1-py3-none-win_arm64.whl
Size 53.7 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
75c186e20d8deabc53db9b064bfd923514bbb5496b349620cd3e073cc30bb498
BLAKE2b-256 checksum
How to use checksums
f3dd2fa6e3c765b2ef02b13b6c3f3bc874686448a3c16314239c632b4abd9666
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.18.1-py3-none-win_amd64.whl

Download URL cua-0.18.1-py3-none-win_amd64.whl
Size 58.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
cbb6d23f1bf47c541a42dc21180e7681597bc7c0aa455d040a3a42d80a30006a
BLAKE2b-256 checksum
How to use checksums
fd71ea7a491c1919e65d8e4d6d0e7028ff74e84e8a387ed8b5f9b621fb04da50
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.18.1-py3-none-manylinux_2_31_x86_64.whl

Download URL cua-0.18.1-py3-none-manylinux_2_31_x86_64.whl
Size 58.6 MB
Tags Linux glibc 2.31+ x86-64 Python 3
SHA-256 checksum
How to use checksums
b154e34b994babf9ec833d542289e4e64a55ab9acbb9b23875957d50d535f034
BLAKE2b-256 checksum
How to use checksums
3d3431829576c384535519280d5fccaf5cadfc8b5bd6ee5fd5353d70f53e826b
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.18.1-py3-none-manylinux_2_31_aarch64.whl

Download URL cua-0.18.1-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
04f481158a91b5c3dc48569bc900eb7d9805e5a609d0923bbdad335b83b5dfe3
BLAKE2b-256 checksum
How to use checksums
66a055920d90c0c42b89cd0951f341382a7ad0928ea21ccebcf3bd30242cb0a3
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.18.1-py3-none-macosx_11_0_arm64.whl

Download URL cua-0.18.1-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
32ed42f8be3ff60e236d677ede5126a02fecb35182e24b670e624b2b37f25a8e
BLAKE2b-256 checksum
How to use checksums
b4d08d2b09a214feb42ffe4416fe6181cf014ce894f99ca02b74b74a504fda19
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.18.1-py3-none-macosx_10_12_x86_64.whl

Download URL cua-0.18.1-py3-none-macosx_10_12_x86_64.whl
Size 55.8 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
aac3af4626880701809d029bfc0d0c96b2f1e019768aab44303d6df3a95b4a2a
BLAKE2b-256 checksum
How to use checksums
2519de460fd69900dd8ca7149a287d7738969fc79373475ade71698fcf56a37f
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.18.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