Skip to content

README.md

Latest commit

 

History

History
118 lines (81 loc) · 3.59 KB

README.md

File metadata and controls

118 lines (81 loc) · 3.59 KB

PR Review with Cypilot

This project uses Cypilot for AI-powered PR reviews and status reports.

Quick Start

Cyber Ware has integrated Cypilot automation for PR review assistance. Use any supported agent (Windsurf, Cursor, Claude, Copilot) — each has thin stubs that redirect to the canonical workflows via /cypilot-pr-review and /cypilot-pr-status commands.

You can use the following prompts in your IDE to review PRs or get status:

cypilot list all open PRs cypilot preview PR 100 /cypilot-pr-review 100 cypilot preview ALL PRs cypilot get status for PR 300 /cypilot-pr-status 300

See the .prs/{ID}/ folder for the review results:

review.md
status.md
meta.json
diff.patch
review_comments.json
review_threads.json

Configuration

Configure GitHub API token

The pr.py script uses the GitHub CLI (gh) to fetch PR data. You need gh installed and authenticated:

  1. Install gh

    # macOS
brew install gh

# Linux (Debian/Ubuntu)
sudo apt install gh

# Other: https://github.com/cli/cli#installation

  2. Authenticate with GitHub

    gh auth login

    Follow the interactive prompts. Choose:

    • GitHub.com (or your GitHub Enterprise host)
    • HTTPS as the preferred protocol
    • Login with a web browser (recommended) or paste a personal access token

    The token needs these scopes: repo, read:org (for private repos).

  3. Verify authentication

    gh auth status

    You should see Logged in to GitHub.com as <your-username>.

  4. (Optional) Use a personal access token directly

    If you prefer not to use the browser flow:

    # Create a token at: https://github.com/settings/tokens
# Required scopes: repo, read:org
gh auth login --with-token < token.txt

    Or set the GH_TOKEN / GITHUB_TOKEN environment variable:

    export GH_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Workflow Reference

  1. Fetch PR metadata using .cypilot/config/kits/sdlc/scripts/pr.py CLI tool
  2. Select the most appropriate review prompt (code, design, ADR, or PRD)
  3. Analyze changes against the corresponding checklist
  4. Write a structured review to .prs/{ID}/review.md or status report to .prs/{ID}/status.md

Excluding PRs

Edit .prs/config.yaml → exclude_prs to skip specific PRs during bulk operations, like review ALL

Templates

Report templates define the expected output format for reviews and status reports.

Template Canonical location Docs copy
Code review .cypilot/config/kits/sdlc/artifacts/PR-CODE-REVIEW-TEMPLATE/template.md docs/pr-review/code-review-template.md
Status report .cypilot/config/kits/sdlc/artifacts/PR-STATUS-REPORT-TEMPLATE/template.md docs/pr-review/status-report-template.md

The canonical templates live inside .cypilot/config/kits/sdlc/artifacts/. Kit updates via cpt kit update will show a diff for any template changes.

Review Prompts

Each review type has a dedicated prompt file and checklist:

Review type Prompt Checklist
Code Review .cypilot/config/kits/sdlc/scripts/prompts/pr/code-review.md docs/checklists/CODING.md
Design Review .cypilot/config/kits/sdlc/scripts/prompts/pr/design-review.md docs/checklists/DESIGN.md
ADR Review .cypilot/config/kits/sdlc/scripts/prompts/pr/adr-review.md docs/checklists/ADR.md
PRD Review .cypilot/config/kits/sdlc/scripts/prompts/pr/prd-review.md docs/checklists/PRD.md