OGPT.nvim 使用教程

OGPT.nvim 使用教程

ogpt.nvimChat with Ollama/Huggingface/TextGen/OpenAI GPT Neovim Plugin: Effortless Natural Language Generation with LLM API 项目地址:https://gitcode.com/gh_mirrors/og/ogpt.nvim

项目介绍

OGPT.nvim 是一款支持多个提供商并提供互动问答功能的 Neovim 插件。用户可以灵活配置不同的模型和操作，与大型语言模型进行对话。主要功能包括语法校正、翻译、关键词生成、代码优化等。此外，用户还可以通过 JSON 文件来自定义操作，插件默认提供商为 Ollama，并集成了 edgy.nvim 以提高工作效率。

项目快速启动

安装

首先，确保你已经安装了 Neovim 和 Git。然后，通过以下命令克隆项目并安装插件：

git clone https://github.com/huynle/ogpt.nvim.git ~/.config/nvim/pack/plugins/start/ogpt.nvim

配置

在 Neovim 配置文件（通常是 init.vim 或 init.lua）中添加以下配置：

require('ogpt').setup({
  default_provider = "ollama",
  providers = {
    ollama = {
      url = "http://localhost:11434",
      model = "mistral:7b"
    }
  }
})

使用

启动 Neovim 后，你可以通过以下命令与 OGPT 进行交互：

:OGPTChat

应用案例和最佳实践

代码优化

假设你有一段代码需要优化，你可以使用 OGPT.nvim 进行交互式优化：

local function example_function(a, b)
  return a + b
end

通过 :OGPTChat 命令，输入以下提示：

请优化以下 Lua 函数，使其性能更好：

local function example_function(a, b)
  return a + b
end

OGPT 将提供优化建议，如使用更高效的算法或减少不必要的计算。

文档生成

你可以使用 OGPT.nvim 生成代码文档：

local function example_function(a, b)
  return a + b
end

通过 :OGPTChat 命令，输入以下提示：

请为以下 Lua 函数生成文档字符串：

local function example_function(a, b)
  return a + b
end

OGPT 将生成详细的文档字符串，帮助你更好地理解和使用该函数。

典型生态项目

edgy.nvim

edgy.nvim 是一个与 OGPT.nvim 集成的插件，用于提高工作效率。你可以在配置中启用 edgy.nvim：

require('ogpt').setup({
  edgy = true,
  right = {
    { title = "OGPT 弹出窗口", ft = "ogpt-popup", size = { width = 0.2 }, wo = { wrap = true } },
    { title = "OGPT 参数", ft = "ogpt-parameters-window", size = { height = 6 }, wo = { wrap = true } },
    { title = "OGPT 模板", ft = "ogpt-template", size = { height = 6 } },
    { title = "OGPT 会话", ft = "ogpt-sessions", size = { height = 6 }, wo = { wrap = true } },
    { title = "OGPT 系统输入", ft = "ogpt-system-window", size = { height = 6 } },
    { title = "OGPT", ft = "ogpt-window", size = { height = 0.5 }, wo = { wrap = true } },
    { title = "OGPT {{{selection}}}", ft = "ogpt-selection", size = { width = 80, height = 4 }, wo = { wrap = true } },
    { title = "OGPt {{{instruction}}}", ft = "ogpt-instruction", size = { height = 6 } }
  }
})

通过集成 edgy.nvim，你可以更高效地管理 OGPT 会话和参数，提升开发体验。

---

通过以上教程，你可以快速上手并充分利用 OGPT.nvim 的功能，提升你的开发效率和代码质量。

ogpt.nvimChat with Ollama/Huggingface/TextGen/OpenAI GPT Neovim Plugin: Effortless Natural Language Generation with LLM API 项目地址:https://gitcode.com/gh_mirrors/og/ogpt.nvim