ChatGPT.nvim

环境要求

• 已安装 Neovim
• 系统已安装 curl
• 已获取 OpenAI API Key（ChatGPT Plus 订阅不含 API 额度，需单独购买）
• 已安装插件管理器 packer.nvim 或 lazy.nvim
• 依赖插件：MunifTanjim/nui.nvim、nvim-lua/plenary.nvim、nvim-telescope/telescope.nvim（fo

安装与启动步骤

1. 1准备 curl 与 API Key

   确认系统已安装 curl；到 OpenAI 平台获取 API Key。注意 ChatGPT Plus 订阅不含 API 额度，需另行购买。

2. 2设置 API Key 环境变量

   README 支持两种提供密钥方式：环境变量 $OPENAI_API_KEY，或在配置项 api_key_cmd 中指定返回密钥的可执行命令。

   export OPENAI_API_KEY="sk-xxxxxxxx"

   复制

3. 3用 packer.nvim 安装

   在 Neovim 配置中加入以下插件声明，requires 中列出必须的依赖插件，并调用 setup()。

   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"
       }
   })

   复制

4. 4用 lazy.nvim 安装

   在 lazy.nvim 配置中加入插件与 dependencies，event 设为 VeryLazy，trouble.nvim 为可选项。

   {
     "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"
       }
   }

   复制

5. 5配置模型参数

   通过 setup({...}) 覆盖默认配置，openai_params 中可设置 model、temperature、max_tokens、top_p 等参数。

   require("chatgpt").setup({
     openai_params = {
       model = "gpt-5-mini",
       frequency_penalty = 0,
       presence_penalty = 0,
       max_tokens = 4095,
       temperature = 0.2,
       top_p = 0.1,
       n = 1,
     }
   })

   复制

6. 6可选：Azure 接入

   使用 Azure 时可用配置项 api_type_cmd、azure_api_base、azure_api_engine_cmd、azure_api_version_cmd，或导出以下环境变量。

   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"

   复制

关键配置

如何确认成功

在 Neovim 中执行 :ChatGPTRun explain_code 等命令，能返回模型结果即安装配置成功。

常见问题

注意事项

• README 明确提示 edit 模型已被弃用，可能无法按预期工作。
• ChatGPTRun 支持 grammar_correction、translate、docstring、add_tests、fix_diagnostic 等多种内置动作。
• 自定义模板可用变量：{{input}}、{{filetype}}、{{filepath}}、{{argument}}、{{diagnostic}}、{{diagnostics}}。
• 策略 strategy 支持 replace、display、append、edit，其中 edit 目前仅支持 chat 类型。