vim-ai

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Vim 或 Neovim，且支持内置 packages 机制（:help packages）
• OpenAI 账号，并已获取 API Key（官网链接见 README）
• 网络可访问 OpenAI API 或其兼容代理（如 OpenRouter）
• （可选）使用 Gemini、Claude 等模型时，需要一个 OpenAI 兼容代理服务

安装与启动步骤

1. 1申请 API Key

   README 明确需要注册 OpenAI 账号并获取 API Key；API 调用不是免费的，按 token 用量计费。

2. 2安装插件

   README 只说明用 Vim 内置 packages 手动安装（:help packages），未给出具体路径；下面按 packages 的常见目录结构克隆仓库，可按自己环境调整。

   git clone https://github.com/madox2/vim-ai ~/.vim/pack/plugins/start/vim-ai

   复制

3. 3写入令牌文件

   配置项 token_file_path 指向存放 API Key 的文件，把真实 Key 写入该文件即可。

   echo "sk-xxxxxxxx" > /custom/path/ai.token

   复制

4. 4配置 .vimrc

   在 .vimrc 中初始化 g:vim_ai_chat 变量并按需修改 model、stream、temperature 等选项。

   let g:vim_ai_chat = {
     "options": {
       "model": "o1-preview",
       "stream": 0,
       "temperature": 1,
       "max_completion_tokens": 25000,
       "initial_prompt": "",
       "token_file_path": "/custom/path/ai.token",
     },
   }

   复制

5. 5使用 AI 命令

   在 Vim 中输入 :AI 加指令补全文本，:AIChat 开启对话，:AIEdit 就地修改选中文本，:AIImage 生成图片。

   :AI 写一个 Python 快速排序

   复制

关键配置

如何确认成功

在 Vim 中执行 :AIChat 或 :AI 加一句指令，能收到 AI 返回的内容即表示配置成功。

常见问题

注意事项

• README 的安装章节只提到用 Vim 内置 packages 手动安装，未给出具体路径与命令，第 2 步的目录为 packages 的通用写法，请按自己的环境调整。
• 命令可配合范围使用，例如 :%AIE fix grammar 可处理整个缓冲区。
• 可用自定义角色，如 :AIEdit /grammar；用 :AIC /right、/below、/tab 指定聊天窗口打开位置。
• 想调试可执行 :AIUtilDebugOn / :AIUtilDebugOff，角色配置文件用 :AIUtilRolesOpen 打开。