gen.nvim

使用可自定义提示的 LLM 生成文本

视频

需求

• 安装了适当模型的 Ollama，例如 llama3.2、mistral 等。
• Curl

安装

使用你喜欢的插件管理器安装，例如 lazy.nvim。

Lazy 示例配置：

-- 最简配置
{ "David-Kunz/gen.nvim" },

-- 自定义参数（含默认值）
{
    "David-Kunz/gen.nvim",
    opts = {
        model = "mistral", -- 默认使用的模型。
        quit_map = "q", -- 设置关闭响应窗口的键映射
        retry_map = "<c-r>", -- 设置重新发送当前提示的键映射
        accept_map = "<c-cr>", -- 设置用最新结果替换之前选中文本的键映射
        host = "localhost", -- 运行 Ollama 服务的主机。
        port = "11434", -- Ollama 服务监听的端口。
        display_mode = "float", -- 显示模式。可为 "float"、"split"、"horizontal-split" 或 "vertical-split"。
        show_prompt = false, -- 显示提交给 Ollama 的提示。可为 true（3 行）或 "full"。
        show_model = false, -- 在聊天会话开始时显示正在使用的模型。
        no_auto_close = false, -- 不自动关闭窗口。
        file = false, -- 将请求负载写入临时文件，以缩短命令长度。
        hidden = false, -- 隐藏生成窗口（若为 true，则会隐式设置 `prompt.replace = true`），需 Neovim >= 0.10。
        init = function(options) pcall(io.popen, "ollama serve > /dev/null 2>&1 &") end,
        -- 初始化 Ollama 的函数。
        command = function(options)
            local body = {model = options.model, stream = true}
            return "curl --silent --no-buffer -X POST http://" .. options.host .. ":" .. options.port .. "/api/chat -d $body"
        end,
        -- 调用 Ollama 服务的命令。可使用占位符 $prompt、$model 和 $body（经过 shell 转义）。
        -- 也可以直接指定命令字符串。
        -- 执行的命令必须返回一个包含 { response, context } 的 JSON 对象
        -- （context 属性为可选）。
        -- list_models = '<omitted lua function>', -- 获取模型名称列表。
        result_filetype = "markdown", -- 配置结果缓冲区的文件类型。
        debug = false -- 打印错误及执行的命令。
    }
},

所有可用模型请参见 这里。

或者，你也可以调用 setup 函数：

require('gen').setup({
  -- 同上
})

使用方法

使用 Gen 命令根据预定义和可自定义的提示生成文本。

示例键映射：

vim.keymap.set({ 'n', 'v' }, '<leader>]', ':Gen<CR>')

你还可以直接通过 预定义提示 或自定义提示来调用：

vim.keymap.set('v', '<leader>]', ':Gen Enhance_Grammar_Spelling<CR>')

对话开始后，整个上下文都会被发送到 LLM。这样你就可以继续提问：

:Gen Chat

窗口关闭后，将开启一个新的会话。

对于不会自动替换先前选中文本的提示（replace = false），你可以使用 <c-cr> 将选中文本替换为生成的内容。

你还可以从已安装的所有模型中选择一个模型：

require('gen').select_model()

自定义提示

所有提示都定义在 require('gen').prompts 中，你可以对其进行扩展或修改。

示例：

require('gen').prompts['Elaborate_Text'] = {
  prompt = "详细阐述以下文本：\n$text",
  replace = true
}
require('gen').prompts['Fix_Code'] = {
  prompt = "修复以下代码。仅以 ```$filetype\n...\n``` 格式输出结果：\n```$filetype\n$text\n```",
  replace = true,
  extract = "```$filetype\n(.-)```"
}

每个提示可以使用以下属性：

• prompt: （字符串 | 函数）提示可以是字符串，也可以是一个返回字符串的函数。结果中可以使用以下占位符：
  • $text: 可视化选中的文本或当前缓冲区的内容。
  • $filetype: 缓冲区的文件类型（如 javascript）。
  • $input: 用户额外输入。
  • $register: 未命名寄存器的值（即复制的内容）。
• replace: 如果希望用生成的内容替换选中文本，则设置为 true。
• extract: 用于提取生成结果的正则表达式。
• model: 要使用的模型，默认为 mistral。

小贴士

用户选择可以通过 Telescope 结合 telescope-ui-select 来实现。

