Skip to main content

GitHub App

The Precogs GitHub App integrates directly into your GitHub workflow, providing automated security scanning on every pull request.

Installation

  1. Visit the Precogs GitHub App page.
  2. Click Install and select your organization or repositories.
  3. Authorize the requested permissions.

How It Works

Once installed, Precogs will:

  • Automatically scan every new pull request
  • Post inline comments on security findings
  • Update PR status checks with scan results

Configuration

Create a .precogs.yaml file in your repository root to customize scanning behavior:

# .precogs.yaml
scan:
enabled: true
languages:
- python
- javascript
severity_threshold: medium

Permissions Required

PermissionReason
Read codeTo analyze your source code
Read/Write pull requestsTo post findings as comments
Read/Write checksTo update PR status

Next Steps