Getting started

CF Ready (cf-ready) scans a local project directory and produces a go-live readiness report for Cloudflare Workers, Pages, and related platform services.

Requirements

Node.js 18+ for the CLI
A project directory with source code (monorepo: point --cwd at the app package)
Optional: cf-ready.config.json for project metadata — see Configuration

Install

npm (when published)

npx @orangecloud/cf-ready scan --cwd ./my-app

Or install globally:

npm install -g @orangecloud/cf-ready
cf-ready scan --cwd ./my-app

npm pending. Until @orangecloud/cf-ready is on npm, build from source:

git clone https://github.com/sycu8/Cloudflare-Go-Live-Readiness.git
cd Cloudflare-Go-Live-Readiness
npm ci && npm run build
node dist/index.js scan --cwd /path/to/your-app

Your first scan

From your application root:

cf-ready scan --cwd .

The CLI will:

Detect framework, package manager, and deployment target
Run migration, security, AI, SEO, and deployment checks
Calculate weighted readiness scores
Write up to 9 report files to outputDir (default: project root)

Human-readable summary prints to the terminal. For CI or scripting:

cf-ready scan --cwd . --json

JSON stdout includes scores, blockers, findings, and productionReady. See Reports and Scoring.

Example output (fixture)

$ cf-ready scan --cwd tests/fixtures/nextjs-app

Cloudflare Go-Live Readiness Scan
────────────────────────────────
Framework:     nextjs
Package mgr:   npm
Target:        vercel

Overall:       78/100
Migration:     72  Security: 85
AI readiness:  64  SEO: 70  Deploy: 80

Status:        Not production ready
Blockers:      2

Reports generated
✓ cf-ready-report.md
✓ cf-ready-report.json
…

Inspect without scanning

Quick metadata-only pass (always JSON to stdout):

cf-ready inspect --cwd . --json

Returns detected framework, packageManager, deploymentTarget, routes, and important files — useful before a full scan.

Exit codes

Code	Meaning	Typical use
`0`	Production ready (no blockers)	CI pass
`1`	Findings present — blockers or policy failures	CI warn / gate
`2`	Runtime error (invalid path, config, etc.)	CI fail

Common workflows

Goal	Command
Full go-live report	`cf-ready scan`
Security only + SARIF	`cf-ready security-scan`
Migration plan markdown	`cf-ready migration-plan`
Generate AI/SEO drafts	`cf-ready fix --ai-readiness` / `--seo`
Pre-deploy gate	`cf-ready deploy-check`
Post-deploy HTTP checks	`cf-ready smoke-test --url https://…`
PR CI	GitHub Action

Full reference: Commands. Framework walkthroughs: Examples.

Web Agent (no install)

Open ready.orangecloud.vn/app to upload a ZIP, import GitHub (public or private via OAuth), and run scans in a browser terminal. See Web Agent.

Safe by default. Scans are read-only. Source files change only when you run fix with explicit flags.