CF Ready documentation

CF Ready (cf-ready) is an open-source CLI that scans a local repository and reports whether a website or application is ready to go live on Cloudflare Workers, Pages, and related platform services.

Quick start

npx @orangecloud/cf-ready scan

This runs all readiness inspectors and writes nine report files (see Reports). Add --json for machine-readable stdout output.

Command	Purpose
`cf-ready scan`	Full go-live readiness scan + reports
`cf-ready inspect --json`	Framework and route detection only
`cf-ready fix --ai-readiness --seo`	Generate draft AI and SEO assets
`cf-ready security-scan`	Security checks + SARIF output

New to cf-ready? Start with Getting started. Prefer a browser UI? Use the Web Agent at /app/.

What it checks

Five weighted categories contribute to an overall 0–100 score. Blockers prevent production-ready status.

Category	Weight	Doc
Migration	35%	Runtime blockers, Next.js vinext/OpenNext
Security	30%	Secrets, CORS, npm audit, SARIF
AI readiness	20%	robots.txt, llms.txt, OpenAPI, MCP
SEO	10%	Metadata, sitemap, structured data
Deployment	5%	wrangler, CI, rollback

Scoring rules and production-ready gates: Scoring.

Documentation sections

Section	Description
Getting started	Install, first scan, interpreting results
Examples	Next.js, Vite, and Node.js walkthroughs
Commands	Full CLI reference
Configuration	`cf-ready.config.json` options
Web Agent	Browser-based scans via GitHub OAuth
Migration	Workers runtime blockers and framework paths
Security	Secret scanning, env files, dependency audit
AI readiness	Agent discoverability assets and `aiPolicy`
SEO readiness	Metadata and crawlability checks
Reports	All nine output files and JSON schema
Scoring	Weights, deductions, production-ready rules
GitHub Action	CI integration, SARIF upload, PR checks
Roadmap	Planned features and observability

CI integration. Add the composite action to pull requests for automated readiness checks. The cf-ready repo dogfoods its own action on tests/fixtures/nextjs-app — see GitHub Action.