赋能而非取代程序员。

| 文档 | 博客 | Discord |

---

LSP-AI 是一个开源的 语言服务器，作为您喜爱的代码编辑器中 AI 驱动功能的后端。它提供诸如在编辑器内与大型语言模型聊天以及代码补全等功能。由于它是语言服务器，因此可以与任何支持 LSP 的编辑器配合使用。

LSP-AI 的目标是通过与软件工程师已经熟悉并喜爱的工具集成来协助和赋能他们，而不是取代软件工程师。

它支持的编辑器列表如下：

• VS Code
• NeoVim
• Emacs
• Helix
• Sublime

此外，它还支持更多、更多的编辑器。

注意：该项目目前已被许多用户日常使用，并且已达到我期望的所有功能阶段。虽然开发并未完全停止，但目前不再为其开发新功能。

功能

编辑器内聊天

直接在您的代码库中与您喜爱的本地或托管模型进行聊天。

在 Helix 中与 Claude Sonnet 聊天

自定义操作

创建自定义操作来进行代码重构、代码补全等！

在 Helix 中使用 Claude Sonnet 通过思维链提示进行代码重构

代码补全

LSP-AI 可以作为 GitHub Copilot 的替代方案。

https://github.com/SilasMarvin/lsp-ai/assets/19626586/59430558-da23-4991-939d-57495061c21b

左侧：VS Code 使用 Mistral Codestral。右侧：Helix 使用 stabilityai/stable-code-3b

请注意，补全速度完全取决于所使用的后端。为了获得最快的补全效果，我们建议使用小型本地模型或 Groq。

文档

请参阅维基页面，了解以下内容的说明：

• 入门
• 安装
• 配置
• 编辑器内聊天
• 插件
• 服务器能力
• 等等

LSP-AI 的必要性

简而言之：LSP-AI 将复杂的实现细节从特定于编辑器的插件作者那里抽象出来，将开源开发工作集中到一个可共享的后端中。

集成 AI 功能的编辑器已经成为趋势。它们并不完美，但正在不断改进，而且早期研究已经显示出其益处。尽管多家公司已经推出了像 Cursor 这样的先进 AI 驱动编辑器，但开源社区仍然缺乏直接的竞争对手。

LSP-AI 致力于填补这一空白，通过提供一个能够将 AI 驱动功能集成到我们熟悉的编辑器中的语言服务器。以下是我们认为 LSP-AI 必要且有益的原因：

1. 统一的 AI 功能：

   • 通过将 AI 功能集中到一个后端，LSP-AI 使受支持的编辑器无需重复开发即可受益于这些进步。

2. 简化插件开发：

   • LSP-AI 抽象了设置 LLM 后端、构建复杂提示等复杂流程，未来还将涵盖更多内容。插件开发者可以专注于提升他们正在开发的特定编辑器的功能，而不必处理后端的复杂性。

3. 增强协作：

   • 提供共享后端创造了一个协作平台，开源开发者可以聚集在一起添加新功能。这种统一的努力促进了创新，减少了重复劳动。

4. 广泛的兼容性：

   • LSP-AI 支持任何遵循语言服务器协议 (LSP) 的编辑器，确保各种编辑器都能利用 LSP-AI 提供的 AI 功能。

5. 灵活的 LLM 后端支持：

   • 目前，LSP-AI 支持 llama.cpp、Ollama、OpenAI 兼容 API、Anthropic 兼容 API、Gemini 兼容 API 以及 Mistral AI FIM 兼容 API，为开发者提供了选择首选后端的灵活性。此列表还将继续扩展。

6. 面向未来：

   • LSP-AI 致力于紧跟 LLM 驱动软件开发领域的最新进展。

路线图

这个项目还有很多工作要做，每天都有令人惊叹的新研究和工具问世。以下是我们在接下来想要添加的一些想法，但我们欢迎任何贡献以及关于优先级排序的讨论。

• 实现基于语义搜索的上下文构建（这可能会非常酷且强大）。计划使用 Tree-sitter 来正确地对代码进行分块。
• 支持更多后端
• 探索基于代理的系统

LSP-AI 快速上手指南

