Docs

The GitHub App

What the Sypnia GitHub App is allowed to do in your repositories, what it never does, what happens to your code, and how to install and remove it.

Applies to Cloud At launch

View as Markdown
On this page
  1. You do not need it
  2. What the app can do
  3. What the app never does
  4. What happens to your code
  5. Install it
  6. Start from the project
  7. Choose where to install it, and which repositories
  8. Connect the repository to the project
  9. Turn pull requests on for the project
  10. Limits
  11. Remove it
  12. Example: the shop

Cloud This page is for whoever decides whether Sypnia may touch a repository. The GitHub App exists only on Sypnia Cloud, and pull requests are part of the Builder and Team plans, not of the Free plan. The open-source engine does not open pull requests: there, the fix goes to your own coding agent through the prompt or the MCP server.

The Sypnia GitHub App is how a fix arrives as a pull request. It reads the repository, writes a branch named sypnia/<problem slug>, and opens a pull request with the change and a test. A person reviews it and merges it. Sypnia never merges code.

How a pull request is written, what it contains and how to review it is in Pull requests. This page is about the app itself: installing it, what it may do, and removing it.

You do not need it

Without the app, everything else works: problems, the sentence in plain words, the prompt and the MCP server. Install it only if you want Sypnia to open pull requests, or to read what changed between two releases.

Installing the app does not switch pull requests on. They are a setting of each project, off until an owner or an admin turns it on, and Sypnia opens no pull request in a project where it is off.

What the app can do

When you install it, GitHub shows the permissions it asks for. They are these, and no others.

Permission on GitHubWhy Sypnia needs it
Contents: read and writeRead the files a fix needs and what changed between two releases. Write its own branch, sypnia/<problem slug>.
Pull requests: read and writeOpen the pull request, and read whether it was merged or closed.
Metadata: readRequired by GitHub for every app: the repository’s name and default branch.

You choose which repositories the app can reach, on GitHub, when you install it. Choose only the ones Sypnia should work in. The app cannot reach any other.

What the app never does

  • It never merges a pull request.
  • It never pushes to your default branch, or to any branch that is not its own sypnia/… branch.
  • It never force-pushes or deletes a branch.
  • It never changes repository settings, secrets, workflows’ permissions or collaborators.
  • It never opens a pull request in a project where pull requests are off, which is how every project starts.
  • It never opens one by itself unless you ask for that too. With pull requests on, someone in your organization, or a credential with the admin scope, asks for each one. A second setting, also off by default, lets Sypnia open one by itself when an analysis has high confidence.
  • It never writes a fix it cannot justify. If the analysis has no clear cause, or its confidence is low, Sypnia says so and opens nothing.

Your branch protection rules, required reviews and checks apply to Sypnia’s pull requests like to anyone’s.

What happens to your code

  • Read on demand. Sypnia reads the files it needs when it writes a fix, and what changed between two releases when your build did not send it. It does not keep a copy of your repository.
  • Sent to a model. To write a fix, the relevant parts of those files go to a model, reached through OpenRouter, with the settings that forbid providers from keeping the data or training on it. Exactly what is sent is in Models and what is sent.
  • Kept with the problem. The lines of code the analysis quotes as evidence are stored with the problem, and deleted with it.

Install it

At the end you will have one repository connected to one project, pull requests turned on for it, and an «Open pull request» action on that project’s problems. You need the Builder or the Team plan.

  1. Start from the project

    In the app, open the project’s settings and choose to connect GitHub. You need to be an owner or an admin of the organization on Sypnia.

    You should see
    You are sent to GitHub, to the installation page of the Sypnia app.
  2. Choose where to install it, and which repositories

    On GitHub, choose your user or your GitHub organization, then «Only select repositories», and pick the repository of your app. You need permission on GitHub to install apps there; if you do not have it, GitHub offers to send a request to someone who does.

    You should see
    GitHub lists the three permissions above and the repositories you chose.
  3. Connect the repository to the project

    Back in Sypnia, choose which of those repositories holds this project’s code. A project connects to one repository. Several projects can connect to the same repository, which is the usual case for a monorepo.

    You should see
    The project’s settings show the repository.
  4. Turn pull requests on for the project

    In the same settings, turn pull requests on. Until you do, Sypnia reads what changed between releases and opens nothing.

    You should see
    An open problem with a clear cause shows «Open pull request».

Limits

  • Pull requests are not included in the Free plan. The Builder and Team plans include a number of pull requests a month for the whole organization; the numbers are in the table of Plans and limits.
  • A problem has at most one open pull request from Sypnia at a time.
  • At launch the app works with repositories on GitHub.com. GitHub Enterprise Server, GitLab and Bitbucket are not supported. With those, use the prompt or the MCP server.

Remove it

You can take access away at any time, and you do not need Sypnia to do it.

  • Disconnect one project: in the project’s settings on Sypnia. The app stays installed on GitHub.
  • Remove one repository, or uninstall the app: on GitHub, in the settings of the installation. Sypnia loses access at once.

Branches and pull requests that Sypnia already opened stay in your repository; they are yours. Problems keep their analysis. Asking for a pull request on a project with no repository connected, or with pull requests off, is refused with a message that says so.

Example: the shop

The shop is on the Builder plan. Its owner installs the app on the repository acme/shop only, connects it to the project shop, and turns pull requests on for that project.

When the Pay button breaks, the problem shows «Open pull request». She clicks it. A few minutes later a pull request appears on GitHub:

Text
Read the cart total from its new field
sypnia/pay-button-does-nothing  ->  main
opened by Sypnia

Fixes the problem 3 people hit today.
Changes src/checkout/checkout.tsx and adds a test that fails
when the amount is missing.

The repository requires one review and passing tests. She reads the change, the tests pass, and she merges it. It used one of the month’s pull requests.

Sections

Start hereWhat Sypnia is, how it works, what is open source and what is the paid cloud, and the two ways to get your first problem in plain words.ConceptsThe ten ideas Sypnia is made of, each defined precisely, from a project and its keys to problems, traces and alerts.SDKsHow your app sends data to Sypnia. One SDK for the browser, one for Node, one for Next.js, and the OpenTelemetry intake for every other backend.The agentHow Sypnia analyses a problem, what it writes, what it sends to a model and what it never does.MCP and skillsConnect your coding agent to Sypnia so it can ask what is failing in production, read what it needs to fix it, and set Sypnia up for you.API referenceThe Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error.CLI referenceThe sypnia command: how to install it, the variables it reads, what its exit codes mean, and where each command is documented.Self-hostingWhat you run when you host the Sypnia engine yourself, what you need, what it costs, and what you do not get compared with Sypnia Cloud.How the engine is builtThe whole Sypnia engine on one page, from a click in your app to the sentence your coding agent reads, with the design rules and the code that holds them.Sypnia CloudHow the paid service works, from organizations and roles to plans, limits, billing, where your data lives, the GitHub App and support.Privacy and securityWhat Sypnia collects from your app and its users, what it never collects, how masking works, how to delete data, and how the service is protected.LicensingWhich licence covers each part of Sypnia, what you may do with it, how the name may be used, and the terms of a contribution.GuidesStep-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry.ReferenceThe pages you look things up in, from the event schema and the glossary to what is planned, the changelog and the common questions.
↑↓ to move↵ to openEsc to close