Quickstart

This guide gets Audit Bench Ai reviewing pull requests on a GitHub repository. On GitLab or Bitbucket, follow GitLab or Bitbucket instead; the steps after connecting are the same.

Set up#

1. 1

   Create an account

   Sign up with GitHub, Google or email. Every account starts on the Free plan; no card needed.

2. 2

   Connect your GitHub account

   In the app, open Repository scan and connect GitHub. Audit Bench Ai uses this to know which GitHub account and organizations are yours.

3. 3

   Install the GitHub App

   On the same page, the Audit Bench Ai GitHub App card has an Install on GitHub button. Choose your personal account or an organization, then All repositories or the ones you pick. GitHub sends you back to the app when it’s done.

   Installing on an organization needs an organization owner, or an admin who can approve the request on GitHub.

4. 4

   Open a pull request

   Open any non-draft pull request on a repository the App can see, or push to an existing one. An Audit Bench Ai check appears straight away showing “Reviewing…”.

5. 5

   Read the review

   In one to two minutes you’ll have a summary comment, inline comments on the lines that matter and a check result. Reading a review explains each part.

Make the most of it#

• Write down your conventions. Add an auditbench.md file to the repository, or rules on the Rules page. See Rules and strictness.
• Talk back. Reply to a finding you disagree with; it rechecks the code. React 👍 or 👎 so it learns what your team cares about. See Replies and reactions.
• Gate merges. Make the check required so blocking issues can’t be merged. See Make it a required check.
• Catch problems earlier. Run the same review in your editor or terminal with the VS Code extension or the CLI.

If no review appears#

Check that the pull request isn’t a draft, that the App is installed on that repository, and that automatic review is switched on for the installation. Troubleshooting covers the rest.