AskGPT

A minimal neovim plugin to ask ChatGPT about your code.

Installation

Install with your favourite plugin manager.

Requires plenary and nui

E.g. using packer:

use({
    "e-cal/askgpt",
    config = function()
        require("askgpt").setup()
    end,
    requires = {
        "nvim-lua/plenary.nvim",
        "MunifTanjim/nui.nvim",
    }
})

Configuration

Default config:

{
    -- Text that will be appended to the input text in the popup buffer
		default_prompt = {
			n = "Where is this from, what does it do, and how is it used? Show me an example.",
			v = "",
		},
    -- API request params. See https://platform.openai.com/docs/api-reference/chat/create
    params = {
        model = "gpt-3.5-turbo",
        frequency_penalty = 0,
        presence_penalty = 0,
        max_tokens = 300,
        temperature = 0,
        top_p = 1,
        n = 1,
    },
    binds = {
        submit = "<C-d>",
        close = "q",
    },
}

Usage

You will need an OpenAI API key to use this plugin, which you can get here.

Once you have a key, either set it as the environment variable OPENAI_API_KEY, or you will be prompted to enter it when starting neovim with the plugin installed.

The plugin adds the Ask command, which can be bound to a keymapping for in both normal and visual mode.

Example mapping Ask to ?:

vim.keymap.set("n", "?", "<cmd>Ask<CR>")
vim.keymap.set("v", "?", "<cmd>Ask<CR>")

This command will open an editable popup window with some text in it.

• Visual mode: the text will be whatever was selected, wrapped in ```<lang> ``` (markdown formatting for code with the language indicated).
• Normal mode: the text will be the hover text from your LSP for the symbol under your cursor

Pressing your submit bind (<C-d> by default) will send the window content to gpt-3.5-turbo and write its response below.

You can edit, copy/paste from, etc in the popup as you would any other buffer.

Why?

• I'm always copy-pasting code into ChatGPT or GPT-4, asking it to explain or how to use a function from some library I'm not familiar with
• This speeds up the process a ton and keeps me in my workflow
• Very useful for quick questions about chunks of code or usage when the hover text isn't enough