PR comment commands
Comment on a pull request to request a HeyDeer review, pause automatic reviews or start Autopilot. Commands work in every connected repository, whatever its review schedule.
Commands
| Command | What it does |
|---|---|
@heydeer review | Reviews the current commit with the repository’s default depth and feedback scope. With Review only new changes on, it covers what changed since the last review. See Follow-up reviews. |
@heydeer full review | Reviews the whole pull request again. |
@heydeer pause | Stops automatic reviews on this pull request. Queued reviews continue, and you can still request one. |
@heydeer resume | Resumes automatic reviews on this pull request. It doesn’t start a review. |
@heydeer autopilot | Starts Autopilot: HeyDeer fixes what’s open on this pull request, pushes to its branch and reviews each change until it’s ready to merge. |
@heydeer autopilot stop | Stops Autopilot on this pull request. |
Results follow your publishing settings. If HeyDeer can’t run the review, or it fails or is canceled, HeyDeer replies to your comment. Pause and resume get an immediate reply. Autopilot commands get a reaction, and Autopilot’s own comment shows what it’s doing.
A requested review is charged like any other review; see How credits work. It doesn’t count toward Maximum automatic reviews per PR.
While a review of the same commit is queued or in progress, a comment with only @heydeer review joins that review instead of starting another, and uses no extra credits. Your comment gets the usual 👀 reaction, and the review reports its result as usual. It doesn’t read comments posted after it was requested; to include them, request a review again after it finishes.
How HeyDeer reads a comment
- Include a command anywhere in a new PR conversation comment or inline review comment. A command in an inline comment reviews the pull request as usual, not just those lines.
- Write the command as plain text, not in code, a quote or an HTML comment. HeyDeer ignores edited comments and comments from bots.
- If a comment contains more than one command, HeyDeer runs only the first.
- To choose the depth or feedback scope, start the review from HeyDeer.
Any other mention of @heydeer asks HeyDeer to answer or do something. See Mention @heydeer.
If a command gets no 👀 or reply, see Troubleshooting.
Add missing context
When a review asks a question under Needs clarification, or a finding misses something you know, explain it in a new comment. Include @heydeer review in the same comment to request a review with your explanation.
Each request with an explanation runs a new review that reads the latest discussion, even if the code hasn’t changed. A reply without a command doesn’t start a review.
To decide not to act on a finding, see Declining a finding.
Who can run commands
The Who can request reviews setting controls who can run commands: Workspace settings → Review rules → Manual review access, or a repository’s Review rules.
| Option | Who can request reviews |
|---|---|
| Anyone with repository write access | Default. Anyone with write, maintain or admin access. |
| Selected users or teams with write access | People listed under GitHub usernames or Teams who also have write access. |
The same rule applies to reviews started from HeyDeer and from the check’s buttons. Automatic review filters don’t limit requested reviews.
Start a review from HeyDeer
- In HeyDeer, open Reviews and select Start a review.
- Choose the Repository and Pull request. You can pick only repositories where you have write access.
- To change the Review depth or Feedback scope, open Review options. Both start at the repository’s defaults.
- Select Run review.