Getting Started

Quickstart

Get your first pull request reviewed by Commitloom in under 5 minutes. No code changes to your repository. No configuration required to start.

Prerequisites

  • A GitHub account with access to at least one repository
  • An open or soon-to-be-opened pull request to test with

Step 1: Install the GitHub App

Go to the Commitloom GitHub App installation page and click Install. You'll be asked to choose which repositories to grant access to.

We recommend starting with one or two repositories. You can expand access later from your GitHub App settings.

Note: Commitloom requests pull_requests: read+write, contents: read, and metadata: read. No write access to code.

Step 2: Create a Commitloom account

Visit commitloom.com/login/signup.html and sign up with your GitHub account. The OAuth flow will link your GitHub identity automatically.

Step 3: Open a pull request

Push a branch and open a PR on any repository where Commitloom is installed. Within 60 seconds of the PR opening, you should see:

  • Inline review comments on the diff, pinned to specific lines
  • The PR description populated with a Commitloom-generated summary

What happens next

Commitloom runs on every subsequent PR in the connected repos. If you want to configure review sensitivity, ignore certain file paths, or define custom patterns, see the Configuration reference.

Next steps