ChatGPT.nvim

ChatGPT 是一款 Neovim 插件，使您能够轻松地使用 OpenAI 的 ChatGPT API，在编辑器中直接根据您的问题生成自然语言回复。

功能

• 交互式问答：通过直观的界面与强大的 gpt 模型（ChatGPT）进行交互式问答。

• 基于角色的对话：从 Awesome ChatGPT 提示词库中选择提示，探索不同视角并与各种角色展开对话。

• 代码编辑辅助：借助 gpt 模型提供的交互式编辑窗口，获得针对编码任务的指导，提升编码体验。

• 代码补全：享受类似 GitHub Copilot 的便捷代码补全功能，利用 gpt 模型根据上下文和编程模式推荐代码片段和补全内容。

• 可自定义操作：使用 gpt 模型执行多种操作，如语法纠正、翻译、关键词生成、文档字符串创建、添加测试、代码优化、摘要生成、错误修复、代码解释、Roxygen 编辑以及代码可读性分析。此外，您还可以通过 JSON 文件定义自己的自定义操作。

• 丰富的消息渲染：增强聊天显示效果，支持带样式的代码块（语言标头、复制指示器、可折叠）、Markdown 格式化（标题、加粗、斜体、列表、引用、链接）、差异高亮以及发送者标识。

• 内联上下文引用：使用 @ 符号，将 LSP 定义或项目文件中的上下文直接插入到您的提示中。引用会以内联形式显示，并在发送至 API 时展开。

如需全面了解该插件的功能，您可以观看插件演示 视频。

安装

• 确保已安装 curl。

• 从 OpenAI 获取 API 密钥，您可以在 这里 获得。（注意：ChatGPT Plus 订阅目前不包含所需的 API 配额。您需要单独购买 API 配额 此处。）

OpenAI API 密钥可以通过以下两种方式提供：

1. 在配置选项 api_key_cmd 中，提供一个返回 API 密钥到标准输出的可执行文件路径及其参数。

2. 通过名为 $OPENAI_API_KEY 的环境变量设置。

使用配置选项 api_host_cmd 或名为 $OPENAI_API_HOST 的环境变量，可以指定自定义的 OpenAI API 主机。如果您无法直接访问 OpenAI，这将非常有用。

可通过配置选项 extra_curl_params 传递自定义的 cURL 参数。如果需要为请求添加额外的头部信息，这将非常实用：

{
  ...,
  extra_curl_params = {
    "-H",
    "Origin: https://example.com"
  }
}

对于 Azure 部署，您需要指定 URL 基础、引擎和 API 类型。可以通过以下两种方式实现：

1. 使用配置选项 api_type_cmd、azure_api_base、azure_api_engine_cmd 和 azure_api_version_cmd。每个选项都应是一个返回相应值的可执行命令。

例如：

  local config = {
    api_host_cmd = 'echo -n ""',
    api_key_cmd = 'pass azure-openai-key',
    api_type_cmd = 'echo azure',
    azure_api_base_cmd = 'echo https://{your-resource-name}.openai.azure.com',
    azure_api_engine_cmd = 'echo chat',
    azure_api_version_cmd = 'echo 2023-05-15'
  }

  require("chatgpt").setup(config)

2. 通过环境变量 $OPENAI_API_TYPE、$OPENAI_API_BASE、$OPENAI_API_AZURE_ENGINE 和 $OPENAI_API_AZURE_VERSION 设置这些值。

例如：

export OPENAI_API_TYPE="azure"
export OPENAI_API_BASE="https://{your-resource-name}.openai.azure.com"
export OPENAI_API_AZURE_ENGINE="chat"
export OPENAI_API_AZURE_VERSION="2023-05-15"

请注意，编辑模型已被弃用，可能无法按预期工作。

如果您使用 packer.nvim 作为插件管理器：

-- Packer
use({
  "jackMort/ChatGPT.nvim",
    config = function()
      require("chatgpt").setup()
    end,
    requires = {
      "MunifTanjim/nui.nvim",
      "nvim-lua/plenary.nvim",
      "folke/trouble.nvim",
      "nvim-telescope/telescope.nvim"
    }
})

或者如果您使用 lazy.nvim：

