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 AI productivity environment originally built for internal use at Cloudflare and now open-sourced so any organization can deploy it as their own. It combines an AI agent workspace, sandboxed personal apps called Gadgets, and a capability-based security framework called Gatekeepers — all running on Cloudflare Workers.

Quickstart

Run Cloudflare OS locally or deploy to your Cloudflare account in minutes.

Architecture

Understand how the workshop backend, frontend, and gatekeepers fit together.

Core Concepts

Learn about Gadgets, Gatekeepers, Blueprints, and the agent model.

Gatekeepers

Connect GitHub, Google, Confluence, Slack, Notion, and more.

​
What is Cloudflare OS?

Cloudflare OS gives your organization three things in one platform:
  1. Agent chat workspace — a multi-purpose AI agent preloaded with knowledge about your company’s tools and context, capable of writing and executing code to complete tasks.
  2. Sandboxed app development — users can ask the agent to build personal apps called Gadgets, each running in an isolated sandbox with no ambient access to the internet or your services.
  3. Gatekeepers — a security framework that wraps every external service integration with capability-based access control, human-in-the-loop approval queues, and full audit logs.

Gadgets

Sandboxed personal apps built by AI, isolated per user.

Blueprints

Shareable app templates that anyone can stamp into their own copy.

Agents

Code-mode AI agents that write and execute code to get things done.

​
Get Up and Running

1

Install pnpm

Cloudflare OS uses pnpm as its package manager. Install it if you don’t have it already.
npm install -g pnpm
2

Run locally

Clone the repository and start the full stack on your machine using Wrangler and workerd.
git clone https://github.com/cloudflare/cloudflare-os
cd cloudflare-os
pnpm run-local
Then open http://localhost:8787.
3

Deploy to Cloudflare

Use the online deploy wizard to push your own instance to a Cloudflare account.Visit os.cloudflare.app/deploy to get started.
4

Connect your services

Add Gatekeepers for GitHub, Google, Confluence, Slack, and more to give agents access to your company’s tools — with full approval controls.
Cloudflare OS is in active development (v2 early access). Expect rough edges as the team iterates. Check the GitHub repository for the latest updates.

​
Deploy Options

Cloudflare Account Deploy

One-click deployment wizard for your own Cloudflare account.

Run Locally

Run the full stack locally with wrangler for development and exploration.

Configuration

Environment variables, admin settings, and deployment customization.

Authentication

Set up OAuth sign-in with GitHub, Google, or Cloudflare.

Build docs developers (and LLMs) love

Get started for freeTalk to us