ChatGPT Vim Plugin
This Vim plugin brings the power of OpenAI's ChatGPT API into your Vim editor, enabling you to request code explanations or improvements directly within Vim. With this plugin, you can effortlessly highlight code snippets and ask ChatGPT to explain, review, or rewrite them, with the option to include additional context for better results.
Prerequisites
- Vim with Python3 support.
- A ChatGPT API key from OpenAI.
Installation
Add your ChatGPT API key to your environment: https://platform.openai.com/account/api-keys
Setup your environment
To set up your environment, you can export the CHAT_GPT_KEY variable in your terminal:
export CHAT_GPT_KEY='your-api-key-here'
Alternatively, you can add the following lines to your .vimrc
file to set up the chatgpt plugin for Vim:
let g:chat_gpt_key='your-api-key-here'
let g:chat_gpt_max_tokens=2000
To install the chatgpt plugin, simply copy the chatgpt.vim
file to your Vim plugin directory. If you're using vim-pathogen, you can simply add the chatgpt
directory to your bundle
directory.
Finally, to install the openai
Python module, you can use pip:
pip install openai
Usage
The plugin offers the following commands for interacting with ChatGPT:
:Ask '<prompt>'
Sends your raw prompt to the ChatGPT API.
To use this command, type :Ask followed by your prompt.
:<>Review
Sends the highlighted code to ChatGPT and requests a review.
To use these commands (:Explain, :Review, or :Rewrite), visually select the lines of code you want to interact with, then type the desired command and press Enter.
-
:GenerateCommit
Sends entire buffer to ChatGPT and requests a commit messages be generated, then pastes it at the top of the buffer To use this command typegit commit -v
then:GenerateCommit
-
:<>Explain '<context>'
Sends the highlighted code to ChatGPT and requests an explanation, with the option to include additional context. -
:<>Rewrite '<context>'
Sends the highlighted code to ChatGPT and requests a rewritten version, with the option to include additional context. -
:<>Test '<context>'
Sends the highlighted code to ChatGPT and requests it writes a test, with the option to include additional context. -
:<>Fix '<context>'
Sends the highlighted code to ChatGPT and that it fixes any errors it may find, with the option to include additional context.
To use this command, visually select the lines of code you want to extend, then type :Extend 'context', where context is any additional information you want to provide.
The ChatGPT response will be displayed in a new buffer.
Example usage:
- Enter visual mode by pressing V.
- Select the lines of code you want to explain, review, or rewrite.
- Type
:Explain
,:Review
, or:Rewrite
,:Fix
,:Test
and press Enter.
Notes
This plugin is not affiliated with or endorsed by OpenAI. You are responsible for managing your API usage and any associated costs when using this plugin.