LSP-AI 是一个开源的语言服务器（Language Server），旨在为你熟悉的代码编辑器提供 AI 驱动的功能（如代码补全、内联聊天、自定义重构动作等）。它支持任何遵循 LSP 协议的编辑器（如 VS Code, NeoVim, Emacs, Helix, Sublime 等）。

环境准备

在开始之前，请确保你的系统满足以下要求：

• 操作系统：Linux, macOS 或 Windows。
• 前置依赖：
  • Rust 工具链：用于从源码编译安装（推荐方式）。
    • 安装命令：curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    • 国内加速（可选）：若下载缓慢，可配置 RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static 和 RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static。
  • AI 模型后端：LSP-AI 本身不包含模型，你需要运行一个后端服务。推荐方案：
    • Ollama (最简便)：支持本地运行多种开源模型。
      • 安装：curl -fsSL https://ollama.com/install.sh | sh
      • 国内镜像：可使用 export OLLAMA_HOST=https://ollama.fly.dev (需自行寻找可用节点) 或直接访问官网下载。
    • 或者 llama.cpp、OpenAI API、Anthropic API 等。

安装步骤

1. 安装 LSP-AI 服务端

使用 Cargo 进行安装（确保已安装 Rust）：

cargo install lsp-ai

注意：编译过程可能需要几分钟。如果网络受阻，请确保配置了 Rust 的国内镜像源。

2. 配置编辑器

由于 LSP-AI 是一个语言服务器，你需要在你使用的编辑器中配置 LSP 客户端以连接它。以下是常见编辑器的简要配置思路：

• VS Code:
  1. 安装 "LSP-AI" 扩展（如果有官方发布）或使用通用的 "LSP Client" 扩展。
  2. 在设置中指定服务器命令为 lsp-ai。
• NeoVim (使用 nvim-lspconfig): 在你的 init.lua 中添加：

  require('lspconfig').lsp_ai.setup({
    cmd = { "lsp-ai" },
    -- 其他配置...
  })
  

• Helix: 在 ~/.config/helix/languages.toml 中添加：

  [language-server.lsp-ai]
  command = "lsp-ai"
  

  然后在对应语言的配置中引用该 server。

(具体编辑器详细配置请参考官方 Wiki)

3. 配置模型后端

创建或编辑 LSP-AI 的配置文件（通常位于 ~/.config/lsp-ai/config.toml 或由编辑器启动参数指定），定义你要使用的模型。

示例配置 (使用 Ollama 运行本地模型):

[[models]]
name = "local-codellama"
provider = "ollama"
model = "codellama:7b" # 确保已通过 'ollama pull codellama:7b' 下载
api_url = "http://localhost:11434"

[[models]]
name = "hosted-gpt4"
provider = "openai_compatible"
model = "gpt-4"
api_key = "YOUR_API_KEY"
api_url = "https://api.openai.com/v1"

基本使用

配置完成后，重启编辑器即可体验 AI 功能。

1. 代码补全 (Code Completions)

像使用 GitHub Copilot 一样，在编写代码时暂停片刻，LSP-AI 会根据上下文自动显示灰色建议代码。按 Tab 键（或编辑器设定的接受键）即可采纳。

• 提示：补全速度取决于你选择的后端。对于极速体验，推荐使用小型本地模型或 Groq 后端。

2. 编辑器内聊天 (In-Editor Chatting)

大多数编辑器允许通过快捷键触发 LSP 命令来打开聊天窗口。

• 操作：选中一段代码，触发 "Chat" 命令（具体快捷键视编辑器配置而定，如在 Helix 中可能是空格键菜单选择）。
• 示例：选中函数，输入“解释这段代码”或“优化这个函数”，AI 将直接在编辑器侧边栏或浮动窗口中回复。

3. 自定义动作 (Custom Actions)

你可以定义特定的 Prompt 模板来执行重构任务。

• 场景：选中代码块，执行名为 "Refactor with Chain of Thought" 的动作。
• 效果：AI 将按照预设的思维链提示词对代码进行重构并输出结果。

---

现在，你可以在不离开熟悉编辑器的情况下，享受强大的 AI 编程辅助了。