> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peepsai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the Peeps GitHub App

> Connect GitHub to your Peeps organization to trigger runs from CI, get automatic failure analysis and healing, and set up your CI workflows. Install on every repository or only the ones you pick.

The Peeps GitHub App connects your GitHub account to your Peeps organization. Install it to get:

* **CI-triggered runs.** Trigger Peeps automation runs from your CI.
* **Failure analysis and auto-healing.** Peeps automatically analyzes failures and heals failing test cases.
* **Intent-based testing.** Peeps supports intent-based testing on your repositories.
* **Reporting and analytics.** See reports and analytics for your test cases and test automation.
* **CI workflow setup.** Peeps sets up and runs your CI workflows, including configuring deploy triggers.

You install it from Peeps settings, approve it on GitHub, and land back in Peeps. It takes about a minute.

<Note>
  A GitHub account can be connected to only one Peeps organization.
</Note>

## Install the app

<Steps>
  <Step title="Open GitHub settings in Peeps">
    In Peeps, open **Settings** and select **GitHub** under **Organization**. Click **Install GitHub App**.

    <Frame>
      <img src="https://mintcdn.com/peeps-ai/fBE20paFyfEpSDgm/images/github-app/peeps-github-settings.png?fit=max&auto=format&n=fBE20paFyfEpSDgm&q=85&s=3b25cd17b62c97470fa02e85f518ff79" alt="The GitHub page in Peeps organization settings, showing the Install GitHub App button" width="3082" height="1990" data-path="images/github-app/peeps-github-settings.png" />
    </Frame>
  </Step>

  <Step title="Sign in to GitHub">
    Peeps sends you to GitHub. If you are not already signed in, sign in to continue to **Peeps Labs** — the app's name on GitHub.

    <Frame>
      <img src="https://mintcdn.com/peeps-ai/fBE20paFyfEpSDgm/images/github-app/github-sign-in.png?fit=max&auto=format&n=fBE20paFyfEpSDgm&q=85&s=1745008c2dad6cd59324f190b1962bd0" alt="GitHub sign-in page reading Sign in to GitHub to continue to Peeps Labs" width="3082" height="1990" data-path="images/github-app/github-sign-in.png" />
    </Frame>
  </Step>

  <Step title="Choose which repositories Peeps can access">
    GitHub shows the **Install & Authorize Peeps Labs** page. Under **for these repositories**, choose one of two options.

    <Tabs>
      <Tab title="All repositories">
        Select **All repositories**.

        This grants access to every current and future repository owned by the account. New repositories are covered automatically, with no need to revisit the installation.

        Choose this when Peeps should cover everything the account owns.
      </Tab>

      <Tab title="Only select repositories">
        Select **Only select repositories**, then open **Select repositories** and search for each repository you want to grant.

        <Frame>
          <img src="https://mintcdn.com/peeps-ai/fBE20paFyfEpSDgm/images/github-app/select-repositories.png?fit=max&auto=format&n=fBE20paFyfEpSDgm&q=85&s=805c2880104623296a938d5b06da7387" alt="The Only select repositories option with the repository search open" width="3082" height="1990" data-path="images/github-app/select-repositories.png" />
        </Frame>

        Each repository you pick appears in the list below the menu. Click **×** next to a repository to remove it. You must select at least one.

        Choose this to keep Peeps scoped to the repositories it tests. Repositories you create later are not included until you add them.
      </Tab>
    </Tabs>

    Either way, public repositories are also included with read-only access.
  </Step>

  <Step title="Review the permissions and install">
    Check the permissions listed under **with these permissions**:

    * **Read** access to deployments and metadata
    * **Read** and **write** access to actions, actions variables, checks, code, issues, pull requests, repository hooks, secrets, and workflows

    Click **Install & Authorize**.

    <Frame>
      <img src="https://mintcdn.com/peeps-ai/fBE20paFyfEpSDgm/images/github-app/install-and-authorize.png?fit=max&auto=format&n=fBE20paFyfEpSDgm&q=85&s=1b25cb7c9cd1f9eb9dfbf80602006a12" alt="The Install & Authorize Peeps Labs page with one repository selected and the requested permissions listed" width="3082" height="1990" data-path="images/github-app/install-and-authorize.png" />
    </Frame>
  </Step>

  <Step title="Confirm the connection in Peeps">
    GitHub returns you to Peeps, which shows **GitHub App installed successfully**. The GitHub account now appears on the GitHub settings page, with its account type and when it was connected.

    <Frame>
      <img src="https://mintcdn.com/peeps-ai/fBE20paFyfEpSDgm/images/github-app/installation-connected.png?fit=max&auto=format&n=fBE20paFyfEpSDgm&q=85&s=228a374efa207f66c1a3fe75a0c1011c" alt="The Peeps GitHub settings page listing the connected GitHub account after a successful install" width="3082" height="1990" data-path="images/github-app/installation-connected.png" />
    </Frame>
  </Step>
</Steps>

## Installing on a GitHub organization

GitHub lets you install the app on your personal account or on any GitHub organization you belong to. To install on an organization, you need to be an owner of it. If you are not, GitHub sends the request to the organization's owners for approval instead.

## Manage installations

The GitHub page in Peeps settings lists every connected GitHub account.

* **Connect another account.** Click **Connect GitHub account** and repeat the steps above.
* **Remove an account.** Click the trash icon next to it.

To change which repositories an installation can access, do it on GitHub. For a personal account, go to **Settings** > **Applications** > **Installed GitHub Apps** and click **Configure** next to **Peeps Labs**. For a GitHub organization, go to the organization's **Settings** > **GitHub Apps**.

***

Need help connecting? [Get in touch](mailto:support@peepsai.com).