-- Lazy
{
  "jackMort/ChatGPT.nvim",
    event = "VeryLazy",
    config = function()
      require("chatgpt").setup()
    end,
    dependencies = {
      "MunifTanjim/nui.nvim",
      "nvim-lua/plenary.nvim",
      "folke/trouble.nvim", -- 可选
      "nvim-telescope/telescope.nvim"
    }
}

配置

ChatGPT.nvim 具有以下默认配置，您可以通过在 setup 参数中传入配置来覆盖它们：

https://github.com/jackMort/ChatGPT.nvim/blob/main/lua/chatgpt/config.lua

示例配置

聊天模型的简单配置可能如下所示：

{
  "jackMort/ChatGPT.nvim",
  event = "VeryLazy",
  config = function()
    require("chatgpt").setup({
      -- 此配置假设您已设置 OPENAI_API_KEY 环境变量
      openai_params = {
        -- 注意：模型可以是一个返回模型名称的函数
        -- 这在您希望使用命令动态切换模型时非常有用
        -- 例如：
        -- model = function()
        --     if some_condition() then
        --         return "gpt-5"
        --     else
        --         return "gpt-5-mini"
        --     end
        -- end,
        model = "gpt-5-mini",
        frequency_penalty = 0,
        presence_penalty = 0,
        max_tokens = 4095,
        temperature = 0.2,
        top_p = 0.1,
        n = 1,
      }
    })
  end,
  dependencies = {
    "MunifTanjim/nui.nvim",
    "nvim-lua/plenary.nvim",
      "folke/trouble.nvim", -- 可选
    "nvim-telescope/telescope.nvim"
  }
}

密钥管理

通过环境变量提供 OpenAI API 密钥是不安全的，因为这会使该密钥容易被任何能够访问其他进程环境变量的进程读取。此外，这种方式还会促使用户将凭据以明文形式存储在配置文件中。

作为替代方案，建议用户不要通过 OPENAI_API_KEY 环境变量来提供 API 密钥，而是使用 api_key_cmd 配置选项。api_key_cmd 配置选项接受一个字符串，该字符串会在启动时执行，并将执行结果用作 API 密钥。

以下配置将使用 1Password 的命令行工具 op，从 OpenAI 条目的 credential 字段中获取 API 密钥：

require("chatgpt").setup({
    api_key_cmd = "op read op://private/OpenAI/credential --no-newline"
})

以下配置则会使用 GPG 解密本地包含 API 密钥的文件：

local home = vim.fn.expand("$HOME")
require("chatgpt").setup({
    api_key_cmd = "gpg --decrypt " .. home .. "/secret.txt.gpg"
})

请注意，api_key_cmd 的参数会按空格进行分割。如果需要在参数中包含空格（例如引用带有空格的路径），可以将其封装在一个单独的脚本中。

使用方法

该插件提供了以下命令：

ChatGPT

ChatGPT 命令会打开一个使用 gpt-5-mini 模型的交互式窗口。 （也称为 ChatGPT）

ChatGPTActAs

ChatGPTActAs 命令会打开一个提示选择界面，来自 Awesome ChatGPT Prompts，用于与 gpt-5-mini 模型一起使用。

ChatGPTEditWithInstructions

ChatGPTEditWithInstructions 命令会打开一个交互式窗口，允许使用 gpt-5-mini 模型（可配置）编辑选定的文本或整个窗口。

你可以通过 Lua API 将其映射到键位上，例如使用 which-key.nvim：

local chatgpt = require("chatgpt")
wk.register({
    p = {
        name = "ChatGPT",
        e = {
            function()
                chatgpt.edit_with_instructions()
            end,
            "使用指令编辑",
        },
    },
}, {
    prefix = "<leader>",
    mode = "v",
})

• 演示视频。

ChatGPTRun

ChatGPTRun [action] 命令会运行特定的操作——详细列表请参阅 actions.json 文件。可用的操作包括：

1. grammar_correction：语法修正
2. translate：翻译
3. keywords：提取关键词
4. docstring：生成文档字符串
5. add_tests：添加测试代码
6. optimize_code：优化代码
7. summarize：摘要
8. fix_bugs：修复错误
9. explain_code：解释代码
10. roxygen_edit：Roxygen 注释编辑
11. code_readability_analysis：代码可读性分析——参见 演示
12. fix_diagnostic：修复光标下的错误
13. explain_diagnostic：解释光标下的错误
14. fix_diagnostics：修复选区内的所有错误

以上所有操作均使用 gpt-5-mini 模型。

也可以通过 JSON 文件定义自定义操作。示例请参阅 actions.json。自定义操作的路径可以在配置中设置（参见上述配置示例中的 actions_paths 字段）。

自定义操作的示例如下：（# 表示注释）

{
  "action_name": {
    "type": "chat", # 或 "completion" 或 "edit"
    "opts": {
      "template": "使用可能变量的模板",
      "strategy": "replace", # 或 "display" 或 "append" 或 "edit"
      "params": { # 根据官方 OpenAI API 的参数
        "model": "gpt-5-mini", # 或 OpenAI API 中“type”支持的任何其他模型，可参考 Playground
        "stop": [
          "```" # 用于停止模型的字符串
        ]
      }
    },
    "args": {
      "argument": {
          "type": "strig",
          "optional": "true",
          "default": "某个值"
      }
    }
  }
}

可用的模板变量：

• {{input}}：选定的文本
• {{filetype}}：Neovim 文件类型
• {{filepath}}：文件的相对路径
• {{argument}}：命令行中提供的参数
• {{diagnostic}}：光标下的 LSP 诊断信息（格式：[严重性] 消息（第 N 行））
• {{diagnostics}}：选区内的所有 LSP 诊断信息（格式：第 N 行 [严重性]：消息）

“edit”策略会将输出与输入并排显示，并允许进一步编辑。

目前，“edit”策略仅适用于“chat”类型。

“display”策略会在浮动窗口中显示输出。

“append”和“replace”则会直接修改缓冲区中的文本。

交互式弹出窗口

在使用 ChatGPT 和 ChatGPTEditWithInstructions 时，以下快捷键可用：

提交与关闭：

• <C-Enter> / <Enter> 提交提示
• q 关闭聊天窗口
• <C-c> 停止生成回复

导航：

• ]m / [m 切换到下一条/上一条消息
• ]c / [c 切换到下一个/上一个代码块
• <C-u> / <C-d> 上下滚动聊天窗口
• <Tab> 在窗口之间循环切换

切换项（前缀为 g）：

• gs 切换设置面板（只读）
• gh 切换帮助面板
• gp 切换会话面板
• gr 切换系统角色窗口
• gm 切换消息角色（用户/助手）
• gl 循环切换布局模式（居中/右侧）
• gn 开始新会话
• gd 草稿消息（添加但不发送）

操作：

• y 复制光标处的代码块
• Y 复制最后的回答内容
• d 删除选定的消息
• e 编辑选定的消息
• r 重命名会话（在会话面板中）
• za 切换代码块的折叠状态
• @ 触发上下文自动补全（LSP、项目、文件、Git 差异）

编辑窗口专用：

• <C-y> 接受更改
• <C-d> 切换差异视图
• <C-i> 将回复用作输入

设置窗口（gs）会显示当前配置（模型、温度、最大令牌数、会话名称）。如需更改设置，请修改你的 setup() 配置。

Whichkey 插件映射

将这些添加到你的 whichkey 插件中，以获得便捷的键绑定。

c = {
  name = "ChatGPT",
    c = { "<cmd>ChatGPT<CR>", "ChatGPT" },
    e = { "<cmd>ChatGPTEditWithInstruction<CR>", "使用指令编辑", mode = { "n", "v" } },
    g = { "<cmd>ChatGPTRun grammar_correction<CR>", "语法修正", mode = { "n", "v" } },
    t = { "<cmd>ChatGPTRun translate<CR>", "翻译", mode = { "n", "v" } },
    k = { "<cmd>ChatGPTRun keywords<CR>", "关键词提取", mode = { "n", "v" } },
    d = { "<cmd>ChatGPTRun docstring<CR>", "生成文档字符串", mode = { "n", "v" } },
    a = { "<cmd>ChatGPTRun add_tests<CR>", "添加测试用例", mode = { "n", "v" } },
    o = { "<cmd>ChatGPTRun optimize_code<CR>", "代码优化", mode = { "n", "v" } },
    s = { "<cmd>ChatGPTRun summarize<CR>", "摘要生成", mode = { "n", "v" } },
    f = { "<cmd>ChatGPTRun fix_bugs<CR>", "修复 bug", mode = { "n", "v" } },
    x = { "<cmd>ChatGPTRun explain_code<CR>", "解释代码", mode = { "n", "v" } },
    r = { "<cmd>ChatGPTRun roxygen_edit<CR>", "Roxygen 编辑", mode = { "n", "v" } },
    l = { "<cmd>ChatGPTRun code_readability_analysis<CR>", "代码可读性分析", mode = { "n", "v" } },
  },

ChatGPT.nvim 快速上手指南

ChatGPT.nvim 是一款 Neovim 插件，允许你在编辑器内直接调用 OpenAI ChatGPT API，实现交互式问答、代码辅助编辑、自动补全及多种自定义 AI 操作。

1. 环境准备

在开始之前，请确保你的系统满足以下条件：

• Neovim：已安装并配置好 Lua 支持。
• curl：确保系统中已安装 curl 命令行工具。
• OpenAI API Key：
  • 前往 OpenAI 官网 获取 API Key。
  • 注意：ChatGPT Plus 订阅不包含 API 额度，需单独购买 API Credits。
• 依赖插件：
  • MunifTanjim/nui.nvim
  • nvim-lua/plenary.nvim
  • folke/trouble.nvim (可选)
  • nvim-telescope/telescope.nvim

2. 安装步骤

推荐使用插件管理器进行安装。以下是基于 lazy.nvim 和 packer.nvim 的配置示例。

使用 lazy.nvim

{
  "jackMort/ChatGPT.nvim",
  event = "VeryLazy",
  config = function()
    require("chatgpt").setup()
  end,
  dependencies = {
    "MunifTanjim/nui.nvim",
    "nvim-lua/plenary.nvim",
    "folke/trouble.nvim", -- optional
    "nvim-telescope/telescope.nvim"
  }
}

使用 packer.nvim

use({
  "jackMort/ChatGPT.nvim",
    config = function()
      require("chatgpt").setup()
    end,
    requires = {
      "MunifTanjim/nui.nvim",
      "nvim-lua/plenary.nvim",
      "folke/trouble.nvim",
      "nvim-telescope/telescope.nvim"
    }
})

配置 API Key

为了安全起见，建议不要直接将 Key 硬编码在配置文件中。你可以选择以下任一方式：

方式一：环境变量（简单但不推荐用于生产环境） 在 shell 配置文件中设置：

export OPENAI_API_KEY="sk-..."

方式二：通过命令获取（推荐，更安全） 在 setup 配置中使用 api_key_cmd，例如使用 pass 或 gpg 解密获取：

require("chatgpt").setup({
    -- 示例：使用 1Password CLI 获取
    api_key_cmd = "op read op://private/OpenAI/credential --no-newline"
})

3. 基本使用

安装并配置完成后，重启 Neovim 即可使用以下核心功能。

交互式聊天

在命令模式下输入以下命令，打开交互式聊天窗口：

:ChatGPT

• 输入问题后按 <Enter> 或 <C-Enter> 发送。
• 按 q 关闭窗口。
• 支持 Markdown 渲染、代码块高亮及折叠。

角色预设对话

加载来自 Awesome ChatGPT Prompts 的预设角色进行对话：

:ChatGPTActAs

指令式代码编辑

选中代码或在正常模式下，运行以下命令，根据自然语言指令修改代码：

:ChatGPTEditWithInstructions

• 输入指令（如：“添加注释”、“优化性能”），AI 将生成修改后的代码供你审查和应用。

快捷动作 (Actions)

执行预定义的快捷操作，格式为 :ChatGPTRun [action_name]。常用动作包括：

• grammar_correction: 语法修正
• translate: 翻译
• explain_code: 解释代码
• fix_bugs: 修复 Bug
• add_tests: 添加测试用例
• optimize_code: 代码优化

示例：

:ChatGPTRun explain_code

常用快捷键 (在聊天窗口中)

• <C-Enter> / <Enter>: 发送消息
• q: 关闭聊天窗口
• <C-c>: 停止生成
• y: 复制当前光标处的代码块
• gs: 切换设置面板
• gn: 开始新会话