/cloudflare-deploy

C3 (create-cloudflare)

Official CLI for scaffolding Cloudflare Workers and Pages projects with templates, TypeScript, and instant deployment.

Quick Start

# Interactive (recommended for first-time)
npm create cloudflare@latest my-app

# Worker (API/WebSocket/Cron)
npm create cloudflare@latest my-api -- --type=hello-world --ts

# Pages (static/SSG/full-stack)
npm create cloudflare@latest my-site -- --type=web-app --framework=astro --platform=pages

Platform Decision Tree

What are you building?

├─ API / WebSocket / Cron / Email handler
│   └─ Workers (default) - no --platform flag needed
│       npm create cloudflare@latest my-api -- --type=hello-world

├─ Static site / SSG / Documentation
│   └─ Pages - requires --platform=pages
│       npm create cloudflare@latest my-site -- --type=web-app --framework=astro --platform=pages

├─ Full-stack app (Next.js/Remix/SvelteKit)
│   ├─ Need Durable Objects, Queues, or Workers-only features?
│   │   └─ Workers (default)
│   └─ Otherwise use Pages for git integration and branch previews
│       └─ Add --platform=pages

└─ Convert existing project
    └─ npm create cloudflare@latest . -- --type=pre-existing --existing-script=./src/worker.ts

Critical: Pages projects require --platform=pages flag. Without it, C3 defaults to Workers.

Interactive Flow

When run without flags, C3 prompts in this order:

1. Project name - Directory to create (defaults to current dir with .)
2. Application type - hello-world, web-app, demo, pre-existing, remote-template
3. Platform - workers (default) or pages (for web apps only)
4. Framework - If web-app: next, remix, astro, react-router, solid, svelte, etc.
5. TypeScript - yes (recommended) or no
6. Git - Initialize repository? yes or no
7. Deploy - Deploy now? yes or no (requires wrangler login)

Installation Methods

# NPM
npm create cloudflare@latest

# Yarn
yarn create cloudflare

# PNPM
pnpm create cloudflare@latest

In This Reference

Reading Order

Post-Creation

cd my-app

# Local dev with hot reload
npm run dev

# Generate TypeScript types for bindings
npm run cf-typegen

# Deploy to Cloudflare
npm run deploy

See Also

• workers/README.md - Workers runtime, bindings, APIs
• workers-ai/README.md - AI/ML models
• pages/README.md - Pages-specific features
• wrangler/README.md - Wrangler CLI beyond initial setup
• d1/README.md - SQLite database
• r2/README.md - Object storage