Skip to content

Demo

Work from the upstream product repo after npm install (and npm run build if you have not built yet).

No AWS credentials required. fixtures/demo.sh runs both paths with --local --path … --json and asserts verdicts + exit codes.

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

Or run the CLI directly:

Terminal window
npm run pr-ready -- --local --path fixtures/demo-app/not-ready
npm run pr-ready -- --local --path fixtures/demo-app/ready
PathVerdictExitWhy
fixtures/demo-app/not-readyNOT READY1Fake .env secrets, TODOs, debug logs, missing tests
fixtures/demo-app/readyREADY0Tests present, no heuristic issues

All fixture secrets are placeholders only. Use this path for a deterministic READY / NOT READY demo.

Needs working Bedrock in AWS_REGION (see AWS Deploy smoke tests):

Terminal window
export AWS_PROFILE=<your-profile>
export AWS_REGION=ap-southeast-2
aws sso login --profile "$AWS_PROFILE"
npm run pr-ready --

Expect Mode: full. Verdict on a real branch can be NOT READY even when heuristics are clean — Risk/Ship Coach sometimes over-flag docs (for example a README link to fixtures/demo.sh). That is useful coach output to review, not proof of a leaked secret.

After AWS Deploy, call the live API the same way GitHub Actions does:

Terminal window
export PR_READY_API_URL="$(aws cloudformation describe-stacks \
--stack-name PrReadinessCoachStack \
--query "Stacks[0].Outputs[?OutputKey=='ApiUrl'].OutputValue" --output text)"
export PR_READY_API_KEY="$(aws apigateway get-api-key --api-key "$(aws cloudformation describe-stacks \
--stack-name PrReadinessCoachStack \
--query "Stacks[0].Outputs[?OutputKey=='ApiKeyId'].OutputValue" --output text)" \
--include-value --query value --output text)"
npm run pr-ready -- --api --api-url "$PR_READY_API_URL" --api-key "$PR_READY_API_KEY"