Skip to main content
1

Create an account

Sign up using your preferred option - OAuth using GitHub/GitLab, or simple login via Email.
Login Screen
Using GitHub or GitLab to sign in does not automatically give Patched access your repositories.
2

Add Repositories

Enable acccess to your repositories.
  1. Choose ‘GitHub’ on the onboarding screen and click ‘Install Patched on GitHub’.
  2. You will be redirected to GitHub to approve access to your repositories. You can specify exactly which repositories Patched will have access to.
  3. Next, you will be redirected back to the ‘Manage Repositories’ screen.
  4. Click the ’+’ button next to the repository you want to start patching.
  5. Click ‘Back to Repositories’ and you should see the repository in the list as well as a ‘Patch’ button next to it.
  1. Choose ‘Gitlab’ on the onboarding screen and click ‘Install Patched on Gitlab’.
  2. You will be asked to provide an access token. You can generate one here.
  3. Next, you will be redirected to the ‘Manage Repositories’ screen.
  4. Click the ’+’ button next to the repository you want to start patching.
  5. Click ‘Back to Repositories’ and you should see the repository in the list as well as a ‘Patch’ button next to it.
  1. Choose ‘CLI w/ API Key’ on the onb screen and click ‘Get an API Key’.
  2. You will be directed to the ‘Settings’ page, where you can generate and copy an API key.
  3. In your CLI terminal, set an environment variable called PATCHED_API_KEY with the copied value.
  4. Also in your CLI terminal, install the patched client by running pip install patchwork-cli.
3

Trigger Patchflows

Trigger your first patchflow.
  1. Click the ‘Patch’ button next to the repository you’d like to patch.
  2. In the pop-up modal, choose the patchflow you’d like to run. You can learn more about the patchflows here.
  3. Fill in the patchflow specific input values as needed, and click ‘Patch’.
  4. If the patch was triggered successfully, you should see a toast notificaton on the bottom right.
  1. Navigate to the root folder of the code repository you want to patch.
  2. Run patchwork <NameOfPatchflow>. The default patchflows are AutoFix,GenerateREADME,GenerateDocstring and PRReview. You can learn more about the patchflows here.
4

View Results

View your patchflow results by clicking the ‘Details’ button next to the repository you just patched.
5

Building Patchflows

You can also build your own patchflows by clicking the ‘Patchflow’ button on the top navigation, followed by clicking the ‘Add’ button the top-right.
A gif showing how one can create a new patchflow or custom an existing one.
And that’s it! Congrats on successfully getting started with Patched. This quickstart covers the core elements, but there is a lot more that you can do with Patched. You will find more details in the rest of the docs, but if you ever get stuck reach out to us via email or join our discord.
⌘I