CLI
Install dependencies in the upstream product repo and run:
npm installnpm run pr-ready -- --helpCommon modes
Section titled “Common modes”- Full local analysis (git repo + Bedrock via your AWS credentials):
npm run pr-ready -- - Heuristic only (no Bedrock):
npm run pr-ready -- --local - Fixture / directory mode (no git; combine with
--localfor demos):npm run pr-ready -- --local --path fixtures/demo-app/not-ready - JSON output (report on stdout, progress on stderr):
npm run pr-ready -- --local --path fixtures/demo-app/ready --json - Remote API:
npm run pr-ready -- --api --api-url "$PR_READY_API_URL" --api-key "$PR_READY_API_KEY" - Create a PR from the draft (after a full-mode run; requires
ghauth):npm run pr-ready -- --apply-draftOptional:--draft-base main(defaultmain). Uses Ship CoachdraftPrTitle/ composed body. Does not auto-open a PR unless you pass--apply-draft.
Exit codes
Section titled “Exit codes”| Code | Meaning |
|---|---|
0 | READY or READY WITH WARNINGS |
1 | NOT READY |
2 | Usage / environment / API transport errors |
Region and credentials
Section titled “Region and credentials”Full mode needs AWS_REGION (or AWS_DEFAULT_REGION) and credentials that can call Bedrock in that region. Without a region, the CLI degrades with Region is missing.
Optional project rules live in root ready.yml.