Commands

Mention @rubberduck in any PR comment followed by a command below. Commands act on PR comments only; plain issue comments are ignored. See Connect a Repository for setup.

<finding> is a finding name from the review, e.g. SQL_INJECTION or HARDCODED_SECRET (a file path also works). In a reply under one of the bot's comments on the code, leave it out: explain, verify, confirm, fix and dismiss then act on that finding.

A missing update, a move or a duplicate isn't a finding: use impact <symbol> for those. <symbol> is a function or class name from your changes. Most commands have aliases, e.g. verify = false-positive = fp.

Note: the first check of a commit can take a minute while RubberDuck analyses the repo.

When a finding appears in more than one file

If the PR has the same finding type in more than one file, @rubberduck explain SQL_INJECTION picks the first one, and the reply says where else that type appears. To pick a specific one, add the file name after the finding name:

@rubberduck explain SQL_INJECTION bp_rooms.py @rubberduck explain SQL_INJECTION src/db.py:42 @rubberduck explain src/db.py

A short name like db.py is enough, and path:line works too. You can also give just the file, without a finding name. This works the same way for explain, verify, fix, dismiss and issue.

  • If the name matches several files, the bot lists them.
  • If the file has several finding types, the bot lists them with the exact command to use.
  • If the file has no findings, the bot says so.

In a reply under one of the bot's comments on the code, none of this is needed: the reply already targets that finding.

Commands: review & status

CommandPurpose
@rubberduck reviewRe-run the review on the latest commit
@rubberduck summarizeA short summary of the current findings
@rubberduck existingFindings already in the repo before this PR
@rubberduck statusHow the current review is progressing
@rubberduck specDoes this PR satisfy its linked issue's requirements

GitHub's Re-run checks on the RubberDuck check also starts a fresh review.

Commands: verify a finding

CommandPurpose
@rubberduck verify <finding>Re-check a finding and say whether it's real
@rubberduck explain <finding>Explain a specific finding in plain words, with the fix
@rubberduck confirm <finding>After a fix, check whether the finding is gone

Zero-effort variant: you usually don't need confirm. Applying a fix suggestion pushes a commit, which re-runs the review and automatically posts "Fix confirmed" once the finding is gone.

Commands: fix

CommandPurpose
@rubberduck fix <finding>Propose a fix for one finding, verified first when the check can run (collaborators)
@rubberduck fix-in-ide <finding>A paste-ready prompt for Claude Code / Cursor

Commands: understand the change

CommandPurpose
@rubberduck impact <symbol>Change impact of a function or class: what it calls and who calls it
@rubberduck diagramA deep logic diagram of what changed, with data flow and control flow

Commands: author help

CommandPurpose
@rubberduck testGenerate tests for the changes, using the code graph when available
@rubberduck issue <finding>Open a tracking issue from a finding (collaborators)

Commands: rules & control

CommandPurpose
@rubberduck guardCheck this PR against the repo's custom rules (.rubberduck.yml)
@rubberduck dismiss <finding> [reason]Mark a false positive so it stops being raised (collaborators)
@rubberduck undismiss <finding>Restore a previously dismissed finding (collaborators)
@rubberduck learningsList what the team has dismissed on this repo
@rubberduck configShow the current settings for this repo
@rubberduck pause / resumeStop or restart auto-review of new commits on this PR (collaborators)
@rubberduck helpShow this list

RubberDuck remembers what your team dismisses, per repository, so it stops re-raising the same false positives on future reviews. dismiss remembers the finding per repo (by type and file, so it survives new commits), and later reviews stop raising it. learnings lists them and undismiss brings one back.

The .rubberduck.yml format

Teams declare their own rules in a .rubberduck.yml file at the repo root. guard checks the rules on demand, and every review also checks them and adds a "Custom rules" section to the review comment. Each rule has an id, a forbid pattern (regex or plain text), optional path globs, a message, and a severity:

rules: - id: no-hardcoded-key forbid: "API_KEY\s*=\s*[\"']" paths: ["*.py"] message: Never hard-code API keys - load them from the environment. severity: high - id: no-md5 forbid: "hashlib.md5" paths: ["*.py"] message: MD5 is insecure - use hashlib.sha256 instead. severity: medium

A missing or malformed file simply yields no rules; it never breaks a review. .yaml and .json work too.