Getting started

Cusp runs entirely on the Cloudflare Developer Platform: one Worker, one D1 database, one R2 bucket, one KV namespace. You deploy it to your own Cloudflare account, then create your administrator account in the browser. There is no external service to sign up for and no server to run.

Before you start

• A Cloudflare account. The free Workers plan is enough to run Cusp.
• The Dynamic Worker Loader account flag (a Cloudflare beta). Cusp's Worker declares a Worker Loader binding — it runs installed themes and plugins in a sandbox — so a deploy on an account without the flag fails at install with a platform binding error. If your deploy fails that way, enable the Dynamic Worker Loader beta on your Cloudflare account and deploy again.
• For the one-click button: nothing else to install — the deploy happens in your browser.
• For the CLI path: Node 20 or newer and pnpm 9 or newer, plus a local clone of the repository.

Deploy

The fastest path is the Deploy to Cloudflare button in the project README. It provisions the Worker and its bindings, runs the embedded database migrations on the first request, and hands you a URL.

To drive the deploy from your own machine instead, clone the repository and run the bootstrap command. It creates the D1, R2, and KV resources, wires the bindings, builds, and deploys:

pnpm install
pnpm cusp:bootstrap

Either path leaves you with a live deployment on your own *.workers.dev URL. Open it and Cusp redirects you to /setup.

Complete the first-run wizard

The first time you open your deployment it redirects to /setup. The wizard creates your administrator account, captures the public site URL, and can seed an example site so you have content to explore.

• Create the administrator — email and a password. The password is hashed with Argon2id; nothing is stored in plaintext.
• Set the public base URL — used to build absolute links, sitemaps, and feeds.
• Optionally seed the example site — the Royal Society of Pheasant Patissiers, a complete worked example you can pull apart or delete.

Sign in and start writing

After the wizard you land in the admin at /admin. Create a collection, add a document, and the block editor opens. Publishing pre-renders the page to R2 and serves it from Cloudflare's cache. Every save is versioned, so you can browse and restore any earlier state.

From here, the block editor guide shows you how to write, and the content-types guide shows you how to shape your own collections and fields. The deploying guide covers the CLI options, environment variables, and recovery steps in full.