Connect your GitHub account
Access the Garth portal
Open your browser and navigate to the Garth dashboard.
Create a Garth API key
In the left navigation, go to Developer → API Keys and click Create API Key.
Install the Garth GitHub App
Navigate to the Garth GitHub App and
click Install. Sign in to GitHub if prompted.
Choose your workspace
Select the GitHub organization or personal account where Garth should be installed.
Configure repository scope
Choose which repositories Garth can access:Click Install to apply.
- All repositories — installs Garth on every current and future repository.
- Select repositories — restricts Garth to specific projects you choose manually.
Garth requires read/write access to pull requests and checks to post code reviews. Your source code is never stored on Garth’s servers.
Activate with your API key
After clicking Install, you are redirected to the Garth platform. Enter
the API key you created earlier to complete the activation.
Network configuration
If your infrastructure requires IP allowlisting, permit the following address through your firewall:Troubleshooting
App installation issues
App installation issues
If you cannot install the Garth GitHub App:
- Verify owner-level access — confirm you have Owner permissions for the organization or repository.
- Check organization settings — some organizations restrict third-party app installations; an organization owner may need to approve Garth before installation succeeds.
- Re-trigger the installation — return to the Garth GitHub App page and attempt the installation again.
- Contact your GitHub admin — if organization policies block app installations, your GitHub organization administrator must grant approval.
Reviews not appearing
Reviews not appearing
If Garth is installed but not reviewing pull requests:
- Confirm repository scope — verify the repository is included under All repositories or is explicitly listed under Select repositories in your App installation settings.
- Check API key activation — ensure you completed the API key activation step after installing the GitHub App.
- Verify pull request events — Garth triggers on newly opened or updated pull requests. Re-open the PR or push a new commit to trigger a review.
Authentication errors
Authentication errors
If you receive authentication or permission errors:
- Re-authenticate — log out and back into the Garth dashboard and retry connecting your GitHub account.
- Regenerate your API key — go to Developer → API Keys in Garth, revoke the old key, and create a new one.
- Reinstall the GitHub App — uninstall and reinstall the Garth GitHub App from your GitHub organization settings.
- Check SSO enforcement — if your organization uses SAML SSO, you may need to authorize the Garth GitHub App for SSO access from your GitHub personal settings.
