Quick Start

Clone the upstream product (not this docs site) and exercise the shared core locally.

Prerequisite: Node.js 24+ (matches product engines and Lambda runtime).

git clone https://github.com/jajera/pr-readiness-coach.git
cd pr-readiness-coach
npm install
npm run build
npm test

Fixture demo (no Bedrock)

chmod +x fixtures/demo.sh
./fixtures/demo.sh

Or run the CLI directly:

npm run pr-ready -- --local --path fixtures/demo-app/not-ready
npm run pr-ready -- --local --path fixtures/demo-app/ready

Expected:

Path	Verdict	Exit
fixtures/demo-app/not-ready	NOT READY	1
fixtures/demo-app/ready	READY	0

All fixture secrets are placeholders only.

Tip

--local is heuristic-only. Full Bedrock mode needs AWS_REGION (or AWS_DEFAULT_REGION) and credentials that can call Bedrock in that region.

Next steps

1. CLI reference — modes, flags, exit codes
2. Demo — fixtures, full local, and remote API
3. Architecture — how surfaces share one core
4. AWS Deploy — when you are ready for API + UI