Documentation

Quick start

Mergestorm runs a feedback loop on your pull requests: Vortex reviews the diff and posts inline comments; Cyclone can commit fixes from those findings when auto-patch is enabled. Connect both agents on Automation, enable repos and toggles in Settings, then open a PR.

GitHub commands (Vortex)

Trigger a manual review by commenting on a pull request (not a standalone issue):

@mergestorm review

Variants such as @mergestorm[bot] review or @mergestorm please review work as long as the comment mentions the bot and includes the word review.

• Must be a human comment (bot comments are ignored).
• Only fires on newly created comments — editing an old comment does not re-trigger.
• Draft PRs are skipped.
• Vortex reacts with 👀 while the review runs.
• Shows as Mention in your History tab.

Automatic reviews (Vortex)

When Automatically review new PRs and commits is on in Settings, Vortex reviews on every PR open and new push — no command needed. Each review posts inline comments and a GitHub check run named vortex-v1.

History badges: Auto (automatic), Mention (manual @mergestorm review), or Manual (triggered from the dashboard).

Auto-patch (Cyclone)

Cyclone has no @mention command. It runs automatically when auto-patch is enabled and Cyclone is connected. It reacts to:

• Submitted PR reviews with actionable findings (including Vortex reviews).
• Inline review comments (batched when the review is submitted).
• Bot issue comments on PRs from allowed reviewers (Vortex, CodeRabbit, Greptile by default).
• Human fix-request comments, for example: "please fix these comments", "apply the suggested fixes", "please address the review findings".

After a batch completes, Cyclone may post an informational outcome comment such as @mergestorm cyclone-outcome: fixed or cyclone-outcome: dismiss. Check runs appear as cyclone-v1 when enabled.

Include stopreview in a finding body to stop Cyclone from processing that batch.

Dashboard settings

Open Settings to control review scope and automation:

• Review all repositories — when on, every repo in your GitHub App installation is eligible; when off, pick repos on the Repositories tab.
• Automatically review new PRs and commits — when off, Vortex skips reviews until you turn this back on (or use @mergestorm review).
• Automatically apply fixes from MergeStorm reviews — when on, Cyclone commits fixes from review comments to the PR branch. Off by default; requires Cyclone connected on Automation.

Dashboard chat

The chat on the home page and Dashboard → Chat supports three kinds of input:

• Paste code or attach files — runs a code audit in chat. Saved to History as Code audit. Does not count toward your monthly PR review quota.
• Paste a public GitHub PR URL (https://github.com/owner/repo/pull/N) — runs a quick review via Vortex. Counts toward your monthly quota.
• General questions — setup and product help only; chat cannot trigger Cyclone, toggle settings, or review private PRs via link.

The recommended workflow is the GitHub loop (open a PR, let Vortex and Cyclone run on pushes). Chat is supplementary.

Credits & billing

One credit equals one PR review (automatic, mention, or chat quick review via PR link). Code audits in chat are free. The free tier includes 100 reviews per calendar month.

See Pricing for paid tiers and Usage & Billing to track credits and manage your subscription.

Troubleshooting

• Review did not run — check auto-review is on, the repo is enabled, the PR is not a draft, and you have credits remaining.
• Mention ignored — confirm the PR is open (not draft), the comment is new (not an edit), and you used @mergestorm review on the PR itself.
• Cyclone did not patch — connect Cyclone on Automation, turn on auto-patch in Settings, and ensure the review had actionable inline findings (not an approve/all-clear summary).
• Chat PR review failed — the PR must be public and the URL must match github.com/owner/repo/pull/N.

Contact

Questions or feedback: contact@mergestorm.ai