Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 72 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,95 @@
# 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.
> **GitHub Copilot** is your AI-powered coding companion, helping you write code faster and smarter with context-aware suggestions directly in Vim and Neovim.

Copilot.vim is a Vim/Neovim plugin for GitHub Copilot.
Copilot.vim brings the capabilities of GitHub Copilot to Vim/Neovim, turning natural language prompts and comments into code suggestions across dozens of programming languages.

To learn more, visit
[https://github.com/features/copilot](https://github.com/features/copilot).
- **Official Site:** [GitHub Copilot Features](https://github.com/features/copilot)
- **Plugin Repository:** [github/copilot.vim](https://github.com/github/copilot.vim)

## Getting access to GitHub Copilot
---

To access GitHub Copilot, an active GitHub Copilot subscription is required.
Sign up for [GitHub Copilot Free](https://github.com/settings/copilot), or
request access from your enterprise admin.
## 🚀 Features

## Getting started
- Inline AI-powered code suggestions as you type.
- Support for Vim (`9.0.0185+`) and Neovim.
- Easy setup and seamless integration.
- Works with popular plugin managers (vim-plug, lazy.nvim, etc.).
- Accept suggestions with the tab key.

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

2. Install [Node.js][].
## 📝 Requirements

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:** Version `9.0.0185` or newer
- **Neovim:** Latest release
- **Node.js:** [Download here](https://nodejs.org/en/download/)
- **GitHub Copilot Subscription:** [Sign up here](https://github.com/settings/copilot) or request access from your enterprise admin.

* Vim, Linux/macOS:
---

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

* Neovim, Linux/macOS:
You can use your favorite plugin manager, or install manually:

git clone --depth=1 https://github.com/github/copilot.vim.git \
~/.config/nvim/pack/github/start/copilot.vim
### Using vim-plug (example)

* Vim, Windows (PowerShell command):
```vim
Plug 'github/copilot.vim'
```

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

* Neovim, Windows (PowerShell command):
**For Vim (Linux/macOS):**
```sh
git clone --depth=1 https://github.com/github/copilot.vim.git \
~/.vim/pack/github/start/copilot.vim
```

git clone --depth=1 https://github.com/github/copilot.vim.git `
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
**For Neovim (Linux/macOS):**
```sh
git clone --depth=1 https://github.com/github/copilot.vim.git \
~/.config/nvim/pack/github/start/copilot.vim
```

4. Start Vim/Neovim and invoke `:Copilot setup`.
**For Vim (Windows, PowerShell):**
```powershell
git clone --depth=1 https://github.com/github/copilot.vim.git `
$HOME/vimfiles/pack/github/start/copilot.vim
```

[Node.js]: https://nodejs.org/en/download/
[Neovim]: https://github.com/neovim/neovim/releases/latest
[Vim]: https://github.com/vim/vim
**For Neovim (Windows, PowerShell):**
```powershell
git clone --depth=1 https://github.com/github/copilot.vim.git `
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
```

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

## Troubleshooting
## ⚡ Getting Started

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](https://github.com/github/copilot.vim/issues).
1. Install Vim/Neovim and Node.js (see above).
2. Install Copilot.vim using your preferred method.
3. Start Vim or Neovim.
4. Run `:Copilot setup` to configure the plugin.
5. Start coding! Suggestions will appear inline, and you can accept them by pressing the **Tab** key.

See `:help copilot` in Vim/Neovim for detailed usage.

---

## 💡 Troubleshooting & Feedback

If you have questions, feedback, or encounter issues, please visit our [Feedback Forum](https://github.com/github/copilot.vim/issues).

Help us make GitHub Copilot even better!

---

## 📚 Useful Links

- [Node.js Download](https://nodejs.org/en/download/)
- [Neovim Releases](https://github.com/neovim/neovim/releases/latest)
- [Vim Releases](https://github.com/vim/vim)

---