vim-ai

vim-ai 项目介绍

vim-ai 项目是一个将人工智能功能引入到 Vim 和 Neovim 环境中的插件。通过利用 OpenAI API，用户可以生成代码、编辑文本，或者通过与 GPT 模型进行交互对话，极大地增强了编辑器的智能化水平。

项目特点

文本或代码生成：利用AI技术生成代码或完整文本，并为用户的各种问题提供解答。
文本就地编辑：能够直接在文本中进行AI辅助的编辑操作。
与 ChatGPT 互动对话：支持与 ChatGPT进行互动对话，仿佛与一位智能助手对话。
支持自定义角色：用户可以定义不同的角色以适应特定需求。

工作原理

vim-ai 插件通过调用OpenAI的API来生成响应。用户需要在OpenAI平台上注册账号并获取API密钥。这项服务并非免费的，费用主要根据用户发送和接收的数据量计算。不过插件运行过程中，用户只需付费他们明确选择的内容，确保了数据的安全性。

安装步骤

前提条件

为了使用 vim-ai 插件，用户的 Vim 或 Neovim 需要启用 Python3 支持，同时还需获取和配置API密钥。

# 将 API 密钥保存在 `~/.config/openai.token` 文件中
echo "YOUR_OPENAI_API_KEY" > ~/.config/openai.token

# 或通过环境变量配置
export OPENAI_API_KEY="YOUR_OPENAI_API_KEY"

# 或与组织 ID 一起配置
echo "YOUR_OPENAI_API_KEY,YOUR_OPENAI_ORG_ID" > ~/.config/openai.token

用户还可以通过 .vimrc 文件自定义 API 密钥文件的路径：

let g:vim_ai_token_file_path = '~/.config/openai.token'

使用 `vim-plug` 安装

在 vimrc 中加入以下行即可：

Plug 'madox2/vim-ai'

手动安装

用户可以使用 Vim 的内建包管理来进行安装：

# 对于 vim
mkdir -p ~/.vim/pack/plugins/start
git clone https://github.com/madox2/vim-ai.git ~/.vim/pack/plugins/start/vim-ai

# 对于 neovim
mkdir -p ~/.local/share/nvim/site/pack/plugins/start
git clone https://github.com/madox2/vim-ai.git ~/.local/share/nvim/site/pack/plugins/start/vim-ai

使用说明

用户可以通过输入AI命令来运用插件的各种功能。以下是一些基础命令的概览：

========= 基础AI命令 =========

:AI         填充文本
:AIEdit     编辑文本
:AIChat     继续或开启新的聊天

============= 实用工具 =============

:AIRedo     重复上一次AI命令
:AINewChat  开启新的聊天

:help vim-ai

小贴士： 用户在按下 Ctrl-c 时可以随时取消正在进行的操作。此外，也可以设置自己的快捷键或者命令简写以便快速使用功能，例如 :AIE，:AIC，:AIR。

配置与自定义

vim-ai 提供了多种配置选项，用户可以在 .vimrc 中进行个性化设置，例如：

let g:vim_ai_chat = {
\  "options": {
\    "model": "gpt-4",
\    "temperature": 0.2,
\  },
\}

通过这种方式，用户可以根据具体需求动态修改配置。

自定义命令

除了内置功能之外，用户还可以通过自定义命令丰富编辑体验，比如创建一个建议 git 提交信息的命令：

function! GitCommitMessageFn()
  let l:diff = system('git --no-pager diff --staged')
  let l:prompt = "generate a short commit message from the diff below:\n" . l:diff
  let l:config = {
  \  "engine": "chat",
  \  "options": {
  \    "model": "gpt-4o",
  \    "initial_prompt": ">>> 系统\n你是一名代码助手",
  \    "temperature": 1,
  \  },
  \}
  call vim_ai#AIRun(l:config, l:prompt)
endfunction
command! GitCommitMessage call GitCommitMessageFn()