Optional steps

The steps below are completely optional.

Install git

PairPilot works best if you have git installed. Here are instructions for installing git in various environments.

Setup an API key

You need an key from an API provider to work with most models:

  • OpenAI provides o1, o3-mini, gpt-4o and other models. Note that paying for an API key is different than being a “ChatGPT” subscriber.
  • Anthropic provides Claude 3.5 Sonnet and Haiku.
  • DeepSeek provides DeepSeek R1 and DeepSeek Chat V3.
  • OpenRouter allows you to access models from many providers using a single key.

You can store your api keys in configuration or env files and they will be loaded automatically whenever you run PairPilot.

Enable Playwright

PairPilot supports adding web pages to the chat with the /web <url> command. When you add a url to the chat, PairPilot fetches the page and scrapes its content.

By default, PairPilot uses the httpx library to scrape web pages, but this only works on a subset of web pages. Some sites explicitly block requests from tools like httpx. Others rely heavily on javascript to render the page content, which isn’t possible using only httpx.

PairPilot works best with all web pages if you install Playwright’s chromium browser and its dependencies:

playwright install --with-deps chromium

See the Playwright for Python documentation for additional information.

Enable voice coding

PairPilot supports coding with your voice using the in-chat /voice command. PairPilot uses the PortAudio library to capture audio. Installing PortAudio is completely optional, but can usually be accomplished like this:

  • For Windows, there is no need to install PortAudio.
  • For Mac, do brew install portaudio
  • For Linux, do sudo apt-get install libportaudio2
    • Some linux environments may also need sudo apt install libasound2-plugins

Add PairPilot to your IDE/editor

You can use PairPilot’s --watch-files mode to integrate with any IDE or editor.

There are a number of 3rd party PairPilot plugins for various IDE/editors. It’s not clear how well they are tracking the latest versions of PairPilot, so it may be best to just run the latest PairPilot in a terminal alongside your editor and use --watch-files.

NeoVim

joshuavial provided a NeoVim plugin for PairPilot:

https://github.com/joshuavial/PairPilot.nvim

VS Code

You can run PairPilot inside a VS Code terminal window. There are a number of 3rd party PairPilot plugins for VSCode.

Other editors

If you are interested in creating an PairPilot plugin for your favorite editor, please let us know by opening a GitHub issue.