Getting started

This guide walks you through installing the Pullminder GitHub App, triggering your first analysis, and reading the results. The whole process takes under five minutes.

1. Install the GitHub App

Go to github.com/apps/pullminder and click Install. Select the organization you want to monitor, then choose which repositories Pullminder should have access to.

Tip

Start with a single active repository so you can see results quickly. You can add more repositories at any time from your GitHub organization settings.

Once installed, Pullminder begins listening for pull request events on the selected repositories. No further configuration is required.

2. Open a pull request

Create or update a pull request on one of the repositories you selected. Pullminder picks up the webhook automatically and begins analysis.

Analysis typically completes within 30 seconds. For very large diffs (1,000+ changed files), it may take up to a minute.

3. Review the PR comment

When analysis finishes, Pullminder posts a comment on the pull request. The comment includes:

• Risk score — a number from 0 to 100 indicating overall PR risk
• Findings summary — a count of issues grouped by severity (critical, high, medium, low)
• Top findings — the highest-severity issues with file locations and descriptions
• Reviewer brief — a short narrative explaining what changed and where to focus the review

Note

If the risk score is 0 and there are no findings, Pullminder posts a short confirmation comment instead of the full brief. This keeps low-risk PRs clean.

4. View analytics in the dashboard

Visit app.pullminder.com and sign in with your GitHub account. The dashboard shows:

• Risk score trends across your repositories
• Most common finding categories
• Per-repository and per-author breakdowns
• Historical analysis results for every PR

5. (Optional) Install the CLI

The Pullminder CLI runs the same analyzers locally, so you can check a diff before pushing.

brew install pullminder/tap/pullminder

Then run a check against your current branch:

pullminder check

The CLI compares your branch against the default branch and prints findings to the terminal. It works offline and does not require a Pullminder account.

Tip

Add pullminder check as a pre-push Git hook or a CI step to catch issues before they reach code review. See the CI integration guide for details.

Next steps

• Learn how risk scoring works to understand what drives your scores
• Browse rule packs to customize which checks Pullminder runs
• Set up CI integration to enforce risk thresholds in your pipeline