docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim.md

title, shortTitle, product, intro, versions, topics

title	shortTitle	product	intro	versions	topics
Getting started with GitHub Copilot in Neovim	Neovim	{% data reusables.gated-features.copilot %}	Learn how to install {% data variables.product.prodname_copilot %} in Neovim, and start seeing suggestions as you write comments and code.	feature copilot	Copilot

About {% data variables.product.prodname_copilot %} and Neovim

{% data reusables.copilot.procedural-intro %}

If you use a Neovim, you can view and incorporate suggestions from {% data variables.product.prodname_copilot %} directly within the editor.

Prerequisites

To use {% data variables.product.prodname_copilot %} in Neovim you must have Neovim and Node.js version 17 or below installed. For more information, see the Neovim documentation and the Node.js website.

Installing the Neovim extension

{% mac %}

{% data reusables.copilot.install-copilot-in-neovim %}

• To install the {% data variables.product.prodname_copilot %} plugin directly, you must know where Neovim stores plugins. To install the plugin, enter the following command in Terminal.

  git clone https://github.com/github/copilot.vim \
     PATH/TO/NEOVIM/PLUGINS/copilot.vim
  

1. To configure {% data variables.product.prodname_copilot %}, open Neovim and enter the following command.

   :Copilot setup
   

{% endmac %}

{% windows %}

{% data reusables.copilot.install-copilot-in-neovim %} - To install the {% data variables.product.prodname_copilot %} plugin directly, you must know where Neovim stores plugins. To install the plugin, enter the following command in Git Bash.

  ```
  git clone https://github.com/github/copilot.vim \
  ~/.config/PATH/TO/YOUR/NEOVIM/CONFIG/FILE/copilot.vim
  ```

1. To configure {% data variables.product.prodname_copilot %}, open Neovim and enter the following command.

   :Copilot setup
   

{% endwindows %}

{% linux %}

{% data reusables.copilot.install-copilot-in-neovim %}

1. Use the following commands to clone the {% data variables.product.prodname_copilot %} release for loading with the Neovim builtin plugin manager. (Or, use another plugin manager of your choice.)

   mkdir -p ~/.config/nvim/pack/github/start
   git clone https://github.com/github/copilot.vim \
            ~/.config/nvim/pack/github/start/copilot.vim
   

2. Visit https://github.com/settings/copilot and complete the required steps.

3. To configure {% data variables.product.prodname_copilot %}, open Neovim and enter the following command.

   :Copilot setup
   

4. Enable {% data variables.product.prodname_copilot %} in your Neovim configuration, or with the Neovim command.

   :Copilot enable
   

{% endlinux %}

Learning to use {% data variables.product.prodname_copilot %} in Neovim

For guidance on using {% data variables.product.prodname_copilot %} in Neovim, you can view the plugin documentation. To see the documentation, open Neovim and run the following command.

:help copilot

Further reading

• {% data variables.product.prodname_copilot %}