copilot.vim README

The project's README from github.com/github/copilot.vim. As one markdown file: README.md.

GitHub Copilot for Vim and Neovim

GitHub Copilot is an AI pair programmer tool that helps you write code faster and smarter. Trained on billions of lines of public code, GitHub Copilot turns natural language prompts including comments and method names into coding suggestions across dozens of languages.

Copilot.vim is a Vim/Neovim plugin for GitHub Copilot.

To learn more, visit https://github.com/features/copilot.

Getting access to GitHub Copilot

To access GitHub Copilot, an active GitHub Copilot subscription is required. Sign up for GitHub Copilot Free, or request access from your enterprise admin.

Getting started

  1. Install Neovim or the latest patch of Vim (9.0.0185 or newer).

  2. Install Node.js. If you use a package manager, make sure to install NPM as well (e.g., apt install nodejs npm on Debian/Ubuntu).

  3. Install github/copilot.vim using vim-plug, lazy.nvim, or any other plugin manager. Or to install manually, run one of the following commands:

    • 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 command):

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

    • Neovim, Windows (PowerShell command):

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

  4. Start Vim/Neovim and invoke :Copilot setup.

Suggestions are displayed inline and can be accepted by pressing the tab key. See :help copilot for more information.

Troubleshooting

We’d love to get your help in making GitHub Copilot better! If you have feedback or encounter any problems, please reach out on our feedback forum.

copilot.vim (github/copilot.vim)

Searching Database…

11.7K ·GitHub
Copilot.vim
What is this?Copilot.vim is the official Vim/Neovim plugin for GitHub Copilot, an AI pair programmer that suggests code completions from comments and function names.
Is this a standalone app or a plugin for my editor?It's an editor plugin that integrates GitHub Copilot's AI suggestions directly into Vim or Neovim, showing inline suggestions as you type.
Do I need a GitHub Copilot subscription?Yes, an active GitHub Copilot subscription is required (free tier available) or enterprise admin access, plus Node.js installed locally.
Any install pitfalls I should watch for?You need a fairly recent Vim (9.0.0185 or newer) or Neovim, and Node.js/npm must be installed separately before the plugin will work.
Does this work on Linux, macOS, and Windows?Yes, the README gives explicit install commands for Linux/macOS and Windows (PowerShell).
How do I trigger and accept suggestions?Copilot shows suggestions inline as you type, and you accept them by pressing the Tab key.
Is Copilot.vim free to use?The plugin itself is free, but using it requires an active GitHub Copilot subscription, which has a free tier or is provided via enterprise access.
What are similar projects?fzf.vim, nerdtree, vimrc, vim-fugitive, ale, SpaceVim, vim-airline, neovide
Which topics is it in?code-completion, ai-coding-assistant, vim-plugin, vim script, coding-assistant, neovim, copilot, github-copilot, editor, chatbot, git, productivity
Creator
github
Size
69.6 MB
Stars
11.7K
Updated
CommitJan 09
Age
4y
Commits · 90 Days