GitHub Copilot for Vim 和 Neovim

GitHub Copilot 是一款 AI 配对编程工具，可帮助您更快、更智能地编写代码。它基于数十亿行公开代码进行训练，能够将自然语言提示（包括注释和方法名）转化为跨数十种编程语言的代码建议。

Copilot.vim 是适用于 Vim/Neovim 的 GitHub Copilot 插件。

如需了解更多信息，请访问： https://github.com/features/copilot。

获取 GitHub Copilot 使用权限

要使用 GitHub Copilot，您需要拥有有效的 GitHub Copilot 订阅。您可以注册 GitHub Copilot Free，或向您的企业管理员申请访问权限。

开始使用

1. 安装 Neovim 或最新补丁版本的 Vim（9.0.0185 或更高版本）。

2. 安装 Node.js。如果您使用包管理器，请确保同时安装 NPM（例如，在 Debian/Ubuntu 上运行 apt install nodejs npm）。

3. 使用 vim-plug、lazy.nvim 或其他插件管理器安装 github/copilot.vim。或者，您也可以手动安装，运行以下命令之一：

   • Vim（Linux/macOS）：

     git clone --depth=1 https://github.com/github/copilot.vim.git \
       ~/.vim/pack/github/start/copilot.vim
     

   • Neovim（Linux/macOS）：

     git clone --depth=1 https://github.com/github/copilot.vim.git \
       ~/.config/nvim/pack/github/start/copilot.vim
     

   • Vim（Windows，PowerShell 命令）：

     git clone --depth=1 https://github.com/github/copilot.vim.git `
       $HOME/vimfiles/pack/github/start/copilot.vim
     

   • Neovim（Windows，PowerShell 命令）：

     git clone --depth=1 https://github.com/github/copilot.vim.git `
       $HOME/AppData/Local/nvim/pack/github/start/copilot.vim
     

4. 启动 Vim/Neovim，并执行 :Copilot setup。

代码建议会内联显示，您可以通过按下 Tab 键来接受建议。更多详细信息请参阅 :help copilot。

故障排除

我们非常欢迎您的帮助，共同改进 GitHub Copilot！如果您有任何反馈或遇到问题，请在我们的 反馈论坛 中与我们联系。

GitHub Copilot for Vim/Neovim 快速上手指南

GitHub Copilot 是一款 AI 结对编程工具，能根据自然语言提示（如注释、方法名）提供代码建议。copilot.vim 是其在 Vim 和 Neovim 编辑器中的官方插件。

环境准备

在开始之前，请确保满足以下系统要求和依赖：

• 编辑器版本：
  • Neovim：最新稳定版。
  • Vim：9.0.0185 或更高版本。
• 运行时依赖：
  • 必须安装 Node.js 及 NPM。
  • Linux (Debian/Ubuntu) 安装示例：

    sudo apt install nodejs npm
    

  • macOS 安装示例：

    brew install node
    

• 账号权限：
  • 需要有效的 GitHub Copilot 订阅（个人付费、免费试用版或通过企业管理员获取）。

安装步骤

你可以使用插件管理器（如 vim-plug, lazy.nvim）安装，也可以通过 Git 手动安装。

方式一：手动安装（推荐）

根据你的操作系统和编辑器类型，在终端执行以下对应命令：

Vim (Linux/macOS)

git clone --depth=1 https://github.com/github/copilot.vim.git \
  ~/.vim/pack/github/start/copilot.vim

Neovim (Linux/macOS)

git clone --depth=1 https://github.com/github/copilot.vim.git \
  ~/.config/nvim/pack/github/start/copilot.vim

Vim (Windows PowerShell)

git clone --depth=1 https://github.com/github/copilot.vim.git `
  $HOME/vimfiles/pack/github/start/copilot.vim

Neovim (Windows PowerShell)

git clone --depth=1 https://github.com/github/copilot.vim.git `
  $HOME/AppData/Local/nvim/pack/github/start/copilot.vim

提示：国内用户若遇到克隆速度慢的问题，可使用镜像源加速： git clone --depth=1 https://ghp.ci/https://github.com/github/copilot.vim.git <目标路径>

方式二：初始化配置

安装完成后，启动 Vim 或 Neovim，运行以下命令进行授权设置：

:Copilot setup

按照屏幕提示在浏览器中完成 GitHub 登录验证即可。

基本使用

配置完成后，Copilot 将自动在编辑过程中提供行内代码建议。

1. 编写代码：在文件中输入注释或代码片段（例如函数名或部分逻辑）。
2. 查看建议：AI 生成的代码会以灰色文本形式显示在当前光标后。
3. 接受建议：按下 Tab 键即可采纳该建议并插入代码。
4. 拒绝/切换：若不满意，可继续输入或按特定快捷键（详见 :help copilot）切换其他建议。

更多详细配置与快捷键说明，请在编辑器中运行：

:help copilot