mirror of
https://github.com/prdlk/dotfiles.git
synced 2026-11-02 19:32:43 +00:00
Prad Nukala
6406208b35
- 16 cross-shell utilities converted to sh/bash chezmoi executables: ai c2p cp-appid extract_agents fab gdc gh-sonr-org-migrate ghg-clone ghn gho git-summary launch_omp_livediff_overlay lc-elir mdcp mdp pj (ghg-clone not named ghg: unrelated cargo binary owns that name) - cwd/history helpers stay per-shell: yy c cd clip-last + ghg/ghn/gho cd-wrappers in bash/functions/ and zsh/functions/, loaded by rc files - fish keeps only shell-state functions; converted ones now hit PATH - cp-appid ignore gating moved to .local/bin path - dot_agents/skills: 82 skills materialized from dotstate storage so dot_claude skill symlinks resolve on fresh bootstrap; dotstate profile/symlinks.json released .agents/skills .bashrc .zshrc
112 lines
3.3 KiB
Markdown
112 lines
3.3 KiB
Markdown
# C3 (create-cloudflare)
|
|
|
|
Official CLI for scaffolding Cloudflare Workers and Pages projects with templates, TypeScript, and instant deployment.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# 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
|
|
|
|
```bash
|
|
# NPM
|
|
npm create cloudflare@latest
|
|
|
|
# Yarn
|
|
yarn create cloudflare
|
|
|
|
# PNPM
|
|
pnpm create cloudflare@latest
|
|
```
|
|
|
|
## In This Reference
|
|
|
|
| File | Purpose | Use When |
|
|
|------|---------|----------|
|
|
| **api.md** | Complete CLI flag reference | Scripting, CI/CD, advanced usage |
|
|
| **configuration.md** | Generated files, bindings, types | Understanding output, customization |
|
|
| **patterns.md** | Workflows, CI/CD, monorepos | Real-world integration |
|
|
| **gotchas.md** | Troubleshooting failures | Deployment blocked, errors |
|
|
|
|
## Reading Order
|
|
|
|
| Task | Read |
|
|
|------|------|
|
|
| Create first project | README only |
|
|
| Set up CI/CD | README → api → patterns |
|
|
| Debug failed deploy | gotchas |
|
|
| Understand generated files | configuration |
|
|
| Full CLI reference | api |
|
|
| Create custom template | patterns → configuration |
|
|
| Convert existing project | README → patterns |
|
|
|
|
## Post-Creation
|
|
|
|
```bash
|
|
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
|