gen.nvim 快速上手指南

gen.nvim 是一个强大的 Neovim 插件，允许你使用本地大语言模型（LLM）生成文本、优化代码或进行对话。它支持自定义提示词，并默认集成 Ollama 作为后端。

环境准备

在开始之前，请确保你的系统已安装以下依赖：

1. Ollama: 用于运行本地大模型。

   • 访问官网下载：https://ollama.ai/
   • 安装完成后，拉取一个模型（例如 mistral 或 llama3.2）：

     ollama pull mistral
     

   • 确保 Ollama 服务正在运行（通常安装后会自动启动，或手动运行 ollama serve）。

2. Curl: 用于发送 HTTP 请求。

   • Linux (Debian/Ubuntu): sudo apt install curl
   • macOS: 系统自带，或通过 brew install curl 更新。
   • Windows: 建议使用 WSL2 或在 PowerShell 中确保 curl 可用。

安装步骤

推荐使用 lazy.nvim 进行安装。在你的 Neovim 配置文件中（通常是 lua/plugins/gen.lua 或 init.lua），添加以下配置：

最小化配置

{ "David-Kunz/gen.nvim" },

推荐配置（自定义参数）

你可以指定默认模型、窗口显示模式及快捷键映射：

{
    "David-Kunz/gen.nvim",
    opts = {
        model = "mistral", -- 默认使用的模型
        quit_map = "q", -- 关闭响应窗口的按键
        retry_map = "<c-r>", -- 重新发送当前提示词的按键
        accept_map = "<c-cr>", -- 用最新结果替换之前选中的内容
        host = "localhost", -- Ollama 服务地址
        port = "11434", -- Ollama 服务端口
        display_mode = "float", -- 显示模式："float", "split", "horizontal-split", "vertical-split"
        show_prompt = false, -- 是否显示提交给 Ollama 的提示词
        show_model = false, -- 是否在会话开始时显示当前模型
        no_auto_close = false, -- 是否禁止自动关闭窗口
        init = function(options) pcall(io.popen, "ollama serve > /dev/null 2>&1 &") end, -- 可选：自动启动 Ollama
        command = function(options)
            local body = {model = options.model, stream = true}
            return "curl --silent --no-buffer -X POST http://" .. options.host .. ":" .. options.port .. "/api/chat -d $body"
        end,
        result_filetype = "markdown", -- 结果缓冲区的文件类型
        debug = false -- 开启调试模式打印错误和命令
    },
},

安装完成后，重启 Neovim 或运行 :Lazy sync 即可完成安装。

基本使用

1. 基础命令

在普通模式或可视模式下，输入以下命令即可根据预设提示词生成内容：

:Gen

2. 配置快捷键

为了方便使用，建议在配置中添加快捷键映射：

-- 在普通模式和可视模式下使用 <leader>] 唤起生成菜单
vim.keymap.set({ 'n', 'v' }, '<leader>]', ':Gen<CR>')

-- 直接调用特定提示词（例如：增强语法和拼写）
vim.keymap.set('v', '<leader>e', ':Gen Enhance_Grammar_Spelling<CR>')

3. 常用场景

• 生成/修改代码或文本： 选中一段文本，按下映射的快捷键（如 <leader>]），选择对应的提示词（如 Fix_Code 或 Elaborate_Text），AI 将直接在浮动窗口中输出结果。如果配置了 replace = true，结果会自动替换原文本。

• 多轮对话 (Chat)： 开始一次对话后，上下文会被保留。你可以继续输入：

  :Gen Chat
  

  来追问问题。关闭生成窗口后，下一次操作将开启全新的对话会话。

• 手动替换结果： 对于未自动替换结果的提示词，生成完毕后，在结果窗口按下 <c-cr> (Ctrl+Enter) 即可将生成的内容替换掉原先选中的文本。

• 切换模型： 如果你想临时更换模型，可以运行：

  require('gen').select_model()
  

  这将列出所有已安装的 Ollama 模型供你选择。

4. 自定义提示词 (进阶)

你可以在配置中扩展或修改内置提示词：

require('gen').prompts['My_Custom_Prompt'] = {
  prompt = "将以下代码转换为 Python:\n$text",
  replace = true
}

支持占位符：$text (选中内容), $filetype (文件类型), $input (用户额外输入)。