computer README

The project's README from github.com/cloudflare/computer. As one markdown file: README.md.

Cloudflare Computer

Cloudflare Computer is a virtual filesystem that lives inside a Durable Object. The Durable Object holds the authoritative state in SQLite and exposes one pluggable execution surface through workspace.runtime. Three backends ship today:

A Workspace may register multiple backends under stable IDs. workspace.runtime.exec(source, { backend }) is the single execution entry point; the selected backend defines whether source is a shell command or an ECMAScript module. Backends connect lazily on first use.

Workspace can also be constructed without a backend at all, giving callers the filesystem on its own.

[!IMPORTANT] PREVIEW ONLY This package is provided as a preview for feedback only. APIs are unstable and the design is subject to change.

Suitable for experiments, exploration and prototypes. It is NOT suitable for production use at this time.

The specification under docs/ is forward-looking — read it for intent, not as description of the code today.

Using it

If you want to build on Cloudflare Computer, install @cloudflare/computer and follow that package's README — it has the installation steps, the entrypoint map, and worked examples of the fs and runtime surfaces.

To contribute feedback, see CONTRIBUTING.md. Approved collaborators should follow COLLABORATORS.md for setup, build, and test instructions.

Examples

The examples/ directory holds runnable consumers of the public surface. Each is a Worker workspace with its own README.

Repository layout

The repo is a small monorepo. Each package has its own README with package-specific status and usage notes.

Performance

computerd's FUSE mount beats real disk on metadata-heavy work and trails it on large sequential I/O. See docs/19_performance.md for the full fs-bench numbers, a cloudflare/sandbox-sdk npm install comparison, and how to reproduce them.

Documentation

Contributing

We accept bug reports, fix proposals, feature requests, and design proposals through issues and discussions. We do not accept unsolicited pull requests. See CONTRIBUTING.md for the public contribution paths.

Approved collaborators should follow COLLABORATORS.md for setup, formatting, testing, commit message, and pull request conventions.

If you're working in this repo as an agent, start with AGENTS.md and the skills under .agents/skills/.

License

MIT. See LICENSE.

computer (cloudflare/computer)

monorepo
Searching Database…

9.6K ·GitHub
Computer
What is this?Cloudflare Computer gives an AI agent a persistent computer: a virtual filesystem backed by a Durable Object's SQLite storage, with pluggable backends that actually execute shell commands or JavaScript against that filesystem.
Is this a standalone app or something I build on top of?It is a TypeScript monorepo of npm packages ('@cloudflare/computer', 'dofs', 'computerd', 'rpc') that you install inside your own Cloudflare Worker/Durable Object, not a service you run by itself.
How do I get started building with it?Install the '@cloudflare/computer' package and follow its README for installation steps and the filesystem/runtime API, or clone one of the runnable examples such as 'examples/tutorial' or 'examples/mcp'.
What do I need to run this?You need a Cloudflare Workers/Durable Objects project; the Container backend additionally needs a sandbox container running the computerd daemon, synced over a capnweb RPC channel.
Is this ready for production use?No, the README explicitly labels it preview-only with unstable APIs, suitable for experiments and prototypes but not production.
What are the three execution backends?Container (a sandbox with a real FUSE mount and full Linux userland), Isolate shell (just-bash running in a Dynamic Worker), and Isolate JavaScript (an ECMAScript module in a Dynamic Worker) — all triggered through the same workspace.runtime.exec() call.
Can a workspace use more than one backend?Yes, a Workspace can register multiple backends under stable IDs and you choose which one to use per workspace.runtime.exec() call.
How does the FUSE mount perform versus a real disk?computerd's FUSE mount beats real disk on metadata-heavy work but trails it on large sequential I/O, according to the fs-bench numbers in docs/19performance.md.
What's inside the examples folder?Runnable demos covering container and worker-shell execution, egress policies, an MCP tool server, a long-context code-mode reducer (rlm), a terminal chat agent, and publishing generated projects as Cloudflare Artifacts.
What are similar projects?agentic-inbox, company-brain, tardigrade, moltworker, cloudflare-os, open-compute, mirage, agentbox
Which topics is it in?fuse, agent-sandbox, filesystem, cloudflare-workers, serverless, cloudflare, monorepo, sandbox, websocket, sqlite, sdk, cloud
Creator
cloudflare
Size
8.9 MB
Stars
9.6K
Updated
CommitOct 15Release@cloudflare/[email protected]Oct 13
Age
4mo
Commits · 90 Days