Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-os/llms.txt

Use this file to discover all available pages before exploring further.

Cloudflare OS is an open-source AI productivity platform originally developed for internal use at Cloudflare, where a large portion of the workforce — from engineering to sales and everything in between — relies on it daily. The project is built on Cloudflare Workers and gives any company a secure, customizable environment for working with AI agents, building personal apps, and integrating external services — all without sacrificing the security controls that allow a team to operate safely at scale.

Three Pillars of Cloudflare OS

Cloudflare OS delivers three core capabilities that work together as a unified platform.

Agent Chat

A general-purpose agent chat interface, pre-loaded with knowledge about how your company operates. Agents are Code Mode agents that perform tasks by writing and immediately executing code snippets. They can be connected to external resources via Gatekeepers — without granting broad ambient access to all services.

Gadgets

Sandboxed personal applications built by AI on demand. Every “Gadget” is a private instance of a small app — a slide deck, a whiteboard, a dashboard — that runs in its own sandbox. Gadgets can be shared, extended, and published as reusable “Blueprints” for teammates to clone and modify.

Gatekeepers

A capability-based security framework for connecting agents and Gadgets to external services. Gatekeepers handle OAuth, enforce narrow resource access, log every action, and support asynchronous human-in-the-loop approvals — so users can review and approve actions in bulk rather than blocking the agent mid-task.

The OS Analogy

The term “operating system” is used in two senses. First, Cloudflare OS acts as an operating system for the company — a shared environment that makes it safe and productive for everyone to use AI, with the security team’s blessing. Second, it is genuinely analogous to a traditional OS on a technical level.
Traditional OSCloudflare OS
Kernelpackages/workshop-backend
Device driverspackages/gatekeeper-*
Shellpackages/workshop-frontend
ProcessesGadgets
ExecutablesBlueprints
UsersUsers
ACLsShared permissions
???Agents
The workshop-backend package acts as the kernel: it connects users to programs and devices (Gadgets and Gatekeepers) while implementing security through sandboxing and access control. Gatekeepers, which connect users and agents to external services like GitHub or Google, play the role of device drivers. The workshop-frontend is the shell — a user-facing SPA that surfaces the full workspace experience. One dimension where Cloudflare OS goes beyond traditional operating systems is AI agents. A traditional OS treats agents like users, but agents must be accountable to a specific human, carry their own restricted permissions, and have their code-execution capabilities sandboxed separately. Cloudflare OS uses capability-based security rather than access-control lists to model this, and treats agents as a first-class concept distinct from users.

Why Cloudflare Workers?

Cloudflare OS makes heavy use of three Workers primitives in particular.
  • Durable Objects — Every workspace is its own Durable Object, which provides consistent stateful storage and makes real-time multiplayer collaboration straightforward. Every Gadget is also backed by its own Durable Object, which is why real-time multi-user editing works out of the box.
  • Dynamic Workers — Each Gadget’s server-side code runs in a Dynamic Worker with network access fully disabled by default. The Gadget can only communicate with external resources that have been explicitly designated, via Workers Bindings.
  • Facets — Every Gadget runs in a Dynamic Worker Facet, giving each one an isolated execution environment. Gatekeepers also install facets into each workspace to manage their slice of external-service access.
These features were, in fact, developed in part to support Cloudflare OS itself. Studying the Cloudflare OS source is one of the best ways to understand how the Workers team thinks these primitives should be used together. Because Cloudflare OS depends only on the Workers runtime — and because workerd, the Cloudflare Workers runtime, is open source — the entire stack can run on your own servers without touching Cloudflare’s managed infrastructure.

Early Access

Cloudflare OS is in active, heavy development. This repository is version 2, a complete rewrite built on lessons learned from v1 and placed on a new architectural foundation. As of the August 2026 release, v2 is very capable, but still has many rough edges. Consider this an early access release. The team is actively working through the known issues.
The intention is not for your company to run “Cloudflare OS” as-is, but to fork it and make it your company’s OS — customized with your own branding, agent instructions, Gatekeeper integrations, and Blueprints.

Where to Go Next

Quickstart

Run Cloudflare OS locally in minutes with pnpm run-local, or deploy to your own Cloudflare account using the one-click wizard.

Architecture

Explore how the kernel, shell, Gatekeepers, and Gadgets map onto Workers primitives like Durable Objects, Dynamic Workers, and Facets.

Gatekeepers

Learn how Gatekeepers connect agents and Gadgets to external services like GitHub, Google, Notion, Slack, and more.

Build docs developers (and LLMs) love