Getting Started

Getting Started

This guide will help you set up Peqy for your repository.

Prerequisites

  • A GitHub repository
  • The Peqy GitHub App installed on your repository
  • A Peqy API key

Installation Steps

1. Install the GitHub App

Contact the Peqy team to get access to the GitHub App installation.

2. Add the GitHub Action

See the GitHub Actions page for detailed setup instructions.

3. Configure Peqy (Optional)

Create a .peqy/config.yml file in your repository to customize which checks run. See Configuration for details.

How It Works

  1. You open a pull request - Peqy is triggered automatically
  2. AI analyzes your code - Checks for bugs, security issues, and best practices
  3. Results appear in GitHub - As a GitHub Check Run on your PR
  4. Fix and iterate - Address any issues found and push updates
IntroductionGitHub Actions