
ChatGPT.nvim
在 Neovim 里直接和 AI 对话,写代码、改 bug 不用切窗口。
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3988
使用教程
环境要求
- 已安装 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准备 curl 与 API Key
确认系统已安装 curl;到 OpenAI 平台获取 API Key。注意 ChatGPT Plus 订阅不含 API 额度,需另行购买。
-
2设置 API Key 环境变量
README 支持两种提供密钥方式:环境变量 $OPENAI_API_KEY,或在配置项 api_key_cmd 中指定返回密钥的可执行命令。
export OPENAI_API_KEY="sk-xxxxxxxx" -
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用 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配置模型参数
通过 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可选: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"
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | 环境变量方式提供 OpenAI API Key | sk-xxxxxxxx |
api_key_cmd | 否 | 可执行命令,通过 stdout 返回 API Key | pass azure-openai-key |
api_host_cmd | 否 | 自定义 OpenAI API host($OPENAI_API_HOST) | echo -n "" |
extra_curl_params | 否 | 附加 curl 参数,可添加额外请求头 | {"-H", "Origin: https://example.com"} |
openai_params.model | 否 | 指定使用的模型名称,也可写成返回模型名的函数 | gpt-5-mini |
azure_api_base | 否 | Azure 部署的 URL base,配合 api_type_cmd 使用 | https://{your-resource-name}.openai.azure.com |
如何确认成功
在 Neovim 中执行 :ChatGPTRun explain_code 等命令,能返回模型结果即安装配置成功。
常见问题
Q:需要 ChatGPT Plus 订阅吗?
A:Plus 订阅目前不包含所需的 API 额度,需要到 OpenAI 账单页面单独购买 API credits 后才能调用。
Q:无法直接访问 OpenAI 怎么办?
A:可通过配置项 api_host_cmd 或环境变量 $OPENAI_API_HOST 指定自定义 OpenAI API host。
Q:如何使用 Azure 部署?
A:可配置 api_type_cmd、azure_api_base、azure_api_engine_cmd、azure_api_version_cmd,或导出 OPENAI_API_TYPE、OPENAI_API_BASE、OPENAI_API_AZURE_ENGINE、OPENAI_API_AZURE_VERSION。
Q:如何新增自定义动作?
A:编写 JSON 文件定义 action(含 type、opts、args),并在配置的 actions_paths 字段里指定该文件路径。
注意事项
- README 明确提示 edit 模型已被弃用,可能无法按预期工作。
- ChatGPTRun 支持 grammar_correction、translate、docstring、add_tests、fix_diagnostic 等多种内置动作。
- 自定义模板可用变量:{{input}}、{{filetype}}、{{filepath}}、{{argument}}、{{diagnostic}}、{{diagnostics}}。
- 策略 strategy 支持 replace、display、append、edit,其中 edit 目前仅支持 chat 类型。
核心亮点
- 深度集成 Neovim 原生体验,支持选中代码直接发送给 ChatGPT,无需复制粘贴
- 内置多轮对话窗口和自定义提示词模板,可灵活适配解释、重构、写测试等场景
- 基于 Lua 开发,轻量且易于配置,支持异步请求不阻塞编辑器
不足之处
- 依赖 OpenAI API 密钥,需付费使用,且网络环境可能受限
- 文档/社区待观察,功能丰富度与稳定性有待更多用户验证
适用场景
- 在 Neovim 中快速生成代码片段或函数实现
- 对选中代码进行解释、找 bug 或优化建议
- 编写单元测试或文档注释时,通过对话生成初稿
替代项目
Copilot.vim、codeium.nvim、gp.nvim
上一篇:AI-Git-Narrator
下一篇:gptstudio
同类项目推荐
claude-code-handbook
开源
从零到精通 Claude Code,中英双语速查手册
The definitive guide to Claude Code — from zero to mastery. Bilingual EN/CN.
TEDI
开源
一个窗口搞定终端、SSH、AI 编程和代码管理,让开发流程更顺畅。
Terminal Director. One lightweight app, eight features, your whole dev workflow in a···
opencode-anthropic-login-via-cli
开源
在 OpenCode 里用 Claude 订阅额度写代码
OpenCode plugin for using Anthropic models with your Claude Pro/Max subscription
SRepair
开源
花 3 分钱,让 LLM 自动修好 Java Bug
✅SRepair: Powerful LLM-based Program Repairer with $0.029/Fixed Bug
CoderGPT
开源
给 GPT-4 装上代码上下文,让 AI 编程助手更懂你的项目
Code context-aware pre-prompt rules for using GPT-4 as a coding assistant effectivel···
agent-skills
开源
让 AI 助手秒变 WordPress 开发专家,少踩坑
Expert-level WordPress knowledge for AI coding assistants - blocks, themes, plugins,···
jupyter-studio
开源
让 Jupyter 拥有 Cursor 级 AI 能力,一键修复报错
The AI-native JupyterLab — open-source Cursor for notebooks. Cmd+K inline edit, mul···
gokin
开源
在终端里用自然语言指挥 AI 搞定编码杂活
A powerful CLI tool that brings AI assistance directly to your terminal. Gokin under···
Autoloom
开源
给 AI 写代码加上治理护栏,改有依据、交有证据
AI coding with Aegis governance built into execution: baseline-aware changes, eviden···