https://github.com/naps62/pair-gpt.nvim

an #openAI powered pair programming partner
https://github.com/naps62/pair-gpt.nvim

gpt-3 openai rust vim

Last synced: 15 days ago
JSON representation

an #openAI powered pair programming partner

• Host: GitHub
• URL: https://github.com/naps62/pair-gpt.nvim
• Owner: naps62
• Created: 2022-12-05T14:13:17.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T13:50:28.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T14:40:02.989Z (28 days ago)
• Topics: gpt-3, openai, rust, vim
• Language: Lua
• Homepage:
• Size: 51.8 KB
• Stars: 38
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-vim-llm-plugins - naps62/pair-gpt.nvim

README

        
# pair GPT - Neovim plugin

[packer]: https://github.com/wbthomason/packer.nvim

[openai-api]: https://openai.com/api/

[openai-pricing]: https://openai.com/api/pricing/

[openai-apikeys]: https://beta.openai.com/account/api-keys

A GPT-assisted pair programming partner for Neovim.

## Features

**Write code from text prompts**

[![asciicast](https://asciinema.org/a/gIXsFqG3ZDVhVFRkpIkBipz9I.svg)](https://asciinema.org/a/gIXsFqG3ZDVhVFRkpIkBipz9I)

**Refactor existing code**

[![asciicast](https://asciinema.org/a/0IrC8uV5aHt4kXnfJK273Hcez.svg)](https://asciinema.org/a/0IrC8uV5aHt4kXnfJK273Hcez)

## Install

You need an account for [OpenAI's API][openai-api]. Check out the [pricing page][openai-pricing] to see how far you can go with the free plan (spoiler alert: should be more than enough to take this plugin out for a testdrive).

Export the API key as an environment variable. Add this to your `.bashrc` / `.zshrc` / etc:

```

export OPENAI_API_KEY=xxxxxxxxxxxxxxx

```

Install the binary:

```bash

cargo install --git https://github.com/naps62/pair-gpt.nvim

```

Install the plugin: with [packer][packer]

```vim

" with vim-plug:

Plug 'naps62/pair-gpt.nvim'

" with packer:

use { 'naps62/pair-gpt.nvim',

  config = function()

    require('pair-gpt').setup()

  end

}

```

Setup should be included in a lua file or in a lua heredoc [:help lua-heredoc](https://neovim.io/doc/user/lua.html) if using in a vim file.

```lua

-- examples for your init.lua

-- empty setup using defaults

-- can be done directly via packer's config option, as seen above

require("pair-gpt").setup()

-- OR setup with some options

require("pair-gpt").setup({

  bin = "pair-gpt",

  model = "text-davinci-001"

})

```

## Usage

Open a file with your editor. ensure filetype detection is live (this plugin uses that to pass down to the bot).

The full list of commands is below. Note that all commands that work on a visual range also fallback to the current line the cursor is in.

| Command            | type  | description                                                                     |

| ---                | ---   | ---                                                                             |

| `:PairGPTWrite`    | range | writes code based on a text prompt                                              |

| `:PairGPTRefactor` | range | attempts to refactor the selected code (or current line)                        |

| `:PairGPTExplain`  | range | writes a comment above the code with a natural-text explanation of what it does |