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

Total release size: 330.2 MB

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

Download URL cua-0.17.1-py3-none-win_arm64.whl
Size 53.7 MB
Tags Python 3 Windows ARM64
SHA-256 checksum
How to use checksums
aa4585ced89c9b2349b6d86005dd1b4fe50b5db4aab9ffff846c1155413ea9a0
BLAKE2b-256 checksum
How to use checksums
f6a8f73d3cd2c944e0cda97aa435cf6bc976b70712e666c915afa77a72f242ca
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.17.1-py3-none-win_amd64.whl

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

Download URL cua-0.17.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
a5fd78fa6fad803f645b842b9a8a8d9ebe9e561c7e095f35eb4845b4b9dc1328
BLAKE2b-256 checksum
How to use checksums
455e7ed45ea3a61caa952e3971278dd22d857f148c77310696dae26f27ab986b
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.17.1-py3-none-manylinux_2_31_aarch64.whl

Download URL cua-0.17.1-py3-none-manylinux_2_31_aarch64.whl
Size 53.2 MB
Tags Linux glibc 2.31+ ARM64 Python 3
SHA-256 checksum
How to use checksums
30ee0ea0ea2e756f7e767cd2e64d4c78f3d9b4ac185da0011a7620ac582ae5a3
BLAKE2b-256 checksum
How to use checksums
2bdfa4d0f0a03659e3fcba8fc8f1742e533f247b7b5a2d32ec2aeaf2d77c8b3d
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.17.1-py3-none-macosx_11_0_arm64.whl

Download URL cua-0.17.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
d34635de5530b832c5a0144eb175d9d25370fd2f88bca09afc974d37a20e52fd
BLAKE2b-256 checksum
How to use checksums
637f8ff0f14ea532f1e92e436614ac766c7b04a7b027a08f4eb8a685670813ca
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.17.1-py3-none-macosx_10_12_x86_64.whl

Download URL cua-0.17.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
439e62f9a57d38bc865e60d2a13093cd4d21ca0e3a474a64f0526f5d90450a6d
BLAKE2b-256 checksum
How to use checksums
d3be176d297f602af50e14a45afd927509df397cbf7ff8ff7cc817149749c8b3
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.17.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