Skip to content

Getting Started

Jump to bottom
amirbena edited this page Sep 17, 2026 · 3 revisions

Getting Started

Practical first steps to use either Skill. For the "which one do I want" question, see Choosing-a-Review-Skill first if you're unsure.

1. Package the Skill you need

Both Skills live in one repository but are packaged as separate, standalone archives. From the repository root:

./scripts/package-skills.sh local    # -> dist/local-code-review-skill.zip
./scripts/package-skills.sh github   # -> dist/github-pr-review-skill.zip
./scripts/package-skills.sh all      # both

PowerShell: ./scripts/package-skills.ps1 <local|github|all>. See Packaging-and-Portability for what actually goes into an archive.

2. Install it into your runtime

Unzip the archive directly into your runtime's Skill directory — each archive already keeps SKILL.md at its own root:

  • Claude Code: .claude/skills/<name>/
  • generic Agent Skills runtimes: .agents/skills/<name>/
  • Cursor: .cursor/skills/<name>/
  • OpenCode: .opencode/skills/<name>/

3. Invoke it in plain language

Neither Skill needs a special command syntax.

local-code-review — opt-in, every single time (see Local-Code-Review-Guide):

review my local changes before I push

github-pr-review — takes a PR URL or number (see GitHub-PR-Review-Guide):

review PR https://github.com/acme/app/pull/812

Missing optional context (a ticket, an ADR, a PR reference) never fails or degrades either review — see Review-Context-and-Existing-Evidence.

If you asked either Skill to run the repository's own tests/lint as evidence, check the report's Validation section to see whether it actually ran and on which backend (sandbox or trusted-host) — see Feature-Runtime-Validation-Evidence.

Where to go next

Wiki Page Map

Page What it covers
Home Wiki entry point: what the two Skills are and where to go next.
Getting-Started First steps to package and run either Skill.
Choosing-a-Review-Skill How to decide between local-code-review and github-pr-review.
How-the-Review-Model-Works Concept-level walkthrough of the review pipeline shared by both Skills.
Architecture-Overview Component-level map of how the repository's pieces fit together.
Specialist-Depth-Review When and how a review goes deeper than its base pass.
Local-Code-Review-Guide Usage guide for reviewing local, not-yet-PR'd Git changes.
GitHub-PR-Review-Guide Usage guide for reviewing an existing GitHub Pull Request.
Review-Context-and-Existing-Evidence How optional requirements/context and prior review evidence are supplied.
Feature-Pages Index of per-feature capability pages and their shared template.
Feature-Delta-Re-Review How a re-review scopes itself to only what changed since the last pass.
Feature-GitHub-Publication-and-Authorization What a PR review publishes to GitHub and under what authority.
Feature-Human-Style-Review-Output The senior-engineer-voice prose summary output option.
Feature-Requirement-Coverage How supplied requirements are checked and reported as covered or not.
Feature-Runtime-Validation-Evidence How a review can execute commands or reproductions as evidence.
Severity-and-Decision-Model The P0/P1/P2 severity levels and how the merge decision is derived.
Packaging-and-Portability How the Skills go from source repository to a standalone archive.
Development-Workflow Contributor guide for working on this repository itself.
Benchmark-Testing Orientation to this repository's own review-quality benchmark pipeline.
Repository-Documentation-Map Where each concern's canonical, authoritative source lives.
AI-Code-Review-Landscape Neutral snapshot comparing this project against other AI code-review products.
FAQ Short, practical answers to common questions.

Clone this wiki locally