heydeer
Sign in
Get started

Quickstart

Connect HeyDeer to GitHub and get a review of one of your pull requests.

Before you start

  • A GitHub account with write access to the repository you want reviewed.
  • An open pull request in that repository.
  • For an organization, an owner who can install the HeyDeer GitHub App or approve your request.

A new workspace starts on Free. Its first month begins when it is created, with 1,000 credits; later months include 300. Free runs 1 review at a time in each repository and needs no credit card. When credits run out, add credits, wait for the next monthly refresh or choose a paid plan. See Plans and add-on credits.

1. Sign in and choose an account

Sign in with GitHub. Under Choose where your repositories live, select your personal account or organization. If it isn’t listed, select Install on GitHub and choose it there.

2. Add repositories

If HeyDeer asks for repositories, select Add repositories. On GitHub, choose Only select repositories, pick the repositories to review, and confirm. If HeyDeer can already access them, skip this step.

In an organization, GitHub asks an owner to approve unless you are one. See GitHub App and permissions, or Troubleshooting if an account or repository is missing.

When HeyDeer can access your repositories, it asks whether to review pull requests automatically. Keep Review pull requests automatically on and select Continue to review every push, up to 5 times per pull request, or turn it off to review only on request. You can change this anytime; see Automatic reviews.

3. Request a review

Comment @heydeer review on the pull request. You can also start a review from HeyDeer.

alexcommented
@heydeer review
HeyDeer adds 👀 to your comment when it accepts the request, and posts the review when it finishes.

No 👀 or no reply? See Troubleshooting.

4. Read the results on GitHub

HeyDeer posts its findings as review comments and reports the outcome in the HeyDeer Review check. The check’s Details link opens the full report in HeyDeer. See Reading a review.

All checks have passed
HeyDeer Review — Review completed with findings
CI / test — Successful
By default, the check passes even when the review has findings. You can make it block merging later.

To have HeyDeer fix the findings you choose, select Fix with HeyDeer in the review comment. HeyDeer opens a separate PR for you to review and merge; see Fix with HeyDeer.

Next steps

  • Choose when HeyDeer reviews. If automatic reviews are still off, a workspace admin can choose Once per PR or On every push in Workspace settings → Review rules → When to review; see Automatic reviews.
  • Choose a setup for your team: Teams without code review or Teams with human reviewers.
  • Teach HeyDeer your codebase: conventions in AGENTS.md, review guidance in REVIEW.md, and requirements HeyDeer must verify as repository checks. See What HeyDeer reads.