Skip to main content

​
Slash commands

Slash commands let collaborators trigger Qodex actions from the PR comment thread. They are useful when you want to re-run a review after a fix, pick up a new .qodex.yaml policy, or see the current command list without leaving GitHub.

​
How commands work

Qodex listens for comments on every linked repo’s PRs. When a comment starts with @qodex <verb> (blockquote and list markers are stripped first), Qodex runs the verb. Bot comments are ignored. Comments by users without write access to the repo get a -1 reaction and a silent skip. Qodex acknowledges every recognized command with an eyes reaction on the source comment, then runs the verb.

​
@qodex review

Re-runs a review against the current head commit of the PR. Where to use it: Top-level PR comment thread. Permission required: Write access or higher on the repo. The PR author is not automatically eligible; an external contributor cannot self-trigger a review. Example: 
@qodex review
What happens:
  1. Qodex reacts eyes to your comment.
  2. Qodex re-fetches the PR’s current head SHA so a force-push between events is handled correctly.
  3. For each Qodex project that linked this repo, Qodex starts a fresh review (marked manual).
  4. Each review runs in the background; the standard flow applies (walkthrough comment, inline findings, probes, Check Run).
A reviewer can run @qodex review after pushing a fix to confirm the bug is resolved, after .qodex.yaml changes to pick up new policy, or after touching the preview environment so probes succeed.

​
@qodex help

Replies with the verb cheat-sheet. Where to use it: Top-level PR comment thread. Permission required: Same as @qodex review. Help is gated to write+ to keep external contributors from spamming the thread. Example: 
@qodex help
What happens:
  1. Qodex reacts eyes to your comment.
  2. Qodex posts a comment on the PR with the current command list and rules.
The same help body is sent when Qodex sees @qodex <unknown-verb>, so a typo gets the cheat-sheet instead of silence.

​
Parser rules

  • The first @qodex <verb> token on a line wins. A comment with two commands runs the first one.
  • Blockquote (> @qodex review) and list (- @qodex review, * @qodex review) prefixes are stripped before matching, so editing a quoted thread still triggers.
  • Verbs are case-insensitive.
  • Arguments after the verb are split on whitespace. Resolution verbs (on the roadmap) will use the first argument as a finding id.

​
Command summary

CommandPermissionWhat it does
@qodex reviewWrite+Re-run review against the current head commit.
@qodex helpWrite+Reply with this cheat-sheet.

​
On the roadmap

The following verbs are reserved and will surface in @qodex help once they ship:
  • @qodex resolve <finding-id> marks a finding resolved on the current PR. Trains the per-project filter to not re-raise the same shape on future PRs.
  • @qodex false-positive <finding-id> marks a finding as a false positive. Trains the filter more aggressively than resolve.
  • @qodex wontfix <finding-id> acknowledges the finding without training the filter, so future PRs still surface it.
  • @qodex pause pauses Qodex review on this PR until @qodex resume.

How a review fires

Inline findings

.qodex.yaml reference

Troubleshooting