Commands
Documentation Index
Fetch the complete documentation index at: https://docs.sourcery.ai/llms.txt
Use this file to discover all available pages before exploring further.
You drive Sourcery from pull request comments. Mention @sourcery-ai followed by a command, or reply in a thread to chat. The handle is the same on GitHub and GitLab, and variants such as @sourceryai also work. You can also run a command by adding a label.
Commands
Section titled “Commands”Post the handle and the command as their own comment, for example @sourcery-ai review.
| Command | What it does |
|---|---|
review | Runs a full review on demand and resets the per-pull-request re-review counter. |
summary | Regenerates the summary in the pull request description. |
guide | Regenerates the reviewer’s guide comment. |
title | Regenerates the pull request title. |
resolve | Resolves Sourcery’s open review comments on the pull request. |
dismiss | Dismisses the Sourcery review status check. |
create issue | Creates a GitHub issue from a review comment. Works only as a reply inside a review comment thread (GitHub only). |
Labels
Section titled “Labels”You can run the same commands by adding a label to the pull request. The label is named sourcery- followed by the command: sourcery-review, sourcery-summary, sourcery-guide, sourcery-title, sourcery-resolve, sourcery-dismiss. Create the label in your repository the first time you want to use it.
Sourcery removes the label once the command finishes, whether it succeeded or not. Add the label again to run the command again.
Anything that isn’t a command becomes chat. Reply in a thread Sourcery started to ask a follow-up question, and Sourcery answers in the same thread. Sourcery reads a top-level pull request comment as chat only when it mentions @sourcery-ai. It ignores comments from other bots.
@sourcery-ai review resets the per-pull-request re-review counter and runs a fresh full review. See re-reviews for what the counter controls.