Mention @heydeer
Mention @heydeer wherever you write on GitHub to ask a question or hand HeyDeer a job. HeyDeer reads the conversation, works in a sandbox and answers where you asked.
What you can ask
| Comment | What HeyDeer does |
|---|---|
@heydeer what does this function do? | Reads the code and explains it in a reply. |
@heydeer fix the first issue and open an issue for the second | Changes the code, opens a pull request with the fix and opens the issue. |
@heydeer do the latest Next.js docs recommend this? | Checks the documentation on the web and answers with what it found. |
@heydeer review this again | Starts a review, like @heydeer review. |
Replies use the language you write in. Commits, pull requests and issues use the repository’s review language.
Where to mention HeyDeer
- A comment on a pull request or an issue.
- An inline review comment.
- The summary of a review you submit.
- The description of a new pull request or issue.
HeyDeer ignores edits, comments from bots, and mentions in code, quotes or HTML comments. PR comment commands such as @heydeer review run right away instead.
While Autopilot runs on a pull request, mentions there go to Autopilot, which answers them in its rounds.
What HeyDeer can do
HeyDeer acts for you in the repository where you mentioned it, and only in ways you could act yourself. It can clone the code, resolve merge conflicts, push commits, open, update and merge pull requests, comment, reply in review threads, open and update issues, and start reviews. Branch protection and other GitHub rules apply as they do to anyone.
- Code changes go to a new pull request. On a pull request HeyDeer opened, HeyDeer pushes to its branch. Ask for something else, such as pushing to your branch, and HeyDeer does that instead.
- Pushes only add commits: HeyDeer never overwrites work on a branch. Code from a fork reaches the repository only through a person: HeyDeer never merges a pull request from a fork or pushes a fork’s commits, and it can’t push to a fork.
- Before changing code, HeyDeer reads repository guidance such as AGENTS.md, and it can install dependencies and run your tests. See Security for how code runs in isolation.
Who can ask
Anyone with write access to the repository. HeyDeer checks again before each action, so a request stops if that access is removed. Others get a short reply instead.
Progress and credits
HeyDeer adds 👀 to your comment when it starts and removes it when it finishes. It answers in a reply, or says so if the request failed or was canceled. Each request appears under Tasks in HeyDeer with its progress, results and credits, and you can cancel it there.
A request uses workspace credits for the work it does, in public repositories too. See How credits work.