通过CodeCompanion.nvim的内置适配器、社区适配器，或自行构建适配器，即可使用大语言模型和智能体进行编码。

新功能将始终在此处公布：这里

:purple_heart: 赞助者

感谢以下各位：

如果您热爱CodeCompanion并将其应用于您的工作流程，请考虑赞助我

:sparkles: 特性

• :speech_balloon: Neovim 中的 Copilot Chat 与 Zed AI 相遇
• :zap: 将 Neovim 与 CLI 中的大语言模型和智能体集成
• :electric_plug: 支持来自 Anthropic、Copilot、GitHub Models、DeepSeek、Gemini、Mistral AI、Novita、Ollama、OpenAI、Azure OpenAI、HuggingFace 和 xAI 的大语言模型（或自定义）
• :robot: 支持Agent Client Protocol,从而可以使用如Augment Code、Docker 的Cagent、Claude Code、Codex、Copilot CLI、Gemini CLI、Goose、Cursor CLI、Kimi CLI、Kiro、Mistral Vibe 和OpenCode等智能体进行编码
• :heart_hands: 用户贡献和支持的适配器
• :battery: 支持模型上下文协议 (MCP)
• :rocket: 内联转换、代码生成和重构
• :art: 编辑器上下文、斜杠命令、智能体/工具和工作流以改进大语言模型的输出
• :brain: 支持如CLAUDE.md、.cursor/rules以及您自定义的规则文件
• :sparkles: 内置提示库，用于处理常见任务，如 LSP 错误建议和代码解释
• :building_construction: 您可以创建自己的自定义提示、编辑器上下文和斜杠命令
• :books: 可以同时打开多个聊天窗口
• :art: 支持视觉和图像作为输入
• :muscle: 异步执行以实现快速性能

:camera_flash: 实际操作

:rocket: 快速上手

关于 CodeCompanion 的所有信息（安装、配置和使用）都包含在 文档 中。

:toolbox: 故障排除

在提交 问题 之前，您可以尝试以下步骤来排查问题：

检查健康状态

运行 :checkhealth codecompanion，确保所有依赖项均已正确安装。同时请注意日志文件的路径。

开启日志记录

更新您的配置并启用调试日志：

-- lazy.nvim
{
  "olimorris/codecompanion.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
  },
  opts = {
    -- 注意：日志级别位于 `opts.opts` 中
    opts = {
      log_level = "DEBUG", -- 或 "TRACE"
    },
  },
},

-- 其他包管理器
require("codecompanion").setup({
  opts = {
    log_level = "DEBUG", -- 或 "TRACE"
  }
})

然后根据 checkhealth 命令中显示的日志文件位置，检查日志内容。

使用 minimal.lua 文件进行测试

Neovim 插件中出现的问题，很大一部分都与用户的自定义配置有关。因此，我通常会要求用户在提交问题时提供一个 minimal.lua 文件。这样可以排除配置问题，并帮助我复现问题。

为此，我在仓库中提供了一个 minimal.lua 文件，供您在遇到问题时测试。只需复制该文件，稍作修改，然后使用 nvim --clean -u minimal.lua 启动 Neovim 即可。

:gift: 贡献

我欢迎各种贡献，但最终是否采纳将由我决定。在开始 PR 之前，请先发起讨论，并仔细阅读 CONTRIBUTING.md 指南。

:clap: 致谢

• Steven Arcangeli，感谢他天才般地创造了聊天缓冲区，并在早期提供了宝贵的反馈。
• Wtf.nvim，感谢其提供的 LSP 助手功能。
• CopilotChat.nvim，感谢其在聊天缓冲区的渲染和易用性方面的贡献。
• Aerial.nvim，感谢其 Tree-sitter 解析技术，这启发了“符号斜杠命令”的实现。
• Saghen，感谢其从 blink.cmp 中获得的优秀文档灵感，以及对该项目持续不断的 PR 贡献。
• Catwell，感谢其提供的 队列 灵感，我正是利用这一结构来堆叠智能体和工具。
• bassamsdata，感谢其出色的 insert_edit_into_file 工具（贡献不胜枚举），以及对本项目的持续支持。
• ravitemer，感谢其提供的强大扩展 API。
• Davidyz，感谢其持续而卓越的贡献，使 CodeCompanion 能够不断前进。
• Conrad Irwin、Agus Zubiaga 以及来自 Zed Industries 的 Morgan Krey，感谢他们在实现 ACP 方面的支持。
• Sidekick.nvim，感谢其在差异对比和终端输入方面的启发。

CodeCompanion.nvim 快速上手指南

CodeCompanion.nvim 是一款强大的 Neovim 插件，旨在将大语言模型（LLM）和 AI Agent 无缝集成到你的编码工作流中。它支持多种主流模型提供商（如 OpenAI, Anthropic, Ollama 等）以及各类 AI 编程助手协议。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• Neovim: 版本 >= 0.9.0 (推荐最新稳定版)。
• 前置依赖:
  • nvim-lua/plenary.nvim: 提供异步处理和实用函数。
  • nvim-treesitter/nvim-treesitter: 用于代码解析和上下文理解（需确保已安装并更新了对应语言的 parser）。
• API Key: 根据你选择的模型提供商（如 OpenAI, Anthropic 等），准备好相应的 API Key。如果使用本地模型（如 Ollama），请确保服务已启动。

安装步骤

推荐使用 lazy.nvim 进行安装和管理。请将以下配置添加到你的插件配置文件中（例如 ~/.config/nvim/lua/plugins/codecompanion.lua 或 init.lua）：

{
  "olimorris/codecompanion.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-treesitter/nvim-treesitter",
  },
  config = function()
    require("codecompanion").setup({
      -- 在此处填写你的配置，例如设置适配器策略
      strategies = {
        chat = {
          adapter = "openai", -- 修改为你使用的适配器，如 "anthropic", "ollama" 等
        },
        inline = {
          adapter = "openai",
        },
      },
      -- 配置具体的 API Key (建议通过环境变量管理，此处仅为示例)
      adapters = {
        openai = function()
          return require("codecompanion.adapters").extend("openai", {
            env = {
              api_key = "YOUR_OPENAI_API_KEY", 
            },
          })
        end,
      },
    })
  end,
}

提示: 为了安全起见，强烈建议使用环境变量（如 export OPENAI_API_KEY="sk-..."）来管理密钥，而不是硬编码在配置文件中。

基本使用

安装并配置完成后，重启 Neovim 即可开始使用。以下是几种最核心的使用方式：

1. 打开聊天窗口

在任意缓冲区中，使用以下命令打开侧边栏聊天窗口，与 AI 进行对话：

:CodeCompanionChat

你可以选中一段代码后执行该命令，AI 会自动将选中的代码作为上下文。

2. 行内交互 (Inline Actions)

选中一段代码，使用可视模式快捷键调用行内操作（如解释代码、重构、修复错误等）：

:'<,'>CodeCompanionActions

或者直接在普通模式下对当前行进行操作（需在配置中绑定快捷键，默认无全局映射，建议手动触发或配置）：

:CodeCompanionAdd

(注：通常用户会将其映射到快捷键，例如 <Leader>ca)

3. 使用 Slash 命令

在聊天缓冲区中，输入 / 可以快速调用内置命令，例如：

• /explain: 解释选中的代码或文件。
• /tests: 为当前文件生成测试用例。
• /fix: 分析并修复代码中的错误。
• /symbols: 查看当前文件的符号结构。

4. 多会话管理

支持同时开启多个聊天会话。你可以随时切换不同的上下文进行提问，互不干扰。

---

更多高级功能（如 Agent 工作流、自定义 Prompt、MCP 支持等）请参阅官方文档。