gp.nvim

Gp.nvim 项目介绍

Gp.nvim 是一个为 Neovim 编辑器设计的插件，旨在扩展 Neovim 的功能，整合 GPT 模型的强大功能。这个插件为用户提供了一种简单且扩展性强的方式，使得 GPT 模型可以在编辑器中无缝使用。以下是这个项目的一些关键特性和功能。

主要目标与功能

Gp.nvim 的主要目标是通过 GPT 模型增强 Neovim 编辑器，使用户无需离开编辑器即可执行各种智能操作。其特性包括但不限于：

• 流式响应：无需等待完整响应即可查看结果，并可以即时取消。
• 无限扩展性：用户可以通过配置中的 hook 函数无限扩展插件功能。详细信息请参阅“配置”和“扩展功能”章节。
• 最小依赖：仅需安装 neovim、curl、grep，以及可选的 sox 用于语音到文本功能。
• 类 ChatGPT 会话：通过 Neovim 的缓冲区管理会话，支持查找、预览、删除和打开会话。
• 可指令的文本/代码操作：通过模板机制结合用户指令、选中内容等生成 GPT 查询。
• 语音到文本支持：通过语音快速输入文本，非常适合用来添加注释或提出问题。
• 图像生成：直接在 Neovim 中生成图像，减少打开浏览器的必要性。

安装指南

第一步：安装插件

用户可以通过其惯用的包管理器安装 Gp.nvim。以下是一些示例配置：

-- 使用 lazy.nvim 安装
{
    "robitx/gp.nvim",
    config = function()
        local conf = {}
        require("gp").setup(conf)
    end,
}

-- 使用 packer.nvim 安装
use({
    "robitx/gp.nvim",
    config = function()
        local conf = {}
        require("gp").setup(conf)
    end,
})

-- 使用 vim-plug 安装
Plug 'robitx/gp.nvim'

local conf = {}
require("gp").setup(conf)

第二步：获取 OpenAI API Key

用户需要确保拥有 OpenAI API 密钥，具体方法可以参考 OpenAI 官方网站。插件支持多种传递密钥的方法，比如通过环境变量或文件读取等。

支持的多个供应商

除了 OpenAI，Gp.nvim 还支持其他多种大型语言模型 (LLM) 供应商，包括 Ollama、GitHub Copilot、Perplexity.ai、Anthropic 和谷歌 Gemini。用户可以选择适合其需求的供应商来进行配置。

providers = {
    openai = {
        endpoint = "https://api.openai.com/v1/chat/completions",
        secret = os.getenv("OPENAI_API_KEY"),
    },
    ...
}

使用方法

Gp.nvim 提供了一系列命令供用户在编辑器中进行交互。用户可以通过这些命令进行创建新聊天、在现有聊天中添加代码片段、生成图像等多种智能操作。

例如，:GpChatNew 可以在当前窗口打开一个新的聊天会话，:GpChatToggle 可以在弹出窗口中打开或关闭聊天。用户还可以使用命令如 :GpRewrite 和 :GpAppend 来修改文本或代码。

扩展功能

用户可以通过提供自定义 hook 函数来扩展 Gp.nvim 的功能。这些 hook 函数可以访问插件的所有功能，并作为命令自动注册，允许用户根据自己的需求创建新的命令和功能，例如撰写单元测试或解释选中的代码段。

Gp.nvim 为 Neovim 用户提供了一个功能齐全且易用的接口，结合 GPT 模型的能力，为编码和编辑体验增添了一抹智能化的亮色。