PerfCopilot
Get started
HomeDocs
Documentation

Everything you need to write a fair review.

From your first connection to a sealed, delivered review. Set up PerfCopilot, connect your tools, and generate your first cited draft.

Connect GitHub

Pulls pull requests, code reviews, commits, and review comments per employee.

Prerequisites

  • GitHub organization Owner role (only an org owner can install the PerfCopilot GitHub App for the whole org)
  • OR, for the per-employee path, each employee can connect their personal GitHub account themselves; no org-side action required
  • A PerfCopilot admin account (the Connect button is only visible to admins)

1. Generate credentials in GitHub

The manual connect path uses a Personal Access Token plus your GitHub Org slug. There is also an OAuth alternative (the org-wide GitHub App) if you prefer not to manage a token.

Flow A: Personal Access Token (manual):

  1. Sign in to https://github.com.
  2. Create a token. Use a classic PAT with the repo:read and org:read scopes, or a fine-grained token with read-only access to repository contents and pull requests.

📖 Official guide: Managing your personal access tokens: GitHub's own documentation for creating this credential.

  1. Copy the token value (it is only shown once).
  2. Note your GitHub Org slug (the org_name, e.g. acme-inc from github.com/acme-inc).

Flow B: Org-wide OAuth install (alternative):

  1. Sign in to https://github.com as an org owner.
  2. Open https://github.com/apps/perfcopilot and click Install.
  3. Select the organization to install into.
  4. Choose All repositories (recommended) or pick specific repos. Click Install to confirm.

Copy these values; you'll paste them in the next step:

  • Personal Access Token
  • GitHub Org slug (org_name)

2. Paste into PerfCopilot

  1. Open Integrations on your PerfCopilot admin.

  2. Find the GitHub card and click Connect (or Manage if already configured).

  3. Paste each value into the matching field:

    Field in PerfCopilotValue from step 1
    Personal Access Token<your value>
    GitHub Org slugacme-inc

  4. Click Save.

The GitHub credential drawer in PerfCopilot: paste your values, then click Save.
The GitHub credential drawer in PerfCopilot: paste your values, then click Save.

3. Verify

Click Test in the drawer. Expected:

✅ Authenticated as your-org

If you see a red error, jump to Common errors.

Common errors

MessageWhat it usually meansFix
OAuth state mismatchCookies or popup were blocked between the redirect and callback.Retry the flow in a clean tab; allow popups for app.perfcopilot.com.
HTTP 401: bad credentialsThe GitHub OAuth token was revoked or has expired.Re-run the Connect flow to mint a fresh token.
Insufficient scopeThe app was installed without the right repo scope (e.g. limited to one repo).An org owner re-installs the app at https://github.com/apps/perfcopilot and grants the broader scope.

What signals we pull

  • pull_request: pull requests authored by the employee.
  • code_review_given: reviews and review comments the employee left on other people's PRs.
  • commit_cadence_summary: rolled-up commit activity per employee per cycle.

Need a feature you don't see? Tell us →.

PreviousCulture AmpNext Gmail