Getting started
Quickstart
Get diffy reviewing a pull request. You need a GitHub account and an API key from a model provider.
- 1
Sign in with GitHub
Open diffy and choose Sign in with GitHub. diffy asks GitHub who you are and which accounts you can use it for. It does not keep your GitHub token.
- 2
Install the GitHub App
If diffy is not installed on any of your accounts yet, you are sent to GitHub to install it. Choose the account or organization, then the repositories you want reviewed: all of them, or only some. Repositories you give the App show up in diffy by themselves and are watched.
To add another organization later, open the organization menu at the top of the sidebar and choose Add organization.
- 3
Add an API key
Open Organization settings, then Models, and choose Add API key. Give it a name, pick the provider and the model, and paste the key. The first key you add is put in use at once.
Use Test connection from the menu on its row to check that the key and the model work. Until a key is in use, diffy asks you to add one before it shows the rest of the app.
- 4
Open a pull request
Open a pull request on a repository diffy watches, or push a new commit to one that is open. diffy queues a review as soon as GitHub tells it, and posts it on the pull request when it is ready. Pull requests that were already open when you added the repository are left alone.
- 5
Read the review
The review is on GitHub: a summary, and a comment on each line with a problem. In diffy,
Reviewslists every review with its status and findings, and the dashboard shows what is being reviewed now.To tell diffy what your project cares about, add a .diffy.yaml to the repository.