Leverage Chatblade, the Swiss Army Knife for ChatGPT, from your Neovim editor.

Setup

Prerequisites

1. Install the Chatblade CLI
2. Set the OPENAI_API_KEY environment variable

Installation & Configuration

-- lazy.nvim
{
  "cmpadden/chatblade.nvim",
  keys = {
    { "<leader>x", ":Chatblade<cr>", mode = "v" },
  },
  cmd = {
    "Chatblade",
    "ChatbladeSessionStart",
    "ChatbladeSessionStop",
    "ChatbladeSessionDelete",
  },
  opts = {
    prompt           = "programmer",
    raw              = true,
    extract          = true,
    only             = true,
    temperature      = 0.8,
    include_filetype = true,
  }
}

Usage

Bindings

Select text, and send it to Chatblade with your key binding of choice. For the example of <leader>x, you can visually select a line or paragraph, send it to Chatblade, and the response will be inserted below your cursor.

vip<leader>x

Commands

The following user commands have been made available. This allows you to handle sessions so that you can send snippets to Chatblade, and ask follow-up questions with persisted context.

Command	Parameters	Description
Chatblade	string?	Prompt Chatblade with visual selection and/or an additional query
ChatbladeSessionStart	string	Start a session to persist context
ChatbladeSessionStop	nil	Stop the currently active Chatblade session
ChatbladeSessionDelete	string	Delete the specified Chatblade session

Options

Property	Type	Description
prompt	string?	Prompt to use found in the ~/.config/chatblade directory (Default nil)
raw	boolean?	Whether to return results in pure text (Default true)
extract	boolean?	Whether to extract code from response (Default true)
only	boolean?	Only display the response, not the original query (Default true)
temperature	float?	Lower values for result in more consistent outputs, whereas higher is more creative (Default 0.0; Max 2.0)
include_filetype	boolean?	Include filetype metadata in the prompt from active buffer (vim.bo.filetype)

Motivation

If all you wish to do is to pass text to chatblade from your Neovim session, then you may be better off defining a key binding like so:

vim.keymap.set("v", "<leader>x", ':!chatblade -e -r<CR>')

However, chatblade.nvim intends to offer some quality of life improvements over such a bindings.