Skip to main content

Getting started with GitHub Copilot in Neovim

Learn how to install GitHub Copilot in Neovim, and start seeing suggestions as you write comments and code.

GitHub のお客様は、GitHub.com の個人アカウントで GitHub Copilot を利用できます。 Managed user accountsでは、GitHub Copilot を使うことができません。

確認が取れている学生、教師、およびパブリックのオープン ソース プロジェクトのメンテナンス担当者は、GitHub Copilot を無料で使うことができます。 学生、教師、または一般的なオープンソース プロジェクトのメンテナンス担当者ではない場合にも、1 回限りの 60 日間の試用版で GitHub Copilot を無料で試すことができます。 無料試用期間の後、継続して使うには有料サブスクリプションが必要になります。 詳しくは、「GitHub Copilot の課金について」をご覧ください。

About GitHub Copilot and Neovim

GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳細については、「GitHub Copilot について」を参照してください。

If you use a Neovim, you can view and incorporate suggestions from GitHub Copilot directly within the editor.

Prerequisites

Installing the Neovim extension

  1. GitHub recommends that you install the GitHub Copilot plugin with Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install github/copilot.vim.

    • To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command in Terminal.

      git clone https://github.com/github/copilot.vim \
         ~/.config/nvim/pack/github/start/copilot.vim
      
  2. To configure GitHub Copilot, open Neovim and enter the following command.

    :Copilot setup
    
  3. Enable GitHub Copilot in your Neovim configuration, or with the Neovim command.

    :Copilot enable
    
  1. GitHub recommends that you install the GitHub Copilot plugin with Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install github/copilot.vim.

    • To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command in Git Bash.

        git clone https://github.com/github/copilot.vim.git `
         $HOME/AppData/Local/nvim/pack/github/start/copilot.vim
      
  2. To configure GitHub Copilot, open Neovim and enter the following command.

    :Copilot setup
    
  3. Enable GitHub Copilot in your Neovim configuration, or with the Neovim command.

    :Copilot enable
    
  1. GitHub recommends that you install the GitHub Copilot plugin with Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install github/copilot.vim.

    • To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command:

      git clone https://github.com/github/copilot.vim \
         ~/.config/nvim/pack/github/start/copilot.vim
      
  2. To configure GitHub Copilot, open Neovim and enter the following command.

    :Copilot setup
    
  3. Enable GitHub Copilot in your Neovim configuration, or with the Neovim command.

    :Copilot enable
    

Learning to use GitHub Copilot in Neovim

For guidance on using GitHub Copilot in Neovim, you can view the plugin documentation. To see the documentation, open Neovim and run the following command.

:help copilot

Further reading