|
1 | | -# GitHub Copilot for Vim and Neovim |
2 | 1 |
|
3 | | -GitHub Copilot is an AI pair programmer tool that helps you write code faster |
4 | | -and smarter. Trained on billions of lines of public code, GitHub Copilot turns |
5 | | -natural language prompts including comments and method names into coding |
6 | | -suggestions across dozens of languages. |
7 | | - |
8 | | -Copilot.vim is a Vim/Neovim plugin for GitHub Copilot. |
9 | | - |
10 | | -To learn more, visit |
11 | | -[https://github.com/features/copilot](https://github.com/features/copilot). |
12 | | - |
13 | | -## Getting access to GitHub Copilot |
14 | | - |
15 | | -To access GitHub Copilot, an active GitHub Copilot subscription is required. |
16 | | -Sign up for [GitHub Copilot Free](https://github.com/settings/copilot), or |
17 | | -request access from your enterprise admin. |
18 | | - |
19 | | -## Getting started |
20 | | - |
21 | | -1. Install [Neovim][] or the latest patch of [Vim][] (9.0.0185 or newer). |
22 | | - |
23 | | -2. Install [Node.js][]. |
24 | | - |
25 | | -3. Install `github/copilot.vim` using vim-plug, lazy.nvim, or any other |
26 | | - plugin manager. Or to install manually, run one of the following |
27 | | - commands: |
28 | | - |
29 | | - * Vim, Linux/macOS: |
30 | | - |
31 | | - git clone --depth=1 https://github.com/github/copilot.vim.git \ |
32 | | - ~/.vim/pack/github/start/copilot.vim |
33 | | - |
34 | | - * Neovim, Linux/macOS: |
35 | | - |
36 | | - git clone --depth=1 https://github.com/github/copilot.vim.git \ |
37 | | - ~/.config/nvim/pack/github/start/copilot.vim |
38 | | - |
39 | | - * Vim, Windows (PowerShell command): |
40 | | - |
41 | | - git clone --depth=1 https://github.com/github/copilot.vim.git ` |
42 | | - $HOME/vimfiles/pack/github/start/copilot.vim |
43 | | - |
44 | | - * Neovim, Windows (PowerShell command): |
45 | | - |
46 | | - git clone --depth=1 https://github.com/github/copilot.vim.git ` |
47 | | - $HOME/AppData/Local/nvim/pack/github/start/copilot.vim |
48 | | - |
49 | | -4. Start Vim/Neovim and invoke `:Copilot setup`. |
50 | | - |
51 | | -[Node.js]: https://nodejs.org/en/download/ |
52 | | -[Neovim]: https://github.com/neovim/neovim/releases/latest |
53 | | -[Vim]: https://github.com/vim/vim |
54 | | - |
55 | | -Suggestions are displayed inline and can be accepted by pressing the tab key. |
56 | | -See `:help copilot` for more information. |
57 | | - |
58 | | -## Troubleshooting |
59 | | - |
60 | | -We’d love to get your help in making GitHub Copilot better! If you have |
61 | | -feedback or encounter any problems, please reach out on our [feedback |
62 | | -forum](https://github.com/github/copilot.vim/issues). |
0 commit comments