{"id":50872898,"url":"https://github.com/yuanzitech/reviewpack","last_synced_at":"2026-06-15T07:01:18.137Z","repository":{"id":362206875,"uuid":"1256857289","full_name":"Yuanzitech/reviewpack","owner":"Yuanzitech","description":"Privacy-first context packs for AI-assisted pull request review.","archived":false,"fork":false,"pushed_at":"2026-06-15T05:03:54.000Z","size":400,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-15T05:05:16.257Z","etag":null,"topics":["ai-review","cli","code-review","codex","developer-tools","github-actions","oss-maintainers","privacy-first","pull-request","python"],"latest_commit_sha":null,"homepage":"https://github.com/Yuanzitech/reviewpack","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yuanzitech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-02T06:32:09.000Z","updated_at":"2026-06-15T05:01:04.000Z","dependencies_parsed_at":"2026-06-15T05:03:08.583Z","dependency_job_id":null,"html_url":"https://github.com/Yuanzitech/reviewpack","commit_stats":null,"previous_names":["yuanzitech/reviewpack"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/Yuanzitech/reviewpack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yuanzitech%2Freviewpack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yuanzitech%2Freviewpack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yuanzitech%2Freviewpack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yuanzitech%2Freviewpack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yuanzitech","download_url":"https://codeload.github.com/Yuanzitech/reviewpack/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yuanzitech%2Freviewpack/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34351451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-review","cli","code-review","codex","developer-tools","github-actions","oss-maintainers","privacy-first","pull-request","python"],"created_at":"2026-06-15T07:00:23.596Z","updated_at":"2026-06-15T07:01:18.111Z","avatar_url":"https://github.com/Yuanzitech.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reviewpack\n\nPrivacy-first context packs for AI-assisted pull request review.\n\n## Language\n\n- English: README.md\n- 简体中文: README.zh-CN.md\n\nReviewpack helps open-source maintainers and engineering teams prepare structured, reusable context before reviewing a pull request with a human reviewer or an AI coding assistant.\n\nIt is not another noisy AI reviewer. Reviewpack is a context layer: it collects pull request metadata, changed files, test signals, documentation signals, dependency signals, risk indicators, release note hints, reviewer checklist items, AI handoff instructions, and review focus areas into a clear review pack.\n\n## Quick Start\n\nInstall Reviewpack:\n\n    pip install reviewpack\n\nGenerate a demo review pack:\n\n    reviewpack demo\n\nReviewpack writes output to `.reviewpack/` by default.\n\nShow AI handoff instructions:\n\n    reviewpack handoff\n\nIf your AI assistant can read files in your workspace, ask:\n\n    Please read .reviewpack/ai-handoff.md and follow it.\n\nIf your AI assistant cannot read local files but can accept one uploaded file, upload:\n\n    .reviewpack/ai-context.md\n\nIf only copy and paste is available, use:\n\n    .reviewpack/ai-review-prompt.md\n\n## Why Reviewpack?\n\nAI coding tools are powerful, but review quality depends heavily on context.\n\nDirect AI review often starts from raw diffs. That can miss important project-level signals:\n\n- Which files are high risk?\n- Were tests updated?\n- Were docs updated?\n- Did dependencies change?\n- Is the pull request too large?\n- Does the change affect CI, configuration, or release behavior?\n- Should this PR be mentioned in release notes?\n- What should a maintainer focus on first?\n\nReviewpack prepares that context before review starts.\n\n## Common workflows\n\n### First-time demo\n\n    reviewpack demo\n\n### GitHub pull request\n\n    reviewpack github https://github.com/owner/repo/pull/123\n\nGitHub mode may collect PR metadata such as state, draft status, base/head branch names, commit count, labels, changed file status, and changed file statistics.\n\nGitHub mode does not collect raw diffs or full source code by default.\n\nPublic repositories usually do not require a token.\n\nPrivate repositories or rate-limited usage may require:\n\n    REVIEWPACK_GITHUB_TOKEN=YOUR_TOKEN reviewpack github https://github.com/owner/repo/pull/123\n\n### Local development\n\n    reviewpack local\n\nBy default, local mode compares:\n\n    main...HEAD\n\n### Fixture input\n\n    reviewpack from-fixture simple-pr.json\n\nThe fixture file must already exist.\n\nFor first-time usage, prefer:\n\n    reviewpack demo\n\n### Command guide\n\n    reviewpack guide\n\nFor CLI options:\n\n    reviewpack --help\n    reviewpack github --help\n    reviewpack local --help\n\n## Configuration\n\nReviewpack can be configured with:\n\n    .reviewpack.yml\n\nConfiguration is optional.\n\nIf no configuration file is present, Reviewpack uses privacy-first defaults.\n\nExample:\n\n    outputs:\n      ai_context: true\n      ai_handoff: true\n      reviewer_checklist: true\n      release_note_hints: true\n\n    risk:\n      large_pr_files: 20\n      large_pr_lines: 500\n      high_risk_paths:\n        - .github/workflows/\n        - pyproject.toml\n\n    paths:\n      docs:\n        - docs/\n        - README.md\n      tests:\n        - tests/\n\nUse a custom config file:\n\n    reviewpack demo --config path/to/reviewpack.yml\n\nSee:\n\n    docs/configuration.md\n    docs/config-schema.md\n    examples/.reviewpack.yml\n\n## GitHub Action\n\nReviewpack can run in GitHub Actions and upload the generated review pack as a workflow artifact.\n\nExample workflow:\n\n    name: Reviewpack\n\n    on:\n      pull_request:\n\n    jobs:\n      reviewpack:\n        runs-on: ubuntu-latest\n\n        permissions:\n          contents: read\n          pull-requests: read\n\n        steps:\n          - name: Check out repository\n            uses: actions/checkout@v4\n\n          - name: Run Reviewpack\n            uses: Yuanzitech/reviewpack@v0.6.1\n            with:\n              mode: github\n              pr-url: ${{ github.event.pull_request.html_url }}\n              github-token: ${{ github.token }}\n\nBy default, the action uploads a workflow artifact named:\n\n    reviewpack-output\n\nAfter the workflow finishes, download the artifact from the GitHub Actions run.\n\nRecommended files:\n\n    pr-summary.md\n    reviewer-checklist.md\n    risk-checklist.md\n    release-note-hints.md\n    ai-handoff.md\n    ai-context.md\n\nThe GitHub Action does not post PR comments or call AI providers by default.\n\nOptional PR comment mode is available through:\n\n    comment: \"true\"\n\nComment mode posts or updates a short pointer comment. It does not paste the full review pack into the pull request.\n\nComment mode requires:\n\n    permissions:\n      contents: read\n      pull-requests: write\n\nSee:\n\n    docs/github-action.md\n\nExamples:\n\n    examples/github-action.yml\n    examples/github-action-local.yml\n    examples/github-action-comment.yml\n\n## What Reviewpack generates\n\nA review pack may include:\n\n- PR summary\n- Changed file overview\n- Risk checklist\n- Reviewer checklist\n- Release note hints\n- Suggested review focus\n- AI-ready review prompt\n- AI handoff instructions\n- AI context bundle\n- AI input preview\n- Machine-readable JSON output\n\nExample output directory:\n\n    .reviewpack/pr-summary.md\n    .reviewpack/risk-checklist.md\n    .reviewpack/reviewer-checklist.md\n    .reviewpack/release-note-hints.md\n    .reviewpack/ai-review-prompt.md\n    .reviewpack/ai-handoff.md\n    .reviewpack/ai-context.md\n    .reviewpack/ai-input-preview.md\n    .reviewpack/reviewpack.json\n\nOutput artifact details:\n\n    docs/output-artifacts.md\n    docs/artifact-contract.md\n\nJSON output details:\n\n    docs/json-output.md\n    docs/integration-json.md\n\nDraft JSON schema:\n\n    schemas/reviewpack-result.schema.json\n\nExample output files:\n\n    examples/output/\n\n## AI handoff\n\nReviewpack does not call AI providers by default.\n\nInstead, it generates local artifacts that can be inspected and shared intentionally.\n\nIf your AI assistant can read files in your workspace, ask:\n\n    Please read .reviewpack/ai-handoff.md and follow it.\n\nIf your AI assistant cannot read local files but can accept one uploaded file, upload:\n\n    .reviewpack/ai-context.md\n\nIf only copy and paste is available, use:\n\n    .reviewpack/ai-review-prompt.md\n\nSee:\n\n    docs/ai-handoff.md\n\n## Privacy-first by default\n\nReviewpack runs locally by default for demo, fixture, and local git workflows.\n\nBy default, it does not send code, diffs, commit messages, environment variables, repository secrets, or terminal information to any external AI service.\n\nGitHub mode uses network access only to fetch explicitly requested pull request metadata and changed file statistics from the GitHub API.\n\nGitHub mode may include PR metadata such as labels, base/head branch names, commit count, draft status, and changed file status in generated local artifacts.\n\nThe GitHub Action integration generates workflow-local artifacts and does not call AI providers.\n\nCurrent privacy-oriented features include:\n\n- Local demo mode\n- Local fixture mode\n- Local git diff mode\n- GitHub PR metadata mode\n- GitHub Action artifact mode\n- Optional short PR comment mode\n- Configurable output generation\n- Configurable risk thresholds\n- Configurable high-risk paths\n- Configurable path classification\n- AI-ready prompt generation without AI calls\n- AI handoff without AI calls\n- AI context bundle without AI calls\n- AI input preview without AI calls\n- Release note hints without AI calls\n- Reviewer checklist without AI calls\n- Best-effort secret redaction for preview text\n- No raw diff upload by default\n- No full source code upload by default\n- No commit message upload by default\n- No PR comments by default\n\n## Documentation\n\n- Project status: docs/status.md\n- Installation guide: docs/installation.md\n- Commands guide: docs/commands.md\n- Configuration guide: docs/configuration.md\n- Configuration schema: docs/config-schema.md\n- Output artifacts: docs/output-artifacts.md\n- Artifact contract: docs/artifact-contract.md\n- JSON output: docs/json-output.md\n- JSON integration guide: docs/integration-json.md\n- v1.0 readiness: docs/v1-readiness.md\n- Usage guide: docs/usage.md\n- Privacy model: docs/privacy.md\n- Design notes: docs/design.md\n- Local git diff mode: docs/local-git.md\n- GitHub support: docs/github.md\n- GitHub Action: docs/github-action.md\n- AI handoff: docs/ai-handoff.md\n- AI input preview: docs/ai-preview.md\n- Release note hints: docs/release-note-hints.md\n- Reviewer checklist: docs/reviewer-checklist.md\n- Integration principles: docs/integrations.md\n- Roadmap: docs/roadmap.md\n- Release checklist: docs/release-checklist.md\n- Examples guide: examples/README.md\n\n## Core idea\n\nDirect AI review:\n\n    PR diff -\u003e AI -\u003e review comments\n\nReviewpack workflow:\n\n    PR data -\u003e local analysis -\u003e structured context pack -\u003e human reviewer or AI assistant\n\n## Current status\n\nReviewpack is a PyPI-published early product.\n\nIt currently supports:\n\n- PyPI installation\n- Demo mode\n- Local fixture input\n- Local git diff input\n- Enriched GitHub PR metadata input\n- GitHub Action artifact output\n- Optional short PR comment mode\n- Structured Markdown and JSON output\n- Draft JSON schema for `reviewpack.json`\n- JSON integration guidance\n- Configurable rules and outputs\n- Improved review artifacts\n- Reviewer checklist\n- Release note hints\n- AI handoff\n- AI context bundle\n- Optional AI input preview generation\n- Secret-like value redaction in preview text\n- No AI calls by default\n\nRecommended first-run workflow:\n\n    pip install reviewpack\n    reviewpack demo\n    reviewpack handoff\n\nFor a detailed status overview, see:\n\n    docs/status.md\n\n## Roadmap\n\nNear-term roadmap:\n\n- v0.7.x: Configuration and artifact contract refinement\n- v0.8.x: GitHub workflow validation\n- v0.9.x: Stabilization before 1.0\n- v1.0.0: Stable CLI and artifact contract\n\nDetailed roadmap:\n\n    docs/roadmap.md\n\nv1.0 readiness checklist:\n\n    docs/v1-readiness.md\n\n## Non-goals\n\nReviewpack does not aim to:\n\n- Automatically approve pull requests\n- Automatically merge pull requests\n- Replace human maintainers\n- Spam line-by-line comments\n- Upload code by default\n- Require AI to be useful\n\n## Design principles\n\n1. Local-first\n2. Privacy-first\n3. AI-optional\n4. Human-readable\n5. Machine-readable\n6. Maintainer-controlled\n7. Tool-agnostic\n\nReviewpack should work with human reviewers, Codex, Cursor, Cline, OpenCode, Claude Code, GitHub Copilot, and other coding assistants.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuanzitech%2Freviewpack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuanzitech%2Freviewpack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuanzitech%2Freviewpack/lists"}