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 offers two starting paths: run locally using wrangler and workerd for quick exploration on your own machine, or deploy to Cloudflare using the guided one-click wizard to stand up a production-ready instance in your own Cloudflare account. Both paths are covered below. If you just want to see what the product does, start locally. If you want a persistent team environment, go straight to the deploy path.
Cloudflare OS is an early access release. Version 2 is very capable, but still has known rough edges. Expect active development and breaking changes as the platform matures.

​
Prerequisites

Before you begin, make sure you have the following.
  • pnpm — the package manager used throughout the monorepo. All scripts use pnpm; do not substitute npm or yarn.
  • Node.js — a recent LTS version compatible with the wrangler CLI.
  • A Cloudflare account — required for the deploy path only. Not needed to run locally.

​
Run Locally

Running locally uses wrangler to spin up the entire stack — router, backend, and frontend — on your machine using workerd, the open-source Cloudflare Workers runtime. Your data is stored in a .wrangler subdirectory. This is ideal for exploration but is not intended for production use.
1

Install pnpm

If you don’t have pnpm installed, follow the official pnpm installation guide for your platform. The most common method:
npm install -g pnpm
2

Clone the repository

git clone https://github.com/cloudflare/cloudflare-os.git
cd cloudflare-os
3

Start the local stack

From the repository root, run:
pnpm run-local
This single command installs dependencies, builds all packages, and starts the full stack locally using wrangler.
4

Open the app

Visit http://localhost:8787 in your browser. You will be prompted to create an account on first run.
5

Try it out

Once you’re in, try some of these prompts to explore what Cloudflare OS can do:
  • “Make slides for my upcoming meeting with a customer.” — Uses the built-in Slides Blueprint to generate a slide deck.
  • “Make a collaborative whiteboard app.” — Builds a new Gadget from scratch.
  • “Make a tic tac toe game.” followed by “I’ll be X and you be O. I’ve made my first move. Your turn.” — Demonstrates in-Gadget agent collaboration.
  • “Make an issue dashboard for this GitHub repo.” — Attach a repo URL; requires the GitHub Gatekeeper to be configured.
  • “Fix the typos in this Google Doc.” — Attach a doc URL; requires the Google Gatekeeper to be configured.

​
Deploy to Cloudflare

For a persistent, shareable deployment in your own Cloudflare account, use the guided deploy wizard.
1

Open the deploy wizard

Navigate to https://os.cloudflare.app/deploy in your browser.
2

Authorize your Cloudflare account

The wizard will prompt you to sign in with Cloudflare and select the account where you want to deploy. It will provision the required Workers, Durable Objects, KV namespaces, and R2 buckets automatically.
3

Configure your Gatekeepers

During the setup flow, you can install Gatekeepers for the external services you want to connect — GitHub, Google, Notion, Slack, and more. Each Gatekeeper requires its own OAuth credentials. See the per-Gatekeeper README files in the repository (e.g., packages/gatekeeper-github/README.md) for instructions on obtaining credentials.
4

Visit your deployment

Once the wizard completes, it will give you the URL for your new Cloudflare OS instance. Share it with your team and create accounts.
For more advanced deployment scenarios — custom Gatekeepers, code changes, and CI integration — see the cloudflare-os-starter repository.

​
Development Mode

When you are actively developing Cloudflare OS itself (modifying the frontend, backend, or Gatekeepers), you will want hot-reload on the frontend alongside a running backend. This requires two terminals.
Run pnpm dev-server and pnpm dev-client in separate terminal windows so that the Vite dev server provides hot module replacement for the frontend while the Workers backend reloads on backend changes.
Terminal 1 — backend and router: 
pnpm dev-server
Terminal 2 — frontend Vite dev server: 
pnpm dev-client
Then visit http://localhost:3000. The frontend dev server proxies API and Gatekeeper requests to the backend automatically.

​
Connect Your First Gatekeeper

Gatekeepers are what give agents and Gadgets access to external services like GitHub, Google Docs, Slack, and more. Without a Gatekeeper, agents can still build Gadgets and perform general tasks, but they cannot read from or write to external resources. To connect your first Gatekeeper after starting up:
  1. Open Connectors from the sidebar (or the user menu).
  2. Select the service you want to connect (e.g., GitHub).
  3. Follow the OAuth authorization flow to grant access.
  4. The connected account will then appear in your Connectors list, ready to be introduced to individual workspaces on demand.
Gatekeepers implement capability-based access control — connecting a service does not give every agent ambient access to it. You explicitly introduce a specific resource (like a particular GitHub repo) to each workspace or chat, keeping the blast radius of any agent minimal.

Gatekeeper Overview

Learn how Gatekeepers handle OAuth, sandbox external access, and provide human-in-the-loop approvals.

Architecture

Understand how the router, backend Durable Objects, and Gatekeeper Workers fit together.

Build docs developers (and LLMs) love

Get started for freeTalk